邀请终端或用户入会。
默认接口请求频率限制:20次/秒。
REST URL
PUT https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/invitation?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9 5.2-20221121 公有云 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 3.9 5.2-20221121 公有云 |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 3.9 5.2-20221121 公有云 |
callNumber | String | Body | 是 | 无 | 要加入的云会议号 | 3.9 5.2-20221121 公有云 |
deviceList | List | Body | 是 | 无 | 被邀请的设备列表 | 3.9 5.2-20221121 公有云 |
└ number | String | Body | 是 | 无 | 被邀请的设备号,支持小鱼终端号、手机号、邮箱、用户callNumber、h323,pstn 的格式为 “手机号@TEL”,若是分区云环境,部署了ippbx,邀请PSTN,格式是 “*1xxx” | 3.9 5.2-20221121 公有云 |
【h323跨云号码格式说明】
在原有正常呼叫规则的基础上, 末尾加上“**区号”(20250926 迭代开始支持)
以1.1.1.1 ip 为例子,跨云区号:0189为例:
1)本云: 1.1.1.1 , 跨云:1.1.1.1**0189
2) 本云: 1.1.1.1##网关id , 跨云: 1.1.1.1##网关id**0189
3)本云:1.1.1.1##云会议室号, 跨云:1.1.1.1##云会议室号**0189
4)本云:1.1.1.1##云会议室号##网关id。跨云:1.1.1.1##云会议室号##网关id**0189
5)本云:1.1.1.1##MCU会议室号##MCU会议室密码, 跨云: 1.1.1.1##MCU会议室号##MCU会议室密码**0189
6)本云:1.1.1.1##MCU会议室号##MCU会议室密码##网关id, 跨云:1.1.1.1##MCU会议室号##MCU会议室密码##网关id**0189
请求消息体示例(Json)
{
"callNumber": "9100637037",
"deviceList": [
{
"number": "13810001000"
},
{
"number": "168269"
},
{
"number": "172.17.90.43##600005"
},
{
"number": "15900010002@TEL"
}
]
}
返回结果示例:
成功时返回200,失败时返回小鱼RESTAPI错误码