开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
      • setMessageCallback(设置消息回调地址)
      • getMessageCallback(查询消息回调地址)
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能说明
请求地址
请求格式
请求参数
请求示例
返回 data 字段
响应示例
错误码
相关参考

getMessageCallback(查询消息回调地址)

getMessageCallback:查询消息回调地址

功能说明

查询开发者账号当前配置的消息回调信息。修改配置见 setMessageCallback。

消息推送整体流程见 接收设备消息。callbackFlag 含 capabilityEvent 时用于能力事件推送。msgType 见 事件消息类型定义。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/getMessageCallback

请求格式

POST JSON 请求体见 请求约定;签名见 签名。

请求参数

参数名参数类型是否必填默认值合法取值参数说明
tokenString是管理员 accessToken

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603350473,
 "nonce":"a4d59add-0f04-4b7e-9355-d1fb4e9dc22b"
 },
 "id":"d82a7fa7-655f-4bb8-ab75-72bb3dfa3a94",
 "params":{
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

返回 data 字段

字段名字段类型字段说明
statusString是否开启订阅:on / off
callbackUrlString消息回调 URL;未订阅时为空
callbackFlagString回调类型标识,逗号分隔;未订阅时为空。alarm:告警;deviceStatus:设备/通道上下线等

callbackFlag 类型定义见 事件消息类型(历史对照)。能力事件报文见 接收告警。

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "callbackFlag":"alarm,deviceStatus",
 "callbackUrl":"https://www.example.com/callback",
 "status":"on"
 }
 },
 "id":"d82a7fa7-655f-4bb8-ab75-72bb3dfa3a94"
}

错误码

本接口可能返回下列码;完整分组见 错误码 与 能力错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

子账号(SUB)

错误码错误码说明下一步
SUB1001–SUB1002子账号无接口权限在 addPolicy 中补策略
SUB1005子账号 token 过期重新 subAccountToken
SUB1006子账号与设备无授权核对 Resource 与设备序列号
SUB1008子账号未绑定应用先创建并绑定子账号

更多见 错误码 · SUB。

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
setMessageCallback(设置消息回调地址)
openCloudRecord(开通设备云存储)