强制断开取流
接口描述
强制断开指定设备的取流连接,断开后,原有取流地址将失效,须重新获取取流地址才能继续播放。
请求说明
接口ID | 协议 | 方法 | PATH |
---|---|---|---|
15 | HTTPS | DELETE | /openapi/v1/stp/user/devices/video |
PATH参数
无
URL参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
accesskey_id | string | 是 | 参见签名认证 |
expires | int | 是 | 参见签名认证 |
signature | string | 是 | 参见签名认证 |
HTTP请求头
字段 | 值 |
---|---|
Content-Type | application/json |
请求参数
请求参数以Json格式放置于Body中,此接口请求参数是一个Json对象数组,对象字段如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
+ sn | string | 否 | 设备SN |
+ user_tag | string | 否 | 获取视频流时传入的 user_tag,1到16位的数字和字母组合 |
- 若sn和user_tag都不传,则会强制断开该公司下所有正在取流的连接;
- 若只传入sn,则会强制断开指定设备sn的正在取流的连接;
- 若只传入user_tag,则会强制断开与传入user_tag相同的用户标识的取流连接;
- 若同时传入sn和user_tag,则会强制断开与传入sn和user_tag都相同的取流连接。
请求示例
DELETE https://open.vzicloud.com/openapi/v1/stp/user/devices/video?accesskey_id=8dlP5tsD2115Q2ec9fCkX2wHSIIlhCO8&expires=1638241797&signature=FvVbRMdfI6mhhx6KayKhfLFweC0%3D HTTP/1.1
Host: open.vzicloud.com
Content-Length: 56
Content-Type: application/json
[{"sn":"12345678-87654321"}]
注意:您无法将请求示例的链接地址贴入浏览器直接运行,此示例仅展示URL格式,由于AccessKey具备有效期,您访问时此链接已过期。
返回说明
返回参数
此接口返回参数是一个Json对象数组,对象字段如下:
参数 | 类型 | 说明 |
---|---|---|
+ sn | string | 设备SN,请求参数有则会返回此字段 |
+ user_tag | string | 获取视频流时传入的 user_tag,1到16位的数字和字母组合,请求参数有则会返回此字段 |
+ count | int | 当前设备断开的连接数 |
注:若设备不属于您或者设备未取流,返回参数count
为0
返回示例
[
{
"sn": "12345678-87654321",
"count": 1
}
]