会控中配置某个与会设备的多屏之前需要提前获取该设备的多屏能力信息。
默认接口请求频率限制【相同云会议室】:20次/1秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{meetingRoomNumber}/device/multiScreenAbility?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9无此接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 5.2 (2024-0329版本) |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 5.2 (2024-0329版本) |
meetingRoomNumber | String | Body | 是 | 无 | 云会议室号 | 5.2 (2024-0329版本) |
partiDeviceId | long | Body | 是 | 无 | 参会设备id 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 5.2 (2024-0329版本) |
partitype | int | Body | 是 | 无 | 参会设备类型 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 5.2 (2024-0329版本) |
particpantNumber | String | Body | 是 | 无 | 参会设备号 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 5.2 (2024-0329版本) |
请求消息体示例(Json)
{
"partiDeviceId": 100766497,
"partitype": 8,
"participantNumber": "20809540"
}
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
示例1:
{
"enableMultiScreen": true,
"partiName": "huizhenAE800-20809540-DEVx0",
"multiScreenList": [
{
"connected": true,
"id": "master",
"name": "master"
},
{
"connected": true,
"id": "slave_1",
"name": "slave_1"
},
{
"connected": true,
"id": "slave_2",
"name": "slave_2"
}
]
}
示例2:
{
"enableMultiScreen": false,
"partiName": "智能视频终端",
"multiScreenList": []
}
返回参数说明:
Key | 说明 |
enableMultiScreen | 是否具有多屏能力 |
multiScreenList | 多屏列表 |
connected | 是都连接成功 |
id | 屏幕id |
name | 屏幕名称 |
请求失败结果示例
{
"developerMessage": "",
"userMessage": "device.not.in.meeting",
"errorCode": 101,
"moreInfo": "http://www.com.ainemo.com/errors/101"
}
以下仅列出该接口业务逻辑错误码,其他错误码见小鱼RESTAPI错误码
错误码 | 描述 |
101 | 设备不在会中 |