Sending Push notification

A push notification is the delivery of information to a computing device from an application server where the request for the transaction is initiated by the server rather than by an explicit request from the client. While 'push notification' is most often used to refer to notifications on mobile devices.

Each native mobile application platform (iOS, Android) has its own set of development guidelines and standards, as well as its own OSPNS (Operating System Push Notification Service). Most of these OSPNS allow push notifications to include text, images, app badges, and sounds. The OSPNS routes the notification from the application provider to the application user’s device.

To add push notifications to an application, the application publisher registers with the push notification service of the OS for which they’re developing . Then their OS service provides an API to the app publisher so that the app can communicate with the service. The app publisher then adds the SDK to their application, then uploads the app to the appropriate app store. That is, in order to send push notifications to devices, it is necessary to register your application through the Google and iOS servers. Once your application is configured with the servers (Google / iOS), credentials will be generated. These credentials are the permissions granted to be able to send push notifications to the application configured by the client. The next step is to add our SDK to your app, this will allow you to send push notifications and get device tokens from users' devices once they have downloaded and registered your app. Now, you can send a new push notification message through the notification method.

📘

NOTE

The total number of API Calls (requests) that the user can make to the POST /notification endpoint in a certain time has been limited. That is, in case the user exceeds the limit of requests (messages sent) that can be made in a specific time, he/she will not be able to send another request until the established time is up. Once the time has elapsed, the request counter is reset and the request can be sent to the endpoint again.

In this example, the user can send 2 requests in 300 seconds (5 minutes). When a third request is sent within the 5 minute range, the HTTP Status Code “429” will be generated and the following parameter will be displayed from the Response body: "errors": { "reason": Too Many Requests" }. This code tells you that the user has sent too many requests in a given amount of time. Once the required time has elapsed, the request counter is reset to 2, so the user will be able to send two requests again in 5 minutes.

To find out if the user exceeds the limit of required requests and the time he/she needs to wait to send the next request, we recommend consulting the Response Header (additional information about the body of the resource). The parameters presented in the response header are the following:

ratelimit-limit: 2
ratelimit-policy: 2;w= 300
ratelimit-remaining: 1
ratelimit-reset: 5m0s

• RateLimit-Limit: return the number of requests left for the client in the time window
• RateLimit-Remaining: return the remaining quota in the current window
• RateLimit-Reset: return the time remaining in the current window, specified in seconds
• RateLimit-Policy: return the quota policy. The quota policy expression can be found in paragraph 2.1 of the IETF draft. The format is, for example, for 2 requests in 300 seconds.

When you send an Push notification message, the request body contains the following data:

HTTP Request : POST / notification

{
  "channel": "PUSH",
  "request": {
    "platform": "ANDROID",
    "to": "fxxxYXf7nfQ:APA91bG2Kzd...",
    "title": "Free shipping for a month!",
    "message": "body notification.",
    "credentialId": "5f1640b0869b170ce8c95825"
  },
  "callbacks": [
    "http://www.mycallback.com?id=123"
  ]
}

The parameters presented in the request body example when sending the Push message are the following:

The parameters presented in the response body example when sending the Push notification message are the following:

The Messaging API publishes the Push message in the Push notification API queue, for this reason the response generates the “meta” segment.