Send Mobile Push over API

Infobip provides a robust API to send Mobile push messages and get analytics. You can use this API for transactional, informational, and promotional use cases.

Send Mobile Push over API

Use the Send Push notifications (opens in a new tab) method to send Mobile push messages to one or more recipients. The unified structure of the API across all channels enables you to integrate it with your app. The mobile push parameters enable you to target either a specific mobile application user or to a segment of users.

Configure the fields as follows.

Sender

The identifier of the application profile. Use the Application code or Application ID of the application profile that you create in the Infobip web interface.

Destination

To send a Mobile push message to a single recipient, use one of the following parameter types:

• External user ID
• Email
• Phone number
• Registration

To send a Mobile push message to multiple recipients, use Multiple.

For more information, refer to the relevant sections on this page.

Target single recipient with non-personalized device

A non-personalized device is an end user's device that is not associated with any of the personalized standard attributes (External user ID, email, or phone number).

To send a Mobile push message to a non-personalized device, do the following.

• Specify REGISTRATION as the destination type.
• Specify the Push registration ID. This value is available by default on all installations of the mobile application.

Code sample

    "destinations": [
	{
	"pushRegistrationId": "DBE0B0B6-668E-491E-8EE8-2A3DB2C71CBE",
	"type": "REGISTRATION"
	}
	]

Push registration ID

The following table shows information about the Push registration ID.

Target single recipient with personalized device

A personalized device is an end user's device that is associated with one or more of the personalized standard attributes (External user ID, email, or phone number).

Use the following destination address types.

These address types are not available by default. You must define them either in the Mobile SDK or the People API.

• Android (opens in a new tab)
• iOS (opens in a new tab)
• Huawei (opens in a new tab)
• Flutter (opens in a new tab)
• React Native (opens in a new tab)
• Cordova (opens in a new tab)
• People API (opens in a new tab)

Code sample

    "destinations": [
	{
	"externalUserId": "customer_21234",
	"type": "EXTERNAL_USER_ID"
	}
	]

Target multiple recipients by using AND operator

To send a Mobile push message to multiple recipients, do the following.

• Specify MULTIPLE as the destination type.
• Specify multiple values for the destination parameter by using the <and> operator.

Code sample

    "destinations": [
     {
        "$and": [
          {
             "externalUserId": "customer_21234"
           },                   
 
           {
             "externalUserId": "customer_21235"
           },
 
         ]
         "type": "MULTIPLE"
 
     }
]

Target multiple recipients by using device attributes

You can target multiple recipients based on the device attributes.

These destination address types are enabled by default.

The following destination address types are not available by default. You must define them over Mobile SDK.

To send a Mobile push message to multiple recipients, do the following.

• Specify MULTIPLE as the destination type.
• Specify multiple values for the destination parameter by using the <and> and <or> operators.

In the following example, all iOS devices are targeted.

Code sample

    "destinations": [
     {
        "$or": [
          {
             "platform": "iOS"
           },                   
 
 
         ]
         "type": "MULTIPLE"
 
 
     }
]

Advanced targeting

To create the required user segmentation and send them Mobile push messages, do the following.

• Specify MULTIPLE as the destination type.
• Use the <and> and <or> operators.

Example 1

In the following example, all iOS devices of the recipient with a specific phone number are targeted.

Code sample

"destinations": [
     {
        "$and": [
          {
             "platform": "iOS"
           }, 
          {
             "phoneNumber": "441134960001"
           },                                  
 
         ]
         "type": "MULTIPLE"
 
     }
]

Example 2

In the following example, the following recipients are targeted. The recipients must fulfil both criteria.

• The custom device attribute, Device type, is either Personal or Business.
• Target device has iOS.

Code sample

"destinations": [
     {
        "$and": [
          {
             "platform": "iOS"
           }, 
          {
             "DeviceType": "personal"
           }, 
 
           ]
        "$or": [
           {
            "DeviceType": "business"
           }, 
           ]
         "type": "MULTIPLE"
 
     }
]

Mirror push notifications within the application

You can use Send push API to show the notification within the application for the following scenarios:​

• Show a push notification as well as show the notification within the app. Example: To support transactional information to end users who are using the application and cannot see push notifications. ​
• Show the notification only within the application without showing a push notification. The notification is not displayed in the Notification center. To use this option, enable Silent push notification type.

Message formats

You can show the notification within the application in the following formats:

• Modal: A type of notification that pops up on a screen and overlaps a part of the screen. Use this feature for scenarios when you want to get the full attention of the end user and ask them to do something.
• Banner: Small notifications that are temporarily displayed over the content of the mobile app. They are displayed either on the top or the bottom of the screen of the mobile device and then close automatically after a few seconds. Use banners when you need to inform an end-user about something without stopping them from what they are doing in the app.

Supported SDK versions

The following SDK versions support showing the message inside the app.

Notification parameters

To send notifications within the app, add the following parameters in notificationOptions.

Get Stats over API

Use the bulk push message statistics method (opens in a new tab) to retrieve statistics for sent bulk push messages.

Query parameters

Response format

Errors

Delivery

Send Push over OMNI API

The OMNI API enables automatic fallback to another channel according to the defined order.

To send push with OMNI API you need to:

• Create an OMNI scenario
• Send a message with OMNI scenario
• Get delivery reports (optional)

Create OMNI Scenario

To create an OMNI scenario, you need to define the OMNI steps which will be sequentially executed.

To send push notifications with the scenario, you should use push (“channel”: “PUSH”) and APPLICATION CODE as the sender (“from”: “APPLICATION CODE”) generated during the setup of the mobile application.

Find more information on how to create the OMNI scenario in the Create Mobile Application Profile article in the Documentation Hub. Refer to the Infobip API Developer Hub for more information on how to create an OMNI scenario (opens in a new tab).

Most common OMNI scenario is push with SMS as a fallback channel. The following code snippet demonstrates how to create such a scenario.

    {
      "name" : "push + SMS scenario",
      "flow": [
        {
          "from": "APPLICATION CODE",
          "channel": "PUSH"
        },
        {
          "from": "YOUR_REGISTERED_SMS_SENDER",
          "channel": "SMS"
        }
      ],
      "default": true
    }

Send Messages With OMNI Scenario

Once you've created the OMNI scenario (identified by the key parameter), you can send your OMNI messages through defined communication channels.

If you want to send one or multiple messages to different channels, you need to use the advanced OMNI message method (opens in a new tab).

You can use different options for processing push notifications when you receive them.

The code snippet demonstrates how to send a push notification with options with OMNI API.

    {
      "scenarioKey": "key",
      "destinations": [
        {
          "to": {
            "phoneNumber": "phone number"
          }
        }
      ],
      "push": {
        "text": "This PUSH message will pop up on your mobile device.",
        "customPayload": {
          "contentUrl": "https://someurl.com/content",
          "deepLink": "myApp://some/link"
        },
        "notificationOptions": {
          "vibrationEnabled": true,
          "soundEnabled": true,
          "soundName": "sound.wav",
          "badge": 1,
          "contentUrl": "http://www.mydomain.com/images/image1.jpg",
          "category": "mm_accept_decline",
          "inAppStyle": "MODAL",
          "title": "This is some title"
        },
        "targetOnlyPrimaryDevices": true,
        "includeNotificationsDisabledDevices": true
      },
      "sms": {
        "text": "This is the SMS failover message"
      }
    }

Get Delivery Report

You can check the status of messages sent and get delivery reports with the OMNI reports (opens in a new tab) method.