INinfobip
channels
mobile-app-messaging
send-push

Send single Push notification

Use this method to send a single Push notification to one or multiple recipients.

post/push/2/message/single

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

fromstring required

PUSH Application Code you are using to send messages. Application Code is the application identifier which links your mobile application to the application profile created in Infobip Platform. It is required to insert the Application Code in Mobile Messaging SDK configuration once you implement it in your mobile application.

toobject required

Recipient destination address. Check examples how to work with recipients

textstring required

Text of the message that will be sent.

validityPeriodinteger

The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in hours. Once the period expires, messages that haven't left the Infobip platform or the Cloud (APNS or FCM) will be canceled and won't get delivered. Default value is 48h. Minimum value is 30 sec. Maximum value is 72h.

validityPeriodTimeUnit'SECONDS' | 'MINUTES' | 'HOURS'

Time unit for validity period. Defaults to hours.

sendAtstring date-time

Used for scheduled Push notifications. Message will be sent at scheduled time. Date and time when the message is to be sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 180 days in advance.

customPayloadobject

Additional data that can be delivered with the Push message. customPayload must be formatted as JSON object.

notifyUrlstring

The URL on your call back server on to which a delivery report will be sent. The retry cycle for when your URL becomes unavailable uses the following formula: 1min + (1min * retryNumber * retryNumber).

notifyContentTypestring

Preferred Delivery report content type. Supported content types: application/json, application/xml.

callbackDatastring

Additional client's data that will be sent onto notifyUrl. The maximum value is 200 characters.

targetOnlyPrimaryDevicesboolean

Set to true to only send messages to push devices which are marked as primary devices. By default, messages will be sent to all targeted devices, including both primary and non-primary.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.