文档

测试

新增订阅信息

websocket测试

POST

http://ip:port/LAPI/V1.0/System/Event/Subscription

接口描述

平台向相机新增订阅信息，当订阅类型的数据产生时，相机主动上报。

请求参数

参数名

类型

描述

必填

AddressType

int

IP地址类型，涉及：0-ipv4；1-ipv6

必填

IPAddress

string

IP地址，例：192.168.0.13

必填

Port

int

端口，例：55000

必填

Duration

int

订阅周期，单位秒/s，范围：[30,3600]

必填

Type

int

订阅类型，仅涉及订阅图片数据，默认为32

必填

响应参数

参数名

类型

描述

必填

Response

object

响应消息

必填

ResponseURL

string

响应URL，例：/LAPI/V1.0/System/Event/Subscription/1

必填

CreatedID

int

订阅用户ID，每次新增用户后值自增，PUT/DELETE时值无意义，例：1

必填

ResponseCode

int

响应结果码，涉及：0-成功；1-通用错误；2-参数非法；3-未鉴权；4-设备不支持

必填

SubResponseCode

int

子响应结果，仅ResponseCode为3时字段有意义，涉及：0-正常鉴权失败；1-需要二次鉴权

必填

ResponseString

string

响应结果描述，涉及：0-Succeed；1-Common Error；2-Invalid Arguments；3-Not Authorized；4-Not Supported

必填

StatusCode

int

标准响应码，涉及：200；401

必填

StatusString

string

响应描述，涉及：200-Succeed；401-Unauthorized

必填

Data

object

数据

必填

ID

int

订阅者用户ID，修改/删除订阅信息时使用

必填

Reference

string

订阅者描述信息，例：192.168.0.13:55000/Subscription/Subscribers/1

必填

CurrentTime

int

当前时间，UTC时间（UNIX秒级时间戳），例：1593696036

必填

TerminationTime

int

到期时间，UTC时间（UNIX秒级时间戳），例：1593696096

必填

SupportType

int

仅上报，平台不做关注

必填

说明 / 示例

请求示例： { "AddressType": 0, "IPAddress": "192.168.0.13", "Port": 55000, "Duration": 60, "Type": 32 } 响应示例： { "Response": { "ResponseURL": "/LAPI/V1.0/System/Event/Subscription/1", "CreatedID": 1, "ResponseCode": 0, "SubResponseCode": 0, "ResponseString": "Succeed", "StatusCode": 0, "StatusString": "Succeed", "Data": { "ID": 1, "Reference": "192.168.0.13:55000/Subscription/Subscribers/1", "CurrentTime": 1593696036, "TerminationTime": 1593696096, "SupportType": 15 } } }

上一篇交互流程

nextDoc 修改订阅信息