getMessageCallback (getMessageCallback - View the Alarm Callback Address - Imou Open Platform)

getMessageCallback: getMessageCallback - View the Alarm Callback Address - Imou Open Platform

Function details

Get the message callback address information currently set by the developer account. To change settings, see setMessageCallback.

For the overall message push flow, see Receive device messages. Include capabilityEvent in callbackFlag for capability event pushes. msgType values: Event message types.

Request address

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

Request format

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

Incoming parameter description

Parameter name	Parameter type	Required or not	Default value	Legal value	Parameter description
token	String	Yes			Administrator accessToken

Sample input

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

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.

Return data field description

Field	Type	Description
status	String	Whether to subscribe to news
callbackUrl	String	Message callback URL (when not subscribed, the value is empty)
callbackFlag	String	Callback identifier, separated by commas (when not subscribed, the value is empty), alarm: alarm callback; deviceStatus: device and channel online and offline callback

See Event message types (legacy msgType table) for callbackFlag values. Capability event payloads: Receive alarm messages.

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "callbackFlag":"alarm,deviceStatus",
 "callbackUrl":"https://www.baidu.com",
 "status":"on"
 }
 },
 "id":"d82a7fa7-655f-4bb8-ab75-72bb3dfa3a94"
}