对话模式功能说明可参看小鱼易连产品说明文档。
通过服务端API可开启/关闭对话模式,终端SDK收到回调消息后可进行后续静音及布局操作。
默认接口请求频率限制:20次/秒。
REST URL
PUT https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/meeting/dialogue?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9无此接口 5.2无此接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否
| 无 | API签名,参考 签名鉴权 | |
meetingRoomNumber | String | Body | 是 | 无 | 当前会议的云会议室号 | 6.0 |
action | String | Body | 是 | 无 | 开启或关闭对话模式 set 开启 cancel 关闭 | 6.0 |
dialogueDevice | Object | Body | 是 | 无 | 开启对话模式的终端 | 6.0 |
└ id | long | Body | 是 | 无 | 设备id, 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 6.0 |
└ type | int | Body | 是 | 无 | 设备类型,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 6.0 |
└ participantNumber | String | Body | 是 | 无 | 参会者设备号,设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询: participantNumber表示参会者设备号 | 6.0 |
请求消息体示例(Json)
{
"meetingRoomNumber": "9000177199",
"action": "set",
"dialogueDevice": {
"id": 1234,
"type": 5,
"participantNumber": "2131412"
}
}
返回结果示例:
成功时返回200,失败时返回小鱼RESTAPI错误码