开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
      • 门锁(遗留)
      • 告警消息(遗留)
        • deleteAlarmMessage(删除设备告警消息)
        • getAlarmMessage(查询设备告警消息)
        • getAlarmMessageById(根据 id 查询告警详情)
      • 设备查询(已弃用)
      • 设备维护(遗留)
      • 设备操作(遗留)
      • 设备使能(遗留)
      • 动检配置(遗留)
      • 收藏点(遗留)
      • 定时巡航(遗留)
      • 本地录像配置(遗留)
      • 音量(遗留)
      • 存储(遗留)
      • 图像与视频(遗留)
      • 时区(遗留)
      • Wi-Fi(遗留)
      • 本地录像查询(遗留)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能说明
请求地址
请求格式
子账号 token 最低权限
请求参数
请求示例
返回 data 字段
响应示例
错误码
相关参考

getAlarmMessageById(根据 id 查询告警详情)

getAlarmMessageById:根据 id 查询告警详情

遗留 HTTP 保留: 新接入可使用 告警消息(device.message.detail)对应能力。两套接口不是一对一替代。 device.message.* 只是相关入口,不是本 HTTP 的一对一替代。

功能说明

根据 alarmId 查询告警消息详情。

遗留 OpenAPI 单条查询。能力事件见 查询单条告警(device.message.detail)。

请求地址

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

请求格式

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

子账号 token 最低权限

"Permission":"Alarm" "Resource":"cam:serial number:channel number"

请求参数

参数名参数类型是否必填默认值合法取值参数说明
tokenString是管理员或子账号 accessToken
deviceIdString是设备序列号
channelIdString是通道号
alarmIdString是告警消息 Id
msgTypeString是消息类型

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603351506,
 "nonce":"3e3c27f0-1071-4f55-9de9-f0a932effb48"
 },
 "id":"28ca89f4-10c9-4ac4-9215-b829072eedcf",
 "params":{
 "msgType":"videoMotion",
 "alarmId":"1726360834259136",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

返回 data 字段

字段名字段类型字段说明
timeLong 或 String告警时间(UNIX 秒或设备本地时间字符串,因机型而异)
channelIdString通道号
alarmIdLong 或 String消息 Id
deviceIdString设备序列号
picurlArrayString[]告警图片 URL
thumbUrlString缩略图 URL
msgTypeString消息类型(如 videoMotion、alarmPIR)
tokenString云录像 token(cloudToken,若有)

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "msgType":"videoMotion",
 "alarmId":1726360834259136,
 "time":"20201022T151402",
 "thumbUrl":"https://example-cloud.example.com/alarm/thumb.jpg?Expires=1603438169&OSSAccessKeyId=PLACEHOLDER&Signature=PLACEHOLDER",
 "picurlArray":[
 "https://example-cloud.example.com/alarm/0.jpg?Expires=1603438169&OSSAccessKeyId=PLACEHOLDER&Signature=PLACEHOLDER"
 ],
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "token":"07540ab39e82488490b232977c333c9e"
 }
 },
 "id":"28ca89f4-10c9-4ac4-9215-b829072eedcf"
}

错误码

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

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

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
getAlarmMessage(查询设备告警消息)
checkDeviceBindOrNot(查询设备绑定状态)