邀请入会
当会议室无人的时候,可调用此接口将指定会议号会议开启
- 请求方法
POST
- 请求地址
/ctrl/meetings/{meetingNumber}/invite
- 请求参数
参数 | 参数类型 | 数据类型 | 是否必须 | 描述 |
---|---|---|---|---|
meetingNumber | path | string | 是 | 会议号 |
type | body | string | 是 | 被邀请账号类型,可选:account,sip,h323,rtsp,rtmpPuller,phone,gb28181 |
contacts | body | string[] | 否 | 被邀请的账号,一次邀请的账号数量上限20个,当邀请类型为number时,邀请的账号数量上限为1个。例如:type=account,contacts=["81970014005"];type=sip, contacts=["10.81.91.15"]; |
targets | body | target[] | 否 | 目标信息(type为gb28181时使用此字段,其他type使用contacts字段) |
designateNames | body | string[] | 否 | 被邀请的账号入会后的显示名,列表顺序对应contacts的顺序 |
ability | body | ability | 否 | 邀请第三方终端时指定的能力 |
target
参数 | 数据类型 | 是否必须 | 描述 |
---|---|---|---|
subjectID | string | 是 | 监控平台注册账号 |
deviceIDs | string[] | 是 | 监控节点设备ID数组 |
ability
参数 | 数据类型 | 是否必须 | 描述 |
---|---|---|---|
bandwidth | string | 否 | 带宽,邀请SIP、H323类型时可携带,可选:128Kbps、512Kbps、768Kbps、1Mbps、1.5Mbps、2Mbps、3Mbps |
protocol | string | 否 | 协议,可选:TCP、UDP,邀请RTSP类型时可携带 |
- HTTP状态码
返回值 | 描述 |
---|---|
202 | 服务器已接受请求,但尚未处理。 |
400 | 客户端传参异常 |
401 | 鉴权失败 |
404 | 找不到请求的资源 |
500 | 服务端异常 |
- 请求消息示例
POST /v2/ctrl/meetings/819700180001/invite HTTP/1.1
Content-Type: application/json
{
"type":"account",
"contacts":[
"81970014005"
],
"designateNames":[
"指定名1"
]
}
POST /v2/ctrl/meetings/819700180001/invite HTTP/1.1
Content-Type: application/json
{
"type":"gb28181",
"targets":[
{
"subjectID":"9cd3d22f3f0143979df337ae8429e9f4",
"deviceIDs":[
"00000000581314000002"
]
}
]
}
- 响应消息示例
HTTP/1.1 202