Callback API

Overview

The message status data is called back to the business system of the enterprise, and statistical analysis can be performed based on the information.

Callback address

The enterprise needs to set the callback address for receiving the message status change. Currently, there is no web interface. Please contact engagelab technical personnel to set the callback address.

Response Mechanism

After the developer service receives the callback of the Engagelab, it needs respond within 3 seconds according to the following requirements.

Received successfully: the HTTP response status code must return 200 or 204, and no response message is required.
Failed to receive: the HTTP response status code must return 5XX or 4XX and a response message. The format is as follows:

{ "code": 2002, "message": "error" }

          {
    "code": 2002,
    "message": "error"
}

This code block in the floating window

Field	Type	required/optional	Description
code	int	optional	error Codes
message	string	optional	error details

Callback content

Callback method: POST content-Type:application/json authorization:none note: Basic authentication is currently supported. Developers can also choose not to perform verification. Later authentication methods will be enriched.

Message status change

Example

Request Header

POST /developer_define_url HTTP/1.1 Content-Type: application/json

          POST /developer_define_url HTTP/1.1
Content-Type: application/json

This code block in the floating window

Request body

{ "total": 1, "rows": [{ "message_id": "1666165485030094861", // message id of the Aurora side "from":"", // sender "to":"", // Receiver, registrationID "server": "AppPush", "channel": "FCM", "custom_args": {}, // The parameters submitted at the creation of this message, which will be returned as is in this callback "itime":1640707579, // the timestamp of when the message status changed, such as when the message was delivered "status": { // Respond to these fields on success "message_status": "delivered", // message status "status_data": { // custom "channel_message_id": "wamid.123321abcdefed==" // optional, the msgid of the third-party channel }, // respond to these fields on failure "error_code":0, // error_code - corresponds to the lifecycle error code "error_detail":{ "message":""// reason for error }, "loss":{ "loss_source": "vivo", "loss_step":1} // stage and source of the loss } }] }

          {
    "total": 1,
    "rows": [{
      "message_id": "1666165485030094861", // message id of the Aurora side
    "from":"", // sender
    "to":"", // Receiver, registrationID
      "server": "AppPush",
      "channel": "FCM",
      "custom_args": {}, // The parameters submitted at the creation of this message, which will be returned as is in this callback
    "itime":1640707579, // the timestamp of when the message status changed, such as when the message was delivered
    
      "status": { 
      // Respond to these fields on success
      "message_status": "delivered", // message status    
      "status_data": { // custom
        "channel_message_id": "wamid.123321abcdefed==" // optional, the msgid of the third-party channel
      }, 

      // respond to these fields on failure
      "error_code":0, // error_code - corresponds to the lifecycle error code
      "error_detail":{
        "message":""// reason for error
     }, 
      "loss":{ "loss_source": "vivo", "loss_step":1} // stage and source of the loss
      }
  }]
}

This code block in the floating window

Parameter description

Valid values:

Value	meaning
target_valid	effective target
sent	sent successfully
delivered	delivered successfully
click	user Click
no_click	not clicked
target_invalid	invalid target
sent_failed	failed to send
delivered_failed	delivery failed

**Note: **1. There may be duplication of clicks and deliveries in some channels, and developers can remove duplicates by themselves. 2. The delivery quantity and impression quantity will not be adjusted back 5 days after the delivery is successful.

Loss phase
1: Plan objectives-effective objectives
2: Number of valid targets sent
3: Number of deliveries-number of deliveries
4: delivery quantity-number of clicks