Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
      • device.message.list (Receive alarm messages)
      • device.message.list (Query alarm history)
      • device.message.search (Search messages by type)
      • device.message.detail (Query one alarm message)
      • device.message.delete (Delete alarm messages)
      • Event types
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

device.message.detail (Query one alarm message)

device.message.detail: Query one alarm message

What it does

Fetch one message by alarmId. No permission → whole-call DV2011. Returns one push-shaped object (same as Receive alarm messages), not list count / nextAlarmId. msgType equals eventId.

Legacy alarm / deviceStatus payloads differ; see Receive device messages.

Platform fields are not inside capability outputData.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.message.detail

Minimum permission

Administrator on bound devices: no extra permission. Shared devices: alarm message permission. Sub-account: share/sub codes for that message’s event (see Permission codes). Device must be bound.

Request parameters

NameTypeRequiredDefaultValid valuesDescription
tokenStringyesaccessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
alarmIdStringyesAlarm id

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "alarmId": "116257862023505xxxx"
 }
}

Response data fields

data is the alarm object. Fields match list/history messages; securityRiskLevel / aiTag may be Mix-normalized (level text / single tag string). feedback may appear on list/search/detail; real-time push (g04) does not. feedback.type: 1 person, 2 face, 3 LLM; result: 0 inaccurate / 1 accurate.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "msgType": "detection.motion.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {
 "extendContext": {
 "handleBit": 1
 }
 },
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825",
 "thumbUrl": "https://example.imou.com/pic/thumb.jpg",
 "picUrlArray": ["https://example.imou.com/pic/alarm1.jpg"],
 "labelType": "humanAlarm",
 "feedback": {
 "type": 1,
 "result": 1
 }
 }
 }
}

Error codes

No permission for that row → DV2011. Invalid or missing alarmId → DV2001. Alarm cannot be mapped to a catalog eventId → DV2002.

include 未找到:06.dv20-message.md

device.message.search (Search messages by type)
device.message.delete (Delete alarm messages)