文档

邀请

API接口URL

https://www.cloudroom.com/CLOUDROOM-API/room/invite

请求方式：POST

参数

接口参数

名称	类型	是否必传	说明
RoomId	Long	是	房间号
UID	String	否	用户id
NickName	String	否	昵称
TargetUrl	String	是	邀请地址，支持以下几种类型： 1. SIP: 支持SIP协议的设备，格式为 `sip:ip` 2. H323: 支持H323协议的设备，格式为 `h323:ip` 3. GB28181: 支持GB28181协议的设备，格式为 `gb28181:通道编号` 4. RTSP: 支持RTSP协议的设备，格式为 `rtsp://ip:端口` 或 `rtsp://用户名:密码@ip:端口` 5. ONVIF: 支持ONVIF协议的设备，格式为 `onvif://用户名:密码@ip:端口`

请求参数示例

{
    "RequestId":"08123690-6e2c-27bf-7415-4d2a9ea695f3",
    "CompID":1,
    "SecretKey":"a7febff6a21c36fb50150f88c95ef641",
    "RoomId":20422998,
    "UID":"test01",
    "NickName":"test01",
    "TargetUrl":"gb28181:44010200402000000123"
}

返回数据

名称	类型	说明
RspCode	String	响应码
RspDesc	String	响应描述
Data	Map	数据集合

返回参数示例

{
    "RspCode": 0,
    "RspDesc": "请求成功"
}

返回状态码RspCode说明

数值	说明
0	请求成功
1	用户所属企业没有接口API权限
2	账号不存在
3	密码错误
4	未获取到正确参数
5	未知错误
6	缺少必传参数