邀请
API接口URL
https://sdk.cloudroom.com/CLOUDMEETING-API/v2/room/invite
请求方式:POST
参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| InvitedUserID | String | 是 | 邀请的用户ID 或设备地址(如SIP、H323、GB28181、RTSP、ONVIF等协议设备) |
| UsrExtDat | String | 否 | 扩展信息,参见详细说明 |
参数详细说明
-
InvitedUserID
- 如果邀请的是用户,则传入用户的ID。
- 如果邀请的是设备,则传入设备的地址,格式如下:
- SIP设备:
sip:ip - H323设备:
h323:ip - GB28181设备:
gb28181:通道编号 - RTSP设备:
rtsp://ip:端口或rtsp://用户名:密码@ip:端口 - ONVIF设备:
onvif://用户名:密码@ip:端口
- SIP设备:
-
UsrExtDat
- 如果邀请的是用户,内容完全由调用方自定义。
- 如果邀请的是设备,必须为JSON格式的字符串
{"meeting":{"ID":会议号}, "devInfo":{"userID":"会议中用户ID", "nickName":"会议中用户昵称"}},字段说明如下:meeting:会议信息,包含会议号。devInfo:设备入会信息(可选),包含用户ID和昵称。如果不需要自定义用户ID和昵称,则可以不传devInfo字段。
请求示例
- 邀请用户
{
"RequestId":"08123690-6e2c-27bf-7415-4d2a9ea695f3",
"CompID":111111,
"SecretKey":"08635988d9be4151fcb5251b0af2b3c1",
"InvitedUserID":"H5用户8083",
"UsrExtDat":"{\"meeting\":{\"ID\":47105186}}"
}
- 邀请设备
{
"RequestId":"08123690-6e2c-27bf-7415-4d2a9ea695f3",
"CompID":111111,
"SecretKey":"08635988d9be4151fcb5251b0af2b3c1",
"InvitedUserID":"h323:192.168.1.188",
"UsrExtDat":"{\"meeting\":{\"ID\":47105186},\"devInfo\":{\"userID\":\"test323\",\"nickName\":\"test323\"}}"
}
返回数据
| 名称 | 类型 | 说明 |
|---|---|---|
| RspCode | String | 响应码 |
| RspDesc | String | 响应描述 |
| Data | Map | 数据集合 |
返回参数示例
{
"RspCode": 0,
"RspDesc": "请求成功"
}
返回状态码RspCode说明
| 数值 | 说明 |
|---|---|
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |
| 46 | SIP 协议未启用 |
| 47 | H323 协议未启用 |