邀请入会

功能说明

邀请终端或用户入会。

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

实现方法

REST URL

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

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	v1
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则
callNumber	String	Body	是	无	要加入的云会议号	3.9
deviceList	List	Body	是	无	被邀请的设备列表	3.9
└ number	String	Body	是	无	被邀请的设备号,支持小鱼终端号、手机号、邮箱、用户callNumber、h323	3.9

示例代码

请求消息体示例（Json）

{
    "callNumber": "9100637037",
    "deviceList": [
        {
            "number": "13810001000"
        },
        {
            "number": "168269"
        },
        {
            "number": "172.17.90.43##600005"
        }
    ]
}

返回结果示例：

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

事件回调

触发条件

邀请设备入会，触发ConferenceRosterInfo、NewUserCall事件回调。

2024-03-22 11:59:44

导出PDF文档