OMNI channel: Introduction

• JSON

POST /omni/1/scenarios HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json

{
  "name":"My first scenario",
  "flow": [
    {
      "from": "InfoSMS",
      "channel": "SMS"
    },
    {
      "from": "41793026727",
      "channel": "VOICE"
    },
    {
      "from": "DemoViberApplication",
      "channel": "VIBER"
    },
    {
      "from": "DemoFBMessengerApplication",
      "channel": "FACEBOOK"
    },
    {
      "from": "your@email.com",
      "channel": "EMAIL"
    },
    {
      "from": "233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53",
      "channel": "PUSH"
    }
  ],
  "default": true
}	
  

When sending a message, the Infobip platform will attempt to send the message based on the order of steps in your scenario flow. If a user can't receive the message with a specific scenario channel, the failover mechanism will be triggered and the message will be sent over the next step.

When creating steps in the scenario flow, you need to define the from parameter that represents the sender of the specific channel. Note that for Viber you have to use your Viber service ID that is provided by Infobip.

Find out more details about OMNI scenarios in our API Scenario specification.

Sending OMNI message

After creating the first scenario, you are ready to send your OMNI messages through the defined communication channels.

There are two API methods that can be used for sending messages, simple and advanced. The simple API method enables you to send a single textual message over various channels. This functionality is useful when you need to send a generic text and to have a failover mechanism:

• JSON

POST /omni/1/text HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json

{ 
    "destinations":[ 
        { 
          "to":{
              "phoneNumber": "41793026727",
              "emailAddress": "email@example.com"
            }
        }
    ],
    "text": "A long time ago in a galaxy far, far away..."
}	
  

On the other hand, you can use the advanced API method when you want to send custom content over a specific communication channel.

• JSON

POST /omni/1/advanced HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json

{ 
	"bulkId":"BULK-ID-123-xyz",
  "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611",  
  "destinations":[ 
  	{ 
    	"messageId":"MESSAGE-ID-123-xyz",
      "to":"41793026727"
    },
    { 
    	"to":"41793026731"
    }
  ],
  "sms": {
  	"text": "This is custom SMS text. Over SMS I can send a text with 160 characters."
  },
  "viber": {
  	"text": "But if I use Viber, my message text will have capacity of 1.000 characters."
  },
  "facebook": {
  	"text": "If I use Facebook comunication channel, message text will have the capacity of 1.000 characters."
  },
  "voice": {
  	"text": "And with Voice, my user will receive voice message converted from text."
  },
  "email":{
    "text":"Email combines together the longest possible message length and a nice subject.",
    "subject": "And here goes the nice email subject"
   },
  "push": {
  	"text": "this PUSH message will pop up on your mobile device."
  },
}	
  

Depending on the channel you're using, you can specify various text length:

Parameters

Channel	Text length
SMS	Max 160 characters for one message.
Viber	Max 1.000 characters.
Facebook Messenger	Max 1.000 characters.
Voice	Unlimited.
Email	Unlimited.
Push	Max 4.000 characters.

Find out more details on how to send a Single OMNI message or how to Customize your content for the specific channel in our API endpoint specifications.