移入或移出等候室

功能说明

会议中将某个终端移入或移出等候室，不接收也不发送音视频信息。

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

实现方法

REST URL

PUT https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{callNumber}/hold?enterpriseId=XXX&action=XXX&signature=XXX

请求参数说明

参数	参数类型	必须	默认值	说明	初始平台
enterpriseId	String	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	是	签名鉴权1.0（旧）：是签名鉴权2.0：否	API签名，参见签名规则
callNumber	String	是	无	当前会议的云会议号	3.9
id	long	是	无	参会方id，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	3.9
type	int	是	无	参会方设备类型，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	3.9
participantNumber	String	是	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	3.9
action	String	是	off	on或者off, 移入或者移出等候室	3.9

示例代码

请求消息体示例（Json）

[
    {
        "id": 123321,
        "type": 1,
        "participantNumber": "13177883838"
    },
    {
        "id": 0,
        "type": 6,
        "participantNumber": "123.111.10.11##667788"
    }
]

返回结果示例：

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

2024-11-13 14:29:40

导出PDF文档