Send OMNI failover message

Send one or multiple messages over WhatsApp, Viber, Voice, VKontakte, Line, SMS or Push, with automatic failover to another channel according to the specific scenario.

post/omni/1/advanced

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

scenarioKeystring

Scenario key that uniquely identifies the scenario which will be used when sending message. If this field is not set, the default scenario will be used.

bulkIdstring

The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.

notifyboolean

Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply.

intermediateReportboolean

The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to false.

notifyUrlstring

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

notifyContentTypestring

Preferred delivery report content type, application/json or application/xml.

callbackDatastring

Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.

sendAtstring date-time

Date and time when the message is to be sent. Used for scheduled OMNI messaging (first message in the OMNI flow not sent immediately, but at scheduled time). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. Must be sooner than 180 days from now.

Response

successful response