会议控制操作,对会议和等候室中的参会人员批量进行移入移出操作;
默认接口请求频率限制:20次/秒
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/meeting/waitingRoom/operate/batch?enterpriseId=XXX&meetingRoomNumber=XXX&signature=XXX
请求参数说明:
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参考 | |
meetingRoomNumber | String | Query | 是 | 无 | 云会议室号 | 公有云 5.2 (2024-0329版本) |
meetingId | String | Query | 是 | 无 | 会议id | 公有云 5.2 (2024-0329版本) |
action | String | Body | 是 | 无 | 操作行为 move_batch:把已入会设备 批量移入到等候室 approve_batch:批量准入,退会再入会仍进入等候室 reject_batch:批量拒绝准入 approve_batch_for_meeting: 本场会议允许设备直接入会,再入会无需进入等候室 | 公有云 5.2 (2024-0329版本) |
id | Long | Body | 是 | 无 | 被踢参会方设备id, 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 公有云 5.2 (2024-0329版本) |
type | Integer | Body | 是 | 无 | 被踢参会方设备类型, 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 公有云 5.2 (2024-0329版本) |
participantNumber | String | Body | 是 | 无 | 被踢参会方设备号, 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 公有云 5.2 (2024-0329版本) |
请求消息体示例(Json)
{
"action": "move_batch",
"deviceList": [
{
"id": 233633901,
"type": 5,
"participantNumber": "18899991111"
}
]
}
请求成功返回httpcode 200
请求失败结果示例
{
"developerMessage": "ErrorStatus: DEVICE_NOT_FOUND no.device.found",
"userMessage": "no.device.found",
"errorCode": 4111,
"moreInfo": "http://www.com.ainemo.com/errors/4111"
}
错误码见小鱼RESTAPI错误码