会议室轮询控制

功能说明

支持会议室级别的画面轮询

默认接口请求频率限制：20次/秒

实现方法

REST URL

POST  https://sdk.xylink.com/api/rest/external/v1/conferenceControl/meeting/multiimage/polling?meetingRoomNumber=XXX&enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	5.2 -20241018 公有云不支持
conferenceNumber	String	Query	是	无	会议室号	5.2 -20241018 公有云不支持
action	String	Body	是	无	轮询状态（运行Start，暂停Pause，停止Stop，必须为三种状态其一）	5.2 -20241018 公有云不支持
pollingPattern	String	Body	是	无	轮询模式（自动AUTO，手动MANUAL 必须为二种模式其一）	5.2 -20241018 公有云不支持
pollingInterval	Long	Body	是	无	轮询间隔（单位：秒，必须大于等于5，最大1天）	5.2 -20241018 公有云不支持
layoutModel	String	Body	是	无	轮询布局模型（详见如下）,分区云最大支持16画面	5.2 -20241018 公有云不支持
autoPollingList	List	Body	否	无	自动轮询列表（可在查看全体成员会议状态中获取，list具体参数详见下）	5.2 -20241018 公有云不支持
└name	String	Body	否	无	device显示名称	5.2 -20241018 公有云不支持
└device	Object	Body	否	无	格式请参考样例，可在查看全体成员会议状态API获取	5.2 -20241018 公有云不支持
manualPollingList	List	Body	否	无	手动轮询列表, 具体参数如下	5.2 -20241018 公有云不支持
└imagePattern	String	Body	否	无	手动轮询列表模式参数(自动轮询auto, 明确指定specified, 语音激励speaker)	5.2 -20241018 公有云不支持
└pollingList	List	Body	否	无	手动轮询列表中指定位置的设备轮询列表（可在查看全体成员会议状态API获取）	5.2 -20241018 公有云不支持
└name	String	Body	否	无	device显示名称	5.2 -20241018 公有云不支持
└device	Object	Body	否	无	格式请参考样例，可在查看全体成员会议状态API获取	5.2 -20241018 公有云不支持
skipUnjoined	boolean	Body	否	false	是否跳过不在会成员，pollingPattern为AUTO时此配置必须为true	5.2 -20241018 公有云不支持
skipMuteVideo	boolean	Body	否	false	是否跳过未开启摄像头成员	5.2 -20241018 公有云不支持

示例代码

请求示例：

{
    "action": "Start",
    "pollingPattern": "MANUAL",
    "pollingInterval": 5,
    "layoutModel": "2-1",
    "skipUnjoined":true,
    "skipMuteVideo": false,
    "autoPollingList": [
        {       
            "name": "xxxx",
            "device": {
                "id": 5232778,
                "type": 2,
                "participantId": "65664",
                "participantNumber": "xxx"

            }
        }
    ],
    "manualPollingList": [
        {
            "imagePattern": "specified",
            "pollingList":[
                {
                    "name": "xxx",
                    "device": {
                        "id": 5232778,
                        "type": 2,
                        "participantId": "xxx",
                        "participantNumber": "xxx"
                    }
                }, {
                    "name": "xxx",
                    "device": {
                        "id": 5232760,
                        "type": 8,
                        "participantId": "xxx",
                        "participantNumber": "xxx"
                    }
                }
            ]
        },
        {
            "imagePattern": "specified",
            "pollingList":[
               {
                    "name": "xxx",
                    "device": {
                        "id": 6450901,
                        "type": 5,
                        "participantId": "xxx",
                        "participantNumber": "xxx"
                    }
                }
            ]
        }
    ]
}

成功时返回http 200，失败时返回小鱼RESTAPI错误码

2025-04-30 16:28:26

导出PDF文档