邀请用户或设备（API名称：inviteParticipants）
功能介绍
用于用户系统邀请用户或设备进入多方协同会议。
相关API
接口名称 |
调用说明 |
|---|---|
调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
|---|---|---|---|
POST |
https://isdp+域名/openapi/v1/openApiCreateConference/inviteParticipants |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
|---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
conferenceId |
Long |
是 |
会议id |
chairId |
Long |
否 |
主持人id(如果不设置，默认是当前登录用户) |
isdpDeviceIds |
List<String> |
否 |
设备id集合 |
userIds |
List<Long> |
否 |
用户id集合 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
stateCode |
String |
接口响应编码，0成功，非0失败 |
errorMessage |
String |
接口错误提示信息 |
result |
Object |
接口响应数据。 |
conferenceId |
Long |
会议id |
helmetMultiPartyParticipantId |
Long |
与会者id |
participantAccount |
String |
与会者账号 |
participantName |
String |
与会者名称 |
chairFlag |
int |
是否主持人（0：观众，1：主持人） |
refreshFlag |
int |
刷新标识 0,未刷新；1，刷新 |
joinFlag |
Int |
入会状态（1-拒绝，2-接收并入会,4-挂断或移除,7-结束离开,8-邀请中,9-未接听） |
userId |
Long |
用户id |
muteFlag |
int |
是否静音 0:否 1:是 |
voiceVideoFlag |
int |
语音视频标识 0,语音；1，视频 |
请求示例
{
"conferenceId":"3600","isdpDeviceIds":[],"userIds":[131295], "chairId":215717
}
响应示例
{
"stateCode": "0",
"errorMessage": null,
"result": [
{
"conferenceId": 3600,
"deviceOrgId": 0,
"participantAccount": "100095@isdp",
"participantName": "fc001",
"participantType": "USER",
"chairFlag": 0,
"muteFlag": 0,
"joinFlag": 8,
"voiceVideoFlag": 1,
"refreshFlag": 0,
"userId": 131295,
"createName": "fctest",
"lastUpdateName": "fctest",
"lastUpdateTimestamp": 1664956232834,
"creationTimestamp": 1664956232834,
"deleteFlag": 0,
"entityName": "helmetMultiPartyParticipant",
"helmetMultiPartyParticipantId": 8617,
"createdBy": 215717,
"creationDate": "2022-10-05T07:50:32.853+00:00",
"lastUpdatedBy": 215717,
"lastUpdateDate": "2022-10-05T07:50:32.853+00:00",
"tenantId": 1299,
"appName": "isdp-qc-server",
"affectedRows": 1
}
]
}
