Send messages over WhatsApp, Viber, Voice, VKontakte, Line and other channels with a failover to SMS or any other channel of your choice. — 5 operation path(s) and 3 webhook(s) in Infobip's published OpenAPI.
{
"openapi":"3.1.0",
"info":{
"title":"Infobip OpenAPI Specification",
"description":"OpenAPI Specification that contains all public endpoints and webhooks.",
"contact":{
"name":"Infobip support",
"email":"support@infobip.com"
},
"version":"3.210.0",
"x-generatedAt":"2026-07-23T15:23:48.61792705Z"
},
"tags":[
{
"name":"channels",
"description":"Create a perfect customer experience by using the channels your customer already use and love.\n",
"x-type":"category",
"x-displayName":"Channels"
},
{
"name":"omni-failover",
"description":"Send messages over WhatsApp, Viber, Voice, VKontakte, Line and other channels with a failover to SMS or any other channel of your choice.",
"x-type":"product",
"x-displayName":"OMNI Failover"
},
{
"name":"configuration",
"description":"",
"x-type":"section",
"x-displayName":"Configuration"
},
{
"name":"send-omni-message",
"description":"",
"x-type":"section",
"x-displayName":"Send OMNI message"
},
{
"name":"receive-incoming-messages",
"description":"",
"x-type":"section",
"x-displayName":"Receive incoming messages"
}
],
"paths":{
"/omni/1/scenarios":{
"get":{
"tags":[
"channels",
"omni-failover",
"configuration"
],
"summary":"List all OMNI failover scenarios",
"description":"See all failover scenarios that you have created.",
"operationId":"get-omni-failover-scenarios",
"parameters":[
{
"name":"isDefault",
"in":"query",
"description":"Get default scenario.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
},
"example":true
},
{
"name":"limit",
"in":"query",
"description":"Maximal number of scenarios that will be returned, defaults to __100__.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":100,
"minimum":0
}
},
{
"name":"page",
"in":"query",
"description":"Indexed page of scenarios that will be returned, defaults to 0.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse"
},
"examples":{
"Get all scenarios":{
"summary":"Get all scenarios",
"value":{
"scenarios":[
{
"key":"AD9E01A5DC7BEE2C2B828D208182A611",
"name":"Test SMS or Viber",
"flow":[
{
"from":"InfoSMS",
"channel":"SMS"
},
{
"from":"ViberSender",
"channel":"VIBER"
}
],
"default":false
},
{
"key":"F9E67B67F89D2FD78611C910D7D40696",
"name":"New scenario",
"flow":[
{
"from":"TestSender",
"channel":"SMS"
},
{
"from":"3045",
"channel":"VIBER"
}
],
"default":true
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse"
},
"examples":{
"Get all scenarios":{
"summary":"Get all scenarios",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenariosResponse>\n <scenarios>\n <scenario>\n <key>AD9E01A5DC7BEE2C2B828D208182A611</key>\n <name>Test SMS or Viber</name>\n <flow>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n <step>\n <from>ViberSender</from>\n <channel>VIBER</channel>\n </step>\n </flow>\n <default>false</default>\n </scenario>\n <scenario>\n <key>F9E67B67F89D2FD78611C910D7D40696</key>\n <name>New scenario</name>\n <flow>\n <step>\n <from>TestSender</from>\n <channel>SMS</channel>\n </step>\n <step>\n <from>3045</from>\n <channel>VIBER</channel>\n </step>\n </flow>\n <default>true</default>\n </scenario>\n </scenarios>\n</scenariosResponse>\n"
}
}
}
}
},
"400":{
"description":"bad request responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n <requestError>\n <serviceException>\n <messageId>BAD_REQUEST</messageId>\n <text>Bad request</text>\n </serviceException>\n </requestError>\n</ApiException>\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"409":{
"description":"invalid scenario",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"omni-failover:manage"
]
},
"post":{
"tags":[
"channels",
"omni-failover",
"configuration"
],
"summary":"Create new OMNI failover scenario",
"description":"Define which channels, and in which order, would you like to use in your message failover scenario. If the delivery of the message fails for the first channel, we will use the next channel in your scenario, and so on.",
"operationId":"create-omni-failover-scenario",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest"
},
"examples":{
"SMS-EMAIL scenario request":{
"summary":"SMS-EMAIL scenario request",
"value":{
"name":"SMS with e-mail fallback",
"flow":[
{
"from":"Travel agency",
"channel":"SMS"
},
{
"from":"info@travelagency.com",
"channel":"EMAIL"
}
],
"default":false
}
},
"PUSH-SMS scenario request":{
"summary":"PUSH-SMS scenario request",
"value":{
"name":"My PUSH-SMS scenario",
"flow":[
{
"from":"233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53",
"channel":"PUSH"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VIBER-SMS scenario request":{
"summary":"VIBER-SMS scenario request",
"value":{
"name":"My VIBER-SMS scenario",
"flow":[
{
"from":"ViberSender",
"channel":"VIBER"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VK-SMS scenario request":{
"summary":"VK-SMS scenario request",
"value":{
"name":"My VK-SMS scenario",
"flow":[
{
"from":"InfoVK",
"channel":"VKONTAKTE"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"LINE-SMS scenario request":{
"summary":"LINE-SMS scenario request",
"value":{
"name":"My LINE-SMS scenario",
"flow":[
{
"from":"InfoLine",
"channel":"LINE"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"WHATSAPP-SMS scenario request":{
"summary":"WHATSAPP-SMS scenario request",
"value":{
"name":"My WHATSAPP-SMS scenario",
"flow":[
{
"from":"WhatsAppSender",
"channel":"WHATSAPP"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest"
},
"examples":{
"SMS-EMAIL scenario request":{
"summary":"SMS-EMAIL scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>SMS with e-mail fallback</name>\n <flow>\n <step>\n <from>Travel agency</from>\n <channel>SMS</channel>\n </step>\n <step>\n <from>info@travelagency.com</from>\n <channel>EMAIL</channel>\n </step>\n </flow>\n <default>false</default>\n</scenario>\n"
},
"PUSH-SMS scenario request":{
"summary":"PUSH-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My PUSH-SMS scenario</name>\n <flow>\n <step>\n <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n <channel>PUSH</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"VIBER-SMS scenario request":{
"summary":"VIBER-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My VIBER-SMS scenario</name>\n <flow>\n <step>\n <from>ViberSender</from>\n <channel>VIBER</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"VK-SMS scenario request":{
"summary":"VK-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My VK-SMS scenario</name>\n <flow>\n <step>\n <from>InfoVK</from>\n <channel>VKONTAKTE</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"LINE-SMS scenario request":{
"summary":"LINE-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My LINE-SMS scenario</name>\n <flow>\n <step>\n <from>InfoLine</from>\n <channel>LINE</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"WHATSAPP-SMS scenario request":{
"summary":"WHATSAPP-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My WHATSAPP-SMS scenario</name>\n <flow>\n <step>\n <from>WhatsAppSender</from>\n <channel>WHATSAPP</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario"
},
"examples":{
"SMS-EMAIL scenario request":{
"summary":"SMS-EMAIL scenario request",
"value":{
"name":"SMS with e-mail fallback",
"flow":[
{
"from":"Travel agency",
"channel":"SMS"
},
{
"from":"info@travelagency.com",
"channel":"EMAIL"
}
],
"default":false
}
},
"PUSH-SMS scenario request":{
"summary":"PUSH-SMS scenario request",
"value":{
"name":"My PUSH-SMS scenario",
"flow":[
{
"from":"233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53",
"channel":"PUSH"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VIBER-SMS scenario request":{
"summary":"VIBER-SMS scenario request",
"value":{
"name":"My VIBER-SMS scenario",
"flow":[
{
"from":"ViberSender",
"channel":"VIBER"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VK-SMS scenario request":{
"summary":"VK-SMS scenario request",
"value":{
"name":"My VK-SMS scenario",
"flow":[
{
"from":"InfoVK",
"channel":"VKONTAKTE"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"LINE-SMS scenario request":{
"summary":"LINE-SMS scenario request",
"value":{
"name":"My LINE-SMS scenario",
"flow":[
{
"from":"InfoLine",
"channel":"LINE"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"WHATSAPP-SMS scenario request":{
"summary":"WHATSAPP-SMS scenario request",
"value":{
"name":"My WHATSAPP-SMS scenario",
"flow":[
{
"from":"WhatsAppSender",
"channel":"WHATSAPP"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario"
},
"examples":{
"SMS-EMAIL scenario request":{
"summary":"SMS-EMAIL scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>SMS with e-mail fallback</name>\n <flow>\n <step>\n <from>Travel agency</from>\n <channel>SMS</channel>\n </step>\n <step>\n <from>info@travelagency.com</from>\n <channel>EMAIL</channel>\n </step>\n </flow>\n <default>false</default>\n</scenario>\n"
},
"PUSH-SMS scenario request":{
"summary":"PUSH-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My PUSH-SMS scenario</name>\n <flow>\n <step>\n <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n <channel>PUSH</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"VIBER-SMS scenario request":{
"summary":"VIBER-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My VIBER-SMS scenario</name>\n <flow>\n <step>\n <from>ViberSender</from>\n <channel>VIBER</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"VK-SMS scenario request":{
"summary":"VK-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My VK-SMS scenario</name>\n <flow>\n <step>\n <from>InfoVK</from>\n <channel>VKONTAKTE</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"LINE-SMS scenario request":{
"summary":"LINE-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My LINE-SMS scenario</name>\n <flow>\n <step>\n <from>InfoLine</from>\n <channel>LINE</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"WHATSAPP-SMS scenario request":{
"summary":"WHATSAPP-SMS scenario request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <name>My WHATSAPP-SMS scenario</name>\n <flow>\n <step>\n <from>WhatsAppSender</from>\n <channel>WHATSAPP</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
}
}
}
}
},
"400":{
"description":"invalid scenario",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n <requestError>\n <serviceException>\n <messageId>BAD_REQUEST</messageId>\n <text>Bad request</text>\n </serviceException>\n </requestError>\n</ApiException>\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"409":{
"description":"creating scenario is forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"omni-failover:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":20,
"numberOfTimeUnits":10,
"timeUnit":"m"
}
]
}
},
"/omni/1/scenarios/{scenarioKey}":{
"get":{
"tags":[
"channels",
"omni-failover",
"configuration"
],
"summary":"Get specific OMNI failover scenario",
"description":"See configuration of a specific failover scenario.",
"operationId":"get-omni-failover-scenario",
"parameters":[
{
"name":"scenarioKey",
"in":"path",
"description":"Key used to uniquely identify OMNI scenario.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"AD9E01A5DC7BEE2C2B828D208182A611"
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario"
},
"examples":{
"SMS-EMAIL scenario response":{
"summary":"SMS-EMAIL scenario response",
"value":{
"key":"AD9E01A5DC7BEE2C2B828D208182A611",
"name":"SMS with e-mail fallback",
"flow":[
{
"from":"Travel agency",
"channel":"SMS"
},
{
"from":"info@travelagency.com",
"channel":"EMAIL"
}
],
"default":false
}
},
"PUSH-SMS scenario response":{
"summary":"PUSH-SMS scenario response",
"value":{
"key":"F9E67B67F89D2FD78611C910D7D40696",
"name":"My PUSH-SMS scenario",
"flow":[
{
"from":"233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53",
"channel":"PUSH"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VIBER-SMS scenario response":{
"summary":"VIBER-SMS scenario response",
"value":{
"key":"E6829A141B902776020F736D3FBE16A5",
"name":"My VIBER-SMS scenario",
"flow":[
{
"from":"ViberSender",
"channel":"VIBER"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VK-SMS scenario response":{
"summary":"VK-SMS scenario response",
"value":{
"key":"B1D326FE92D0AAA074C512B3C5A71A67",
"name":"My VK-SMS scenario",
"flow":[
{
"from":"InfoVK",
"channel":"VKONTAKTE"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"LINE-SMS scenario response":{
"summary":"LINE-SMS scenario response",
"value":{
"key":"92B7C75248434CAB0977D08990A324A1",
"name":"My LINE-SMS scenario",
"flow":[
{
"from":"InfoLine",
"channel":"LINE"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"WHATSAPP-SMS scenario response":{
"summary":"WHATSAPP-SMS scenario response",
"value":{
"key":"48F081B992190D591A44B54F7AE2D843",
"name":"My WHATSAPP-SMS scenario",
"flow":[
{
"from":"WhatsAppSender",
"channel":"WHATSAPP"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario"
},
"examples":{
"SMS-EMAIL scenario response":{
"summary":"SMS-EMAIL scenario response",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <key>AD9E01A5DC7BEE2C2B828D208182A611</key>\n <name>SMS with e-mail fallback</name>\n <flow>\n <step>\n <from>Travel agency</from>\n <channel>SMS</channel>\n </step>\n <step>\n <from>info@travelagency.com</from>\n <channel>EMAIL</channel>\n </step>\n </flow>\n <default>false</default>\n</scenario>\n"
},
"PUSH-SMS scenario response":{
"summary":"PUSH-SMS scenario response",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <key>F9E67B67F89D2FD78611C910D7D40696</key>\n <name>My PUSH-SMS scenario</name>\n <flow>\n <step>\n <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n <channel>PUSH</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"VIBER-SMS scenario response":{
"summary":"VIBER-SMS scenario response",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <key>E6829A141B902776020F736D3FBE16A5</key>\n <name>My VIBER-SMS scenario</name>\n <flow>\n <step>\n <from>ViberSender</from>\n <channel>VIBER</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"VK-SMS scenario response":{
"summary":"VK-SMS scenario response",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <key>B1D326FE92D0AAA074C512B3C5A71A67</key>\n <name>My VK-SMS scenario</name>\n <flow>\n <step>\n <from>InfoVK</from>\n <channel>VKONTAKTE</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"LINE-SMS scenario response":{
"summary":"LINE-SMS scenario response",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <key>92B7C75248434CAB0977D08990A324A1</key>\n <name>My LINE-SMS scenario</name>\n <flow>\n <step>\n <from>InfoLine</from>\n <channel>LINE</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
},
"WHATSAPP-SMS scenario response":{
"summary":"WHATSAPP-SMS scenario response",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n <key>48F081B992190D591A44B54F7AE2D843</key>\n <name>My WHATSAPP-SMS scenario</name>\n <flow>\n <step>\n <from>WhatsAppSender</from>\n <channel>WHATSAPP</channel>\n </step>\n <step>\n <from>InfoSMS</from>\n <channel>SMS</channel>\n </step>\n </flow>\n <default>true</default>\n</scenario>\n"
}
}
}
}
},
"400":{
"description":"bad request responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n <requestError>\n <serviceException>\n <messageId>BAD_REQUEST</messageId>\n <text>Bad request</text>\n </serviceException>\n </requestError>\n</ApiException>\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"scenario not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
}
}
},
"409":{
"description":"invalid scenario",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException"
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"omni-failover:manage"
]
},
"put":{
"tags":[
"channels",
"omni-failover",
"configuration"
],
"summary":"Update OMNI failover scenario",
"description":"Change configuration of a specific failover scenario.",
"operationId":"update-omni-failover-scenario",
"parameters":[
{
"name":"scenarioKey",
"in":"path",
"description":"Key used to uniquely identify OMNI scenario.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"CD265875E3A6EA43478D5F37A635BE4A"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest"
},
"examples":{
"SMS-EMAIL scenario request":{
"summary":"SMS-EMAIL scenario request",
"value":{
"name":"SMS with e-mail fallback",
"flow":[
{
"from":"Travel agency",
"channel":"SMS"
},
{
"from":"info@travelagency.com",
"channel":"EMAIL"
}
],
"default":false
}
},
"PUSH-SMS scenario request":{
"summary":"PUSH-SMS scenario request",
"value":{
"name":"My PUSH-SMS scenario",
"flow":[
{
"from":"233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53",
"channel":"PUSH"
},
{
"from":"InfoSMS",
"channel":"SMS"
}
],
"default":true
}
},
"VIBER-SMS scenario request":{
"summary":"VIBER-SMS scenario request",
"value":{
"name":"My VIBER-SMS scenario",
"flow":[
{
"from":"ViberSender",
"channel":"VIBER"
},
# --- truncated at 32 KB (276 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-omni-failover-openapi.json