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

请求约定

请求约定

下面的值抄自 开发规范。该页没写的请求头或方法,本页也不补。

数据中心主机

Imou 开放平台按数据中心提供不同域名。请使用与开发者账号所属数据中心一致的主机。数据中心见 控制台 - 基本信息 - 我的信息。

方法页使用:

https://openapi-[DataCenter].easy4ip.com/openapi/{method}

v2 能力方法使用 /openapi/v2/{methodName}。见 能力使用。

POST 请求体

请求体结构如下:

FieldTypeDescription
system.verString协议版本,当前为 1.0
system.signString签名字段,平台用于验签;计算步骤见 签名
system.appIdStringappId,在控制台 - 我的应用 - 应用信息获取
system.timeLong发起请求的客户端 UTC 时间戳(秒),须与开放平台时间差不超过 5 分钟
system.nonceString随机数(32 位)。5 分钟内不可重复,否则返回 SN1005。
paramsMap业务接口入参集合,值为 Map
idString请求唯一 ID,每次调用须传入非空且不重复的字符串

以获取管理员 Token 的 accessToken 为例:

{
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "id": "98a7a257-c4e4-4db3-a2d3-d97a3836b87c",
 "params": {}
}

不要抄示例里的 sign。每次现算。

开发规范页没有写额外必填 HTTP 头,本页也不补。

响应体

字段名字段类型字段说明
result.codeString返回码,见 返回码
result.msgString返回码描述
result.dataMap接口返回的业务数据,值为 Map
idString请求时开发者传入的 id
{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "expireTime":259176,
 "accessToken":"At_00006ac6e32d123141238f60147de7ec"
 }
 },
 "id":"98a7a257-c4e4-4db3-a2d3-d97a3836b87c"
}

成功是 result.code 为 "0"。

错误码

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

网关与鉴权(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。

设备访问与通道(DV10xx)

错误码错误码说明下一步
DV1007设备离线或超时等设备上线
DV1009设备正忙稍后重试
DV1012分享/授权设备权限不足核对子账号 Permission / Resource
DV1019能力集不支持确认型号与能力列表
DV1020通道离线检查通道状态
DV1026不支持此功能换接口或升级固件
DV1028未绑定或通道不存在核对 deviceId / channelId

更多见 错误码 · DV。

历史事件报文格式
签名