第三方用户希望通过小鱼API的方式直接设置联席主持人,省略手动输入密码的过程。(暂不支持主持人身份的设置)
联席主持人:非主持人,联席主持人权限小于主持人权限,且出会后重新入会将失去联席主持人身份。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/meetingHostSet?enterpriseId=XXX&callNumber=xxx&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参考 签名鉴权 | |
callNumber | String | Query | 是 | 无 | 当前会议的云会议号 | 5.2(2023-0922版本) 6.0不支持该参数 |
device | JSON | 5.2(2023-0922版本) 6.0不支持该参数 | ||||
└id | long | Body | 是 | 无 | 设备Id(可在查看全体成员会议状态中获取) | 5.2(2023-0922版本) 6.0不支持该参数 |
└type | int | Body | 是 | 无 | 设备类型(可在查看全体成员会议状态中获取) | 5.2(2023-0922版本) 6.0不支持该参数 |
└participantNumber | String | Body | 是 | 无 | 对于硬件设备为终端号(可在查看全体成员会议状态中获取) | 5.2(2023-0922版本) 6.0不支持该参数 |
action | String | Body | 是 | 无 | 动作(设置set, 取消cancel) | 5.2(2023-0922版本) 6.0不支持该参数 |
请求消息体示例(Json)
{
"device": {
"id": 122352960,
"type": 5,
"participantNumber": "131136"
},
"action": "cancel"
}
返回结果示例:
成功时返回200,失败时返回小鱼RESTAPI错误码
该接口常见错误返回说明:
错误码 | 接口提示 | 说明 |
1005 | meetingRoomNumber is not in this enterprise | 企业接口越权,只能设置本企业下的会议室号 |
666171 | error.not.cochair | 非联席主持人身份, 取消失败 |
666170 | error.already.cochair | 已经是联席主持人身份 |
666176 | error.already.host | 已经是主持人身份 |
66620 | error.no meeting | 会议未召开, 设置无效 |