绑定(添加)国标设备
接口调用说明
请求地址 : /v1/api/device/gb/add
请求方式 : POST
请求头
| 参数名 | 参数值 | 是否必须 |
|---|---|---|
| Content-Type | application/json | 是 |
| X-Token | 实际accessToken | 是 |
请求报文体
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| deviceSn | String | 是 | 长度20位,11-13位只能为(111,118,132) |
| sipAuthPassword | String | 是 | 国标28181设备鉴权密码 |
| channelTotal | number | 是 | 通道总数 |
| streamTransportMode | String | 否 | 流传输模式,取值: UDP-UDP方式 TCP_ACTIVE-TCP主动 TCP_PASSIVE-TCP被动 默认值:TCP_PASSIVE |
| channels | object [] | 是 | 通道信息 |
channel内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| channelGBId | string | 是 | 长度20位,11-13位只能为(131) |
| channelId | number | 是 | 0或正整数 |
//示例数据
{
"deviceSn": "34020000001321300101",
"sipAuthPassword": "Password321",
"channelTotal": 2,
"streamTransportMode": "TCP_PASSIVE",
"channels": [
{
"channelGBId": "34020000001310000001",
"channelId": 1
},
{
"channelGBId": "34020000001310000002",
"channelId": 2
}
]
}
响应报文
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| code | int | 是 | 状态码 |
| msg | String | 是 | 状态码解释信息 |
| data | Object | 是 | 返回内容(详情见下表) |
data内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| sipServerId | String | 是 | 国标28181平台服务编码ID |
| sipServerDomain | String | 是 | 国标28181平台服务域 |
| sipServerIp | String | 是 | 国标28181平台服务IP地址 |
| sipServerPort | String | 是 | 国标28181平台服务port端口 |
| sipServerAddr | String | 是 | 国标28181平台服务接入地址 |
//示例数据
{
"code": 1000,
"msg": "OK",
"data": {
"sipServerId": "20000000000000000001",
"sipServerDomain": "2000000000",
"sipServerIp": "xxx.xxx.xxx.xxx",
"sipServerPort": "xxxx",
"sipServerAddr": "example.com"
}
}
错误码
| 状态码 | 状态描述 |
|---|---|
| 1000 | 成功 |
| 1001 | 参数错误 |
| 1002 | 请求异常 |
| 1006 | AccessToken异常或过期 |
| 2005 | 设备已被添加 |
| 2016 | 通道超出最大限制 |