设备端三方SDK透传消息
接口背景
平台提供开发者将自己的SDK集成到设备上,为实现平台下发指令到开发者设备SDK,提供该接口。开发者将需要发送的指令通过该接口下发到自己的设备SDK中。具体SDK集成和对接方式请咨询我公司设备侧对接人。
接口调用说明
请求地址 : /v1/api/device/send_direct_msg
请求方式 : POST
请求头
参数名 | 参数值 | 是否必须 |
---|---|---|
Content-Type | application/json | 是 |
X-Token | 实际accessToken | 是 |
请求报文体
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
deviceSn | String | 是 | 设备序列号 |
channelId | number | 是 | 视频通道号 |
message | string | 是 | Base64 编码后的消息,最大长度 10240 |
//示例数据
{
"deviceSn" : "**********",//设备序列号
"channelId": 0,
"message":"messageBase64"
}
响应报文
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | int | 是 | 状态码 |
msg | String | 是 | 状态码解释信息 |
data | Object | 否 | 返回内容 |
data内容如下:
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
respData | String | 是 | 透传返回数据 |
//示例数据
{
"code":1000,//状态码
"msg":"OK",//状态码解释信息
"data":{
"respData":"respData"
}
}
错误码
状态码 | 状态描述 |
---|---|
1000 | 成功 |
1001 | 参数格式错误或缺失 |
1002 | 请求异常 |
1006 | AccessToken过期或异常 |
2008 | 设备不存在 |
2002 | 设备不在线 |
2009 | 视频通道号错误 |