Getting Started
Official Site
Getting Started
Official Site
  • Document description
  • Read before you start

  • Light application development guide

  • Mobile application development guide

  • Cloud live development guide

  • Desktop application development guide

  • Third party development guide

  • Message push development guide

  • IoT things data model

  • HTTP interface

    • Development specification
    • API privacy policy
    • Postman interface simulation call
    • accessToken: Get administrator token
    • API request example
    • Account docking
    • Push configuration
      • setMessageCallback: Set alarm callback address
      • getMessageCallback: View the alarm callback address
    • Cloud storage service
    • Equipment management

    • Device configurat

    • Video equipment

    • Device message
    • Device live broadcast
    • Device lock access
  • Reference documents

On this page
Function details
Request address
Incoming parameter description
Sample input
Return data field description
Sample output

setMessageCallback - Set the Alarm Callback Address - Imou Open Platform

setMessageCallback: Set the alarm callback address

Function details

Set the message callback address of the developer account.

Note: For the overall process of message push, please refer to Event Message Push Process

Request address

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

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator accessToken
statusStringYes"on","off"Whether to subscribe to news
callbackUrlStringNo""Required when message callback URL status is on; when status is off, it can be empty;The address where the developer receives device messages must be accessible from the Internet
callbackFlagStringNo""alarm: device alarm message push; deviceStatus: device online and offline message push; numberstat: device passenger flow data message push; faceAnalysis: device face intelligent message pushcallback type identification, callback type is optional Fill in one or more of the above (separated by a comma). When status is on, it is required; when status is off, it can be empty.
basePushStringNo"2""1": push; "2": no push

Remarks: callbackFlag represents the category of event messages. For specific type definitions, please refer to Event Message Type Definition

Sample input

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"85384489874412a2e9aa7ac3a8b08309",
        "time":1603350639,
        "nonce":"350f4c7a-a352-46cf-ae03-f4f526f5d99f"
    },
    "id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
    "params":{
        "callbackFlag":"alarm,deviceStatus",
        "basePush":"2",
        "callbackUrl":"https://www.baidu.com",
        "token":"At_00000ad9e6e87f0142eb92e207aec46a",
        "status":"on"
    }
}

Return data field description

No data returned

Sample output

{
  "id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
  "result":{
    "code":"0",
    "msg":"The operation was successful"
  }
}
listSubAccountDevice: Query the list of devices with permissions for the sub-account
getMessageCallback: View the alarm callback address