getAlarmMessageById (getAlarmMessageById: Query alarm message by id)

getAlarmMessageById: getAlarmMessageById: Query alarm message by id

Legacy HTTP retained: New integrations can use Alarm messages (device.message.detail) for the related capability. The two interfaces are not a one-to-one replacement. device.message.* is a related entry, not a one-to-one replacement of this HTTP method.

Function details

Query alarm message details by alarmId and msgType.

Legacy OpenAPI detail. Capability events: Query one alarm message (device.message.detail).

Request address

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

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Minimum permissions required for sub-account token request

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

Incoming parameter description

Parameter name	Parameter type	Required or not	Parameter description
token	String	Yes	Administrator or sub-account accessToken
deviceId	String	Yes	Device serial number
channelId	String	Yes	Channel ID
alarmId	String	Yes	Alarm message ID
msgType	String	Yes	Message type

Sample input

{
 "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"
 }
}

Return data field description

Field name	Field type	Field description
time	Long or String	Alarm time (UNIX seconds or device-local string, model-dependent)
channelId	String	Channel ID
alarmId	Long or String	Message ID
deviceId	String	Device serial number
picurlArray	String[]	Alarm image URLs
thumbUrl	String	Thumbnail URL
msgType	String	Message type (for example `videoMotion`, `alarmPIR`)
token	String	Cloud recording token (`cloudToken`) when present

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "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"
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.