Push API v4

• Push a notification or message to a single device or a device list

• The push content can only be one push object in JSON format

• For label/alias related functions, please refer to AppPushAPI.

Request Rate Limits

Our API imposes limits on the call frequency to ensure the stability and fairness of the service. The QPS (Queries Per Second) limits for each AppKey are as follows:

• Standard Limit: A maximum of 500 requests per second.
• Advanced Limit: If you are a subscriber to our paid plan and your paid AppKey requires a higher QPS limit, please contact our business team: Sales@engagelab.com.

Call Validation

For more information, see Authentication method

Call Address

POST https://webpush.api.engagelab.cc/v4/push

Sample Requests

Request header

          > POST /v4/push HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

        

Request body

          {
    "from": "push",
    "to": "all",
    "body": {
        "platform": "web",
        "notification": {
            "alert": "Hi,MTPush !",//optional
            "web": {
                "alert": "web_push",
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}

        

Request Parameters

The parameter structure of the push, as detailed in the following table.

from

The sender of the current business. The value is of the String type and is optional.

Sample Requests

          {
    "from":"push"
}

        

to

Push device object, which indicates the list of devices to which a push can be pushed. Confirm the push device object. MTPush provides two methods: Registration ID and broadcast.

Push target

Sample Requests

• Push to all (broadcast)：

          {
  "to": "all",
}

        

• Push to multiple registration IDs：

          {
  "to": {
    "registration_id": [
      "4312kjklfds2",
      "8914afd2",
      "45fdsa31"
    ]
  }
}

        

body

The body of the request. Supported fields are as follows：

platform

MTPush currently only supports Web platform push, so the keyword specified by platform is "web".

          { "platform" : "web" }

        

notification

The notification object is one of the pushed entity content objects (the other is a message) and is pushed to the web as a notification

web

Notifications on the Web platform

          {
    "notification": {
        "web": {
            "alert": "hello, Push!",
            "title": "Push Test",
            "url":"http://www.google.com",
            "icon":"",
            "image":"",
            "extras": {
                "news_id": 134,
                "my_key": "a value"
            }
        }
    }
}

        

message

In-App messages. Or custom messages. This part of the content is not displayed on the browser. After receiving the message, the SDK transmits it to the Web, and the Web processes the business logic

The message contains the following fields：

Example：

          {
  "message": {
    "msg_content": "Hi,Push",
    "content_type": "text",
    "title": "msg",
    "extras": {
      "key": "value"
    }
  }
}

        

options

Push options. The following options are available：

multi_language

This field is the multi-language push function of the EngageLab Push service. It allows you to push customized notification content to users in different languages. By specifying multiple languages and their corresponding message content, title, and iOS subtitle in the push request, you can send appropriate push notifications according to the user's language settings.

Request Parameters

Request Example

             HTTP request method: Post
   Request URL: /v4/push
   POST data format: json
   POST data example:
   {
    "options": {
      "multi_language": {
        "en": {
          "content": "",
          "title": "",
        }
      }
    }
   }

        

Response Example

          On success:
{
   
}

On failure:
{   
    "code":400,  
    "data":"",
  "message":"Error information"
}   

        

third_party_channel

This field is used to fill in the personalized information of the Web system channel. The key name is w3push, and the value is a Json Object Object. The Object contains only one optional distribution field of the type String

Example：

          {
  "third_party_channel":{
    "w3push":{
      "distribution":"mtpush"
    }
  }
}

        

request_id

The id of the request. The customer identifies the request and returns the response

Sample Requests

          {
      "request_id":"12345678"
}

        

Response Example

custom_args

The user-defined optional field. It is not returned when it responds, but returned when it is called back.

          {
  "custom_args":"business info"
}

        

Response parameters

Success Response

          < HTTP/1.1 200 OK
< Content-Type: application/json
{"request_id": "18", "msg_id": "1828256757"}

        

Failure response

The http status code is 4xx or 5xx and the response body contains the following fields.

          {
    "code": 3002,
    "message": "Push.template field must be set correctly when type is template"
}

        

Response

HTTP status code

References：HTTP-Status-Code

Return code

Push Restrictions

Multi-language code