绑定(添加)中维协议3.0(原公有云协议)设备
添加中维协议3.0(原公有云协议)设备必须保证设备在线,且没有被他人绑定。
接口调用说明
请求地址 : /v1/api/device/add
请求方式 : POST
请求头
| 参数名 | 参数值 | 是否必须 |
|---|---|---|
| Content-Type | application/json | 是 |
| X-Token | 实际accessToken | 是 |
请求报文体
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| deviceSn | String | 是 | 设备序列号 |
| validateCode | String | 是 | 设备校验码 |
//示例数据
{
"deviceSn" : "**********",//设备序列号
"validateCode" : "WEDR234BD"//设备校验码
}
响应报文
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| code | int | 是 | 状态码 |
| msg | String | 是 | 状态码解释信息 |
| data | Object | 否 | 返回内容(详情见下表) |
data内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| deviceSn | String | 是 | 设备序列号 |
| deviceName | String | 是 | 设备名称 |
| deviceType | String | 设备类型(IPC/NVR/IPDOME/DVR) | |
| firmware | String | 固件版本 | |
| deviceState | int | 设备状态 (0离线 1在线 3未注册) | |
| mac | String | 设备mac地址 | |
| model | String | 设备型号 | |
| modType | String | 内部型号 | |
| ability | String[] | 设备能力集 | |
| channelCount | int | 通道个数 | |
| streamCount | int | 单通道码流个数,国标不支持码流切换 | |
| addTime | String | 设备添加时间,RFC3339格式 | |
| protocolVersion | String | 设备协议版本号 | |
| videoChannels | Object[] | ||
| protocolType | int | 是 | 协议类型:1 中维协议3.0(原公有云协议),2 国标 |
videoChannels内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| channelId | int | 是 | 视频通道号 |
| channelSn | String | 否 | 通道序列号 |
| model | String | 否 | 通道型号 |
| channelName | String | 是 | 视频通道名称 |
| channelState | number | 是 | 通道状态 (0离线 1在线 2 未配置) |
| channelType | String | 是 | 视频通道设备类型 |
| channelAbility | String[] | 是 | 视频通道能力集 |
//示例数据
{
"code": 1000,
"msg": "OK",
"data": {
"deviceSn": "**********",
"deviceType": "IPC",
"deviceName": "CR1",
"firmware": "V2.2.5780",
"deviceState": 0,
"mac": "XX:XX:XX:XX:XX:XX",
"model": "CR1",
"modType": "A26001",
"ability": ["ptz", "talk", "localstorage", "intelligent", "alarmsound", "pd", "ptzautotrace"],
"channelCount": 1,
"streamCount": 2,
"addTime": "2020-08-29T17:35:32.000+08:00",
"protocolVersion": "2.0.0",
"protocolType":1,
"videoChannels": [{
"channelId": 0,
"channelSn": "xxxx",
"model": "xxx",
"channelName": "CR1",
"channelType": "IPC",
"channelState": 0,
"channelAbility": ["ptz", "talk", "intelligent", "alarmsound", "pd", "ptzautotrace"]
}]
}
}
错误码
| 状态码 | 状态描述 |
|---|---|
| 1000 | 成功 |
| 1001 | 参数错误 |
| 1002 | 请求异常 |
| 1006 | AccessToken异常或过期 |
| 2002 | 设备不在线 |
| 2003 | 设备校验码错误 |
| 2005 | 设备已被添加 |
| 2007 | 设备属于专属项目,无添加权限 |
| 2008 | 设备不存在 |
| 2010 | 超过基础套餐路数限额 |
| 2016 | 通道超出最大限制 |
| 2023 | 设备在非许可区域上线,添加失败 |
| 6003 | 设备无权限 |
| 7003 | 不在设备白名单中,不可添加 |