{ "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":"\n \n \n AD9E01A5DC7BEE2C2B828D208182A611\n Test SMS or Viber\n \n \n InfoSMS\n SMS\n \n \n ViberSender\n VIBER\n \n \n false\n \n \n F9E67B67F89D2FD78611C910D7D40696\n New scenario\n \n \n TestSender\n SMS\n \n \n 3045\n VIBER\n \n \n true\n \n \n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\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":"\n SMS with e-mail fallback\n \n \n Travel agency\n SMS\n \n \n info@travelagency.com\n EMAIL\n \n \n false\n\n" }, "PUSH-SMS scenario request":{ "summary":"PUSH-SMS scenario request", "value":"\n My PUSH-SMS scenario\n \n \n 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53\n PUSH\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VIBER-SMS scenario request":{ "summary":"VIBER-SMS scenario request", "value":"\n My VIBER-SMS scenario\n \n \n ViberSender\n VIBER\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VK-SMS scenario request":{ "summary":"VK-SMS scenario request", "value":"\n My VK-SMS scenario\n \n \n InfoVK\n VKONTAKTE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "LINE-SMS scenario request":{ "summary":"LINE-SMS scenario request", "value":"\n My LINE-SMS scenario\n \n \n InfoLine\n LINE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "WHATSAPP-SMS scenario request":{ "summary":"WHATSAPP-SMS scenario request", "value":"\n My WHATSAPP-SMS scenario\n \n \n WhatsAppSender\n WHATSAPP\n \n \n InfoSMS\n SMS\n \n \n true\n\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":"\n SMS with e-mail fallback\n \n \n Travel agency\n SMS\n \n \n info@travelagency.com\n EMAIL\n \n \n false\n\n" }, "PUSH-SMS scenario request":{ "summary":"PUSH-SMS scenario request", "value":"\n My PUSH-SMS scenario\n \n \n 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53\n PUSH\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VIBER-SMS scenario request":{ "summary":"VIBER-SMS scenario request", "value":"\n My VIBER-SMS scenario\n \n \n ViberSender\n VIBER\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VK-SMS scenario request":{ "summary":"VK-SMS scenario request", "value":"\n My VK-SMS scenario\n \n \n InfoVK\n VKONTAKTE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "LINE-SMS scenario request":{ "summary":"LINE-SMS scenario request", "value":"\n My LINE-SMS scenario\n \n \n InfoLine\n LINE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "WHATSAPP-SMS scenario request":{ "summary":"WHATSAPP-SMS scenario request", "value":"\n My WHATSAPP-SMS scenario\n \n \n WhatsAppSender\n WHATSAPP\n \n \n InfoSMS\n SMS\n \n \n true\n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\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":"\n AD9E01A5DC7BEE2C2B828D208182A611\n SMS with e-mail fallback\n \n \n Travel agency\n SMS\n \n \n info@travelagency.com\n EMAIL\n \n \n false\n\n" }, "PUSH-SMS scenario response":{ "summary":"PUSH-SMS scenario response", "value":"\n F9E67B67F89D2FD78611C910D7D40696\n My PUSH-SMS scenario\n \n \n 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53\n PUSH\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VIBER-SMS scenario response":{ "summary":"VIBER-SMS scenario response", "value":"\n E6829A141B902776020F736D3FBE16A5\n My VIBER-SMS scenario\n \n \n ViberSender\n VIBER\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VK-SMS scenario response":{ "summary":"VK-SMS scenario response", "value":"\n B1D326FE92D0AAA074C512B3C5A71A67\n My VK-SMS scenario\n \n \n InfoVK\n VKONTAKTE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "LINE-SMS scenario response":{ "summary":"LINE-SMS scenario response", "value":"\n 92B7C75248434CAB0977D08990A324A1\n My LINE-SMS scenario\n \n \n InfoLine\n LINE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "WHATSAPP-SMS scenario response":{ "summary":"WHATSAPP-SMS scenario response", "value":"\n 48F081B992190D591A44B54F7AE2D843\n My WHATSAPP-SMS scenario\n \n \n WhatsAppSender\n WHATSAPP\n \n \n InfoSMS\n SMS\n \n \n true\n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\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" }, { "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":"\n SMS with e-mail fallback\n \n \n Travel agency\n SMS\n \n \n info@travelagency.com\n EMAIL\n \n \n false\n\n" }, "PUSH-SMS scenario request":{ "summary":"PUSH-SMS scenario request", "value":"\n My PUSH-SMS scenario\n \n \n 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53\n PUSH\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VIBER-SMS scenario request":{ "summary":"VIBER-SMS scenario request", "value":"\n My VIBER-SMS scenario\n \n \n ViberSender\n VIBER\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VK-SMS scenario request":{ "summary":"VK-SMS scenario request", "value":"\n My VK-SMS scenario\n \n \n InfoVK\n VKONTAKTE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "LINE-SMS scenario request":{ "summary":"LINE-SMS scenario request", "value":"\n My LINE-SMS scenario\n \n \n InfoLine\n LINE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "WHATSAPP-SMS scenario request":{ "summary":"WHATSAPP-SMS scenario request", "value":"\n My WHATSAPP-SMS scenario\n \n \n WhatsAppSender\n WHATSAPP\n \n \n InfoSMS\n SMS\n \n \n true\n\n" } } } }, "required":true }, "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":"\n AD9E01A5DC7BEE2C2B828D208182A611\n SMS with e-mail fallback\n \n \n Travel agency\n SMS\n \n \n info@travelagency.com\n EMAIL\n \n \n false\n\n" }, "PUSH-SMS scenario response":{ "summary":"PUSH-SMS scenario response", "value":"\n F9E67B67F89D2FD78611C910D7D40696\n My PUSH-SMS scenario\n \n \n 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53\n PUSH\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VIBER-SMS scenario response":{ "summary":"VIBER-SMS scenario response", "value":"\n E6829A141B902776020F736D3FBE16A5\n My VIBER-SMS scenario\n \n \n ViberSender\n VIBER\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "VK-SMS scenario response":{ "summary":"VK-SMS scenario response", "value":"\n B1D326FE92D0AAA074C512B3C5A71A67\n My VK-SMS scenario\n \n \n InfoVK\n VKONTAKTE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "LINE-SMS scenario response":{ "summary":"LINE-SMS scenario response", "value":"\n 92B7C75248434CAB0977D08990A324A1\n My LINE-SMS scenario\n \n \n InfoLine\n LINE\n \n \n InfoSMS\n SMS\n \n \n true\n\n" }, "WHATSAPP-SMS scenario response":{ "summary":"WHATSAPP-SMS scenario response", "value":"\n 48F081B992190D591A44B54F7AE2D843\n My WHATSAPP-SMS scenario\n \n \n WhatsAppSender\n WHATSAPP\n \n \n InfoSMS\n SMS\n \n \n true\n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\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" } } } }, "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":40, "numberOfTimeUnits":10, "timeUnit":"m" } ] } }, "/omni/1/advanced":{ "post":{ "tags":[ "channels", "omni-failover", "send-omni-message" ], "summary":"Send OMNI failover message", "description":"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.", "operationId":"send-omni-failover-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest" }, "examples":{ "Send OMNI advanced message":{ "summary":"Send OMNI advanced message", "value":{ "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611", "bulkId":"BULK-ID-123-xyz", "destinations":[ { "messageId":"MESSAGE-ID-123-xyz", "to":{ "phoneNumber":"41793026727", "emailAddress":"email@example.com" } }, { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.", "transliteration":"TURKISH", "language":{ "languageCode":"TR" } }, "viber":{ "text":"Or to have fun with Viber text." }, "voice":{ "text":"Or make a call and read this text" }, "email":{ "text":"Finally, send an email.", "subject":"Email subject" } } }, "Send a scheduled OMNI message with a custom Validity period":{ "summary":"Send a scheduled OMNI message with a custom Validity period", "value":{ "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611", "destinations":[ { "messageId":"MESSAGE-ID-123-xyz", "to":{ "phoneNumber":"41793026727", "emailAddress":"email@example.com" } } ], "sms":{ "text":"After one minute I'm trying to reach the user on SMS", "validityPeriod":90, "validityPeriodTimeUnit":"SECONDS" }, "viber":{ "text":"Viber message is going first.", "validityPeriod":1 }, "email":{ "text":"Two and a half minutes (1 minute + 90 seconds) after the initial message I'm trying to reach the user on email for the next two hours.", "validityPeriod":2, "validityPeriodTimeUnit":"HOURS", "subject":"Hey - turn on your mobile phone!" }, "sendAt":"2021-05-24T10:45:38.000+0000" } }, "Send OMNI PUSH-SMS message":{ "summary":"Send OMNI PUSH-SMS message", "value":{ "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This is the SMS failover message" }, "push":{ "text":"This PUSH message will pop up on your mobile device." } } }, "Send OMNI PUSH message with a custom payload":{ "summary":"Send OMNI PUSH message with a custom payload", "value":{ "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This is the SMS failover message" }, "push":{ "text":"This PUSH message will pop up on your mobile device.", "customPayload":{ "contentUrl":"https://someurl.com/content", "deepLink":"myApp://some/link" } } } }, "Send OMNI PUSH message with notification options":{ "summary":"Send OMNI PUSH message with notification options", "value":{ "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This is the SMS failover message" }, "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", "webViewUrl":"http://someurl.com" }, "targetOnlyPrimaryDevices":true, "includeNotificationsDisabledDevices":true, "personSubscriptions":[ "receiveMarketingInfo" ], "deviceSubscriptions":[ "transactionFinished" ] } } }, "Send OMNI SMS-EMAIL message":{ "summary":"Send OMNI SMS-EMAIL message", "value":{ "scenarioKey":"AD9E01A5DC7BEE2C2B828D208182A611", "destinations":[ { "to":{ "phoneNumber":"385974241491", "emailAddress":"john.smith@gmail.com" } }, { "to":{ "phoneNumber":"38597213556611111", "emailAddress":"jane.smith@gmail.com" } } ], "sms":{ "text":"Hello, we are happy to confirm your reservation for the safari trip.", "validityPeriod":1 }, "email":{ "text":"Hello, we are happy to confirm your reservation for the safari trip.", "subject":"Reservation confirmed!" } } }, "Send OMNI VIBER-SMS message":{ "summary":"Send OMNI VIBER-SMS message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This is the SMS failover message" }, "viber":{ "text":"This Viber message will be delivered to Viber application on the user device." } } }, "Send Rich Viber message":{ "summary":"Send Rich Viber message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received via SMS if Viber message is not delivered.", "validityPeriod":1 }, "viber":{ "text":"This Viber message will be delivered to Viber application on the user device.", "validityPeriod":1, "imageURL":"http://www.infobip.com/infobip-logo.png", "buttonText":"More information", "buttonURL":"http://www.infobip.com/", "isPromotional":false } } }, "Send OMNI WHATSAPP-SMS message":{ "summary":"Send OMNI WHATSAPP-SMS message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This is the SMS failover message" }, "whatsApp":{ "text":"This Whatsapp message will be delivered to WhatsApp application on the user device." } } }, "Send WhatsApp template message":{ "summary":"Send WhatsApp template message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "templateName":"template_name", "templateData":[ "Jennifer", "$2543.56" ], "language":"en" } } }, "Send WhatsApp media template message":{ "summary":"Send WhatsApp media template message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "templateName":"media_template_name", "mediaTemplateData":{ "header":{ "imageUrl":"https://www.example.com/image.png" }, "body":{ "placeholders":[ "Jennifer", "$2543.56" ] } }, "language":"en" } } }, "Send WhatsApp media template message with quick reply buttons":{ "summary":"Send WhatsApp media template message with quick reply buttons", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "templateName":"media_template_name", "mediaTemplateData":{ "header":{ "imageUrl":"https://www.infobip.com/infobip-logo.png" }, "body":{ "placeholders":[ "Jennifer", "$2543.56" ] }, "buttons":[ { "quickReplyPayload":"button1" }, { "quickReplyPayload":"button2" }, { "quickReplyPayload":"button3" } ] }, "language":"en" } } }, "Send WhatsApp media template message with action button":{ "summary":"Send WhatsApp media template message with action button", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "templateName":"media_template_name", "mediaTemplateData":{ "header":{ "imageUrl":"https://www.infobip.com/infobip-logo.png" }, "body":{ "placeholders":[ "Jennifer", "$2543.56" ] }, "buttons":[ { "urlPlaceholder":"example1.pdf" } ] }, "language":"en" } } }, "Send WhatsApp text free form message":{ "summary":"Send WhatsApp text free form message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "text":"This WhatsApp message will be delivered to WhatsApp application on the user device." } } }, "Send WhatsApp Image message":{ "summary":"Send WhatsApp Image message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "text":"Get your message across!", "imageUrl":"https://www.example.com/image.png" } } }, "Send WhatsApp Audio message":{ "summary":"Send WhatsApp Audio message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "audioUrl":"https://www.example.com/audio.ogg" } } }, "Send WhatsApp Video message":{ "summary":"Send WhatsApp Video message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "text":"Get your message across!", "videoUrl":"https://www.example.com/video.mp4" } } }, "Send WhatsApp Document message":{ "summary":"Send WhatsApp Document message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "text":"File caption", "fileUrl":"https://www.example.com/document.pdf" } } }, "Send WhatsApp Location message":{ "summary":"Send WhatsApp Location message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "locationName":"Name of the location", "address":"Address name", "longitude":15.946519, "latitude":45.793337 } } }, "Send WhatsApp Contact message":{ "summary":"Send WhatsApp Contact message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "whatsApp":{ "contacts":[ { "addresses":[ { "street":"Zadarska", "city":"Zagreb", "zip":"1111", "country":"Croatia", "countryCode":"1111", "type":"WORK" } ], "birthday":"2016-01-01", "emails":[ { "email":"infobip@infobip.com", "type":"WORK" } ], "name":{ "firstName":"First Name", "lastName":"Last Name", "formattedName":"Formatted Name" }, "org":{ "company":"Infobip" }, "phones":[ { "phone":"41793026727", "type":"WORK", "waId":"1111" } ], "urls":[ { "url":"https://dev.infobip.com/omni-channel/omni-whatsapp-example", "type":"WORK" } ] } ] } } }, "Send OMNI LINE-SMS message":{ "summary":"Send OMNI LINE-SMS message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Line communication channel message is not delivered." }, "line":{ "text":"This Line message will be delivered to Line application on the user device.", "type":"TEXT" } } }, "Send Line Image message":{ "summary":"Send Line Image message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Line communication channel message is not delivered." }, "line":{ "type":"IMAGE", "url":"http://www.infobip.com/infobip-logo.png", "thumbnailUrl":"http://www.infobip.com/infobip-logo.png" } } }, "Send Line Audio message":{ "summary":"Send Line Audio message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Line communication channel message is not delivered." }, "line":{ "type":"AUDIO", "url":"https://www.audioUrl.com", "duration":4000 } } }, "Send Line Video message":{ "summary":"Send Line Video message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Line communication channel message is not delivered." }, "line":{ "type":"VIDEO", "url":"https://www.videoUrl.com", "thumbnailUrl":"https://www.thumbnailUrl.com" } } }, "Send Line Sticker message":{ "summary":"Send Line Sticker message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Line communication channel message is not delivered." }, "line":{ "type":"STICKER", "packageId":"1", "stickerId":"1" } } }, "Send Kakao AlimTalk text message":{ "summary":"Send Kakao AlimTalk text message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Kakao AlimTalk communication channel message is not delivered." }, "kakaoAlim":{ "text":"Get your message across!", "templateCode":"templateCode", "title":"Optional title of the message" } } }, "Send Kakao AlimTalk buttons message":{ "summary":"Send Kakao AlimTalk buttons message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Kakao AlimTalk communication channel message is not delivered." }, "kakaoAlim":{ "text":"Get your message across!", "templateCode":"templateCode", "buttons":[ { "buttonText":"URL Button", "buttonUrlMobile":"https://www.infobip.com", "buttonUrlPc":"https://www.infobip.com", "type":"URL" }, { "buttonText":"App Link Button", "androidScheme":"androidApp://open", "iosScheme":"iosApp://open", "buttonUrlMobile":"https://www.infobip.com", "buttonUrlPc":"https://www.infobip.com", "type":"APP_LINK" } ] } } }, "Send Kakao ChinguTalk text message":{ "summary":"Send Kakao ChinguTalk text message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Kakao ChinguTalk communication channel message is not delivered." }, "kakaoChingu":{ "text":"Get your message across!" } } }, "Send Kakao ChinguTalk image message":{ "summary":"Send Kakao ChinguTalk image message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Kakao ChinguTalk communication channel message is not delivered." }, "kakaoChingu":{ "text":"Get your message across!", "imageUrl":"https://www.example.com/image.png" } } }, "Send Kakao ChinguTalk buttons message":{ "summary":"Send Kakao ChinguTalk buttons message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This text will be received if Kakao ChinguTalk communication channel message is not delivered." }, "kakaoChingu":{ "text":"Get your message across!", "buttons":[ { "buttonText":"URL Button", "buttonUrl":"https://www.infobip.com", "type":"URL" }, { "buttonText":"App Link Button", "androidScheme":"androidApp://open", "iosScheme":"iosApp://open", "type":"APP_LINK" }, { "buttonText":"Message Delivery Button", "type":"MESSAGE_DELIVERY" }, { "buttonText":"Bot Keyword Button", "type":"BOT_KEYWORD" } ] } } }, "Send OMNI VKONTAKTE-SMS message":{ "summary":"Send OMNI VKONTAKTE-SMS message", "value":{ "scenarioKey":"CC9F01A5DC7BEE2C2B829D203482A654", "destinations":[ { "to":{ "phoneNumber":"41793026731" } } ], "sms":{ "text":"This is the SMS failover message" }, "vKontakte":{ "templateName":"InfoVK_template", "templateData":{ "parameter1":"param1Value", "parameter2":"param2Value" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest" }, "examples":{ "Send OMNI advanced message":{ "summary":"Send OMNI advanced message", "value":"\n AD9E01A5DC7BEE2C2B828D208182A611\n BULK-ID-123-xyz\n \n \n MESSAGE-ID-123-xyz\n \n 41793026727\n email@example.com\n \n \n \n \n 41793026731\n \n \n \n \n Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.\n TURKISH\n \n TR\n \n \n \n Or to have fun with Viber text.\n \n \n Or make a call and read this text\n \n \n Finally, send an email.\n Email subject\n \n\n" }, "Send a scheduled OMNI message with a custom Validity period":{ "summary":"Send a scheduled OMNI message with a custom Validity period", "value":"\n AD9E01A5DC7BEE2C2B828D208182A611\n \n \n MESSAGE-ID-123-xyz\n \n 41793026727\n email@example.com\n \n \n \n \n After one minute I'm trying to reach the user on SMS\n 90\n SECONDS\n \n \n Viber message is going first.\n 1\n \n \n Two and a half minutes (1 minute + 90 seconds) after the initial message I'm trying to reach the user on email for the next two hours.\n 2\n HOURS\n Hey - turn on your mobile phone!\n \n 2021-05-24T10:45:38.000+0000\n\n" }, "Send OMNI PUSH-SMS message":{ "summary":"Send OMNI PUSH-SMS message", "value":"\n AD9E01A5DC7BEE2C2B828D208182A611\n \n \n \n 41793026731\n \n \n \n \n This is the SMS failover message\n \n \n This PUSH message will pop up on your mobile device.\n \n\n" }, "Send OMNI PUSH message with a custom payload":{ "summary":"Send OMNI PUSH message with a custom payload", "value":"\n AD9E01A5DC7BEE2C2B828D208182A611\n \n \n \n 41793026731\n \n \n \n \n This is the SMS failover message\n \n \n This PUSH message will pop up on your mobile device.\n \n https://someurl.com/content\n myApp://some/link\n \n \n\n" }, "Send OMNI PUSH message with notification options":{ "summary":"Send OMNI PUSH message with notification options", "value":"\n AD9E01A5DC7BEE2C2B828D208182A611\n \n \n \n 41793026731\n \n \n \n \n This is the SMS failover message\n \n \n This PUSH message will pop up on your mobile device.\n \n https://someurl.com/content\n myApp://some/link\n \n \n true\n true\n sound.wav\n 1\n http://www.mydomain.com/images/image1.jpg\n mm_accept_decline\n MODAL\n This is some title\n http://someurl.com\n \n true\n true\n \n receiveMarketingInfo\n \n \n transactionFinished\n \n \n\n" }, "Send OMNI SMS-EMAIL message":{ "summary":"Send OMNI SMS-EMAIL message", "value":"\n AD9E01A5DC7BEE2C2B828D208182A611\n \n \n \n 385974241491\n john.smith@gmail.com\n \n \n \n \n 38597213556611111\n jane.smith@gmail.com\n \n \n \n \n Hello, we are happy to confirm your reservation for the safari trip.\n 1\n \n \n Hello, we are happy to confirm your reservation for the safari trip.\n Reservation confirmed!\n \n\n" }, "Send OMNI VIBER-SMS message":{ "summary":"Send OMNI VIBER-SMS message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This is the SMS failover message\n \n \n This Viber message will be delivered to Viber application on the user device.\n \n\n" }, "Send Rich Viber message":{ "summary":"Send Rich Viber message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received via SMS if Viber message is not delivered.\n 1\n \n \n This Viber message will be delivered to Viber application on the user device.\n 1\n http://www.infobip.com/infobip-logo.png\n More information\n http://www.infobip.com/\n false\n \n\n" }, "Send OMNI WHATSAPP-SMS message":{ "summary":"Send OMNI WHATSAPP-SMS message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This is the SMS failover message\n \n \n This Whatsapp message will be delivered to WhatsApp application on the user device.\n \n\n" }, "Send WhatsApp template message":{ "summary":"Send WhatsApp template message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n template_name\n \n Jennifer\n $2543.56\n \n en\n \n\n" }, "Send WhatsApp media template message":{ "summary":"Send WhatsApp media template message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n media_template_name\n \n
\n https://www.example.com/image.png\n
\n \n \n Jennifer\n $2543.56\n \n \n \n en\n \n\n" }, "Send WhatsApp media template message with quick reply buttons":{ "summary":"Send WhatsApp media template message with quick reply buttons", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n media_template_name\n \n
\n https://www.infobip.com/infobip-logo.png\n
\n \n \n Jennifer\n $2543.56\n \n \n \n \n button1\n \n \n button2\n \n \n button3\n \n \n \n en\n \n\n" }, "Send WhatsApp media template message with action button":{ "summary":"Send WhatsApp media template message with action button", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n media_template_name\n \n
\n https://www.infobip.com/infobip-logo.png\n
\n \n \n Jennifer\n $2543.56\n \n \n \n \n example1.pdf\n \n \n \n en\n \n\n" }, "Send WhatsApp text free form message":{ "summary":"Send WhatsApp text free form message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This WhatsApp message will be delivered to WhatsApp application on the user device.\n \n\n" }, "Send WhatsApp Image message":{ "summary":"Send WhatsApp Image message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n Get your message across!\n https://www.example.com/image.png\n \n\n" }, "Send WhatsApp Audio message":{ "summary":"Send WhatsApp Audio message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n https://www.example.com/audio.ogg\n \n\n" }, "Send WhatsApp Video message":{ "summary":"Send WhatsApp Video message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n Get your message across!\n https://www.example.com/video.mp4\n \n\n" }, "Send WhatsApp Document message":{ "summary":"Send WhatsApp Document message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n File caption\n https://www.example.com/document.pdf\n \n\n" }, "Send WhatsApp Location message":{ "summary":"Send WhatsApp Location message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n Name of the location\n
Address name
\n 15.946519\n 45.793337\n \n\n" }, "Send WhatsApp Contact message":{ "summary":"Send WhatsApp Contact message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n \n \n \n \n Zadarska\n Zagreb\n 1111\n Croatia\n 1111\n WORK\n \n \n 2016-01-01\n \n \n infobip@infobip.com\n WORK\n \n \n \n First Name\n Last Name\n Formatted Name\n \n \n Infobip\n \n \n \n 41793026727\n WORK\n 1111\n \n \n \n \n https://dev.infobip.com/omni-channel/omni-whatsapp-example\n WORK\n \n \n \n \n \n\n" }, "Send OMNI LINE-SMS message":{ "summary":"Send OMNI LINE-SMS message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Line communication channel message is not delivered.\n \n \n This Line message will be delivered to Line application on the user device.\n TEXT\n \n\n" }, "Send Line Image message":{ "summary":"Send Line Image message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Line communication channel message is not delivered.\n \n \n IMAGE\n http://www.infobip.com/infobip-logo.png\n http://www.infobip.com/infobip-logo.png\n \n\n" }, "Send Line Audio message":{ "summary":"Send Line Audio message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Line communication channel message is not delivered.\n \n \n AUDIO\n https://www.audioUrl.com\n 4000\n \n\n" }, "Send Line Video message":{ "summary":"Send Line Video message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Line communication channel message is not delivered.\n \n \n VIDEO\n https://www.videoUrl.com\n https://www.thumbnailUrl.com\n \n\n" }, "Send Line Sticker message":{ "summary":"Send Line Sticker message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Line communication channel message is not delivered.\n \n \n STICKER\n 1\n 1\n \n\n" }, "Send Kakao AlimTalk text message":{ "summary":"Send Kakao AlimTalk text message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Kakao AlimTalk communication channel message is not delivered.\n \n \n Get your message across!\n templateCode\n Optional title of the message\n \n\n" }, "Send Kakao AlimTalk buttons message":{ "summary":"Send Kakao AlimTalk buttons message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Kakao AlimTalk communication channel message is not delivered.\n \n \n Get your message across!\n templateCode\n \n \n URL Button\n https://www.infobip.com\n https://www.infobip.com\n \n \n App Link Button\n androidApp://open\n iosApp://open\n https://www.infobip.com\n https://www.infobip.com\n \n \n \n\n" }, "Send Kakao ChinguTalk text message":{ "summary":"Send Kakao ChinguTalk text message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Kakao ChinguTalk communication channel message is not delivered.\n \n \n Get your message across!\n \n\n" }, "Send Kakao ChinguTalk image message":{ "summary":"Send Kakao ChinguTalk image message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Kakao ChinguTalk communication channel message is not delivered.\n \n \n Get your message across!\n https://www.example.com/image.png\n \n\n" }, "Send Kakao ChinguTalk buttons message":{ "summary":"Send Kakao ChinguTalk buttons message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This text will be received if Kakao ChinguTalk communication channel message is not delivered.\n \n \n Get your message across!\n \n \n URL Button\n https://www.infobip.com\n \n \n App Link Button\n androidApp://open\n iosApp://open\n \n \n Message Delivery Button\n \n \n Bot Keyword Button\n \n \n \n\n" }, "Send OMNI VKONTAKTE-SMS message":{ "summary":"Send OMNI VKONTAKTE-SMS message", "value":"\n CC9F01A5DC7BEE2C2B829D203482A654\n \n \n \n 41793026731\n \n \n \n \n This is the SMS failover message\n \n \n InfoVK_template\n \n param2Value\n param1Value\n \n \n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse" }, "examples":{ "Response example for one destination":{ "summary":"Response example for one destination", "value":{ "messages":[ { "to":{ "phoneNumber":"41793026727", "emailAddress":"email@example.com" }, "status":{ "groupId":1, "groupName":"PENDING", "id":7, "name":"PENDING_ENROUTE", "description":"Message sent to next instance" }, "messageId":"efcd006b-af37-40e1-9984-09735bf45f17" } ] } }, "Response example for multiple destinations":{ "summary":"Response example for multiple destinations", "value":{ "bulkId":"Bulk-ID-12xyz", "messages":[ { "to":{ "phoneNumber":"41793026727", "emailAddress":"email@example.com" }, "status":{ "groupId":1, "groupName":"PENDING", "id":7, "name":"PENDING_ENROUTE", "description":"Message sent to next instance" }, "messageId":"MESSAGE-ID-123-xyz" }, { "to":{ "phoneNumber":"41793026731" }, "status":{ "groupId":1, "groupName":"PENDING", "id":7, "name":"PENDING_ENROUTE", "description":"Message sent to next instance" }, "messageId":"4adbe74a-a600-47b3-9f2e-e410d3224843" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse" }, "examples":{ "Response example for one destination":{ "summary":"Response example for one destination", "value":"\n \n \n \n 41793026727\n email@example.com\n \n \n 1\n PENDING\n 7\n PENDING_ENROUTE\n Message sent to next instance\n \n efcd006b-af37-40e1-9984-09735bf45f17\n \n \n\n" }, "Response example for multiple destinations":{ "summary":"Response example for multiple destinations", "value":"\n Bulk-ID-12xyz\n \n \n \n 41793026727\n email@example.com\n \n \n 1\n PENDING\n 7\n PENDING_ENROUTE\n Message sent to next instance\n \n MESSAGE-ID-123-xyz\n \n \n \n 41793026731\n \n \n 1\n PENDING\n 7\n PENDING_ENROUTE\n Message sent to next instance\n \n 4adbe74a-a600-47b3-9f2e-e410d3224843\n \n \n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "omni-failover:message:send", "omni-failover:manage" ] } }, "/omni/1/reports":{ "get":{ "tags":[ "channels", "omni-failover", "send-omni-message" ], "summary":"Get OMNI failover delivery reports", "description":"Get one-time delivery reports to see which channel was used to deliver the failover message.", "operationId":"get-omni-failover-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the message sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximal number of messages in returned reports. Default value is __50__ and maximal value is __1000__.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 }, "example":1 }, { "name":"channel", "in":"query", "description":"Channel that was used for message delivering.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel" }, "example":"PUSH" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports" }, "examples":{ "Getting reports without any query parameter":{ "summary":"Getting reports without any query parameter", "value":{ "results":[ { "bulkId":"bafdeb3d-719b-4cce-8762-54d47b40f3c5", "messageId":"07e03aae-fabc-44ad-b1ce-222e14094d70", "to":"41793026727", "sentAt":"2015-02-23T16:41:11.833+0000", "doneAt":"2015-02-23T16:41:11.843+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0.0104, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "channel":"VIBER" }, { "bulkId":"06479ba3-5977-47f6-9346-fee0369bc76b", "messageId":"1f21d8d7-f306-4f53-9f6e-eddfce9849ea", "to":"41793026727", "sentAt":"2015-02-23T16:40:31.773+0000", "doneAt":"2015-02-23T16:40:31.787+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0.01, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "channel":"SMS" } ] } }, "Getting reports with PUSH channel as filter":{ "summary":"Getting reports with PUSH channel as filter", "value":{ "results":[ { "bulkId":"bafdeb3d-719b-4cce-8762-54d47b40f3c5", "messageId":"07e03aae-fabc-44ad-b1ce-222e14094d70", "to":"41793026727", "sentAt":"2015-02-23T16:41:11.833+0000", "doneAt":"2015-02-23T16:41:11.843+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "channel":"PUSH" }, { "bulkId":"1dece649-6c8f-404e-8c6e-c7e073be509a", "messageId":"faa48fe6-fe2c-4f36-a43b-a070e2906ecb", "to":"41793026727", "sentAt":"2015-02-23T15:22:37.413+0000", "doneAt":"2015-02-23T15:22:37.437+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0, "currency":"EUR" }, "status":{ "groupId":2, "groupName":"UNDELIVERABLE", "id":9, "name":"UNDELIVERABLE_NOT_DELIVERED", "description":"Message sent not delivered" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "channel":"PUSH" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports" }, "examples":{ "Getting reports without any query parameter":{ "summary":"Getting reports without any query parameter", "value":"\n \n \n bafdeb3d-719b-4cce-8762-54d47b40f3c5\n 07e03aae-fabc-44ad-b1ce-222e14094d70\n 41793026727\n 2015-02-23T16:41:11.833+0000\n 2015-02-23T16:41:11.843+0000\n 1\n 22801\n \n 0.0104\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n VIBER\n \n \n 06479ba3-5977-47f6-9346-fee0369bc76b\n 1f21d8d7-f306-4f53-9f6e-eddfce9849ea\n 41793026727\n 2015-02-23T16:40:31.773+0000\n 2015-02-23T16:40:31.787+0000\n 1\n 22801\n \n 0.01\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n SMS\n \n \n\n" }, "Getting reports with PUSH channel as filter":{ "summary":"Getting reports with PUSH channel as filter", "value":"\n \n \n bafdeb3d-719b-4cce-8762-54d47b40f3c5\n 07e03aae-fabc-44ad-b1ce-222e14094d70\n 41793026727\n 2015-02-23T16:41:11.833+0000\n 2015-02-23T16:41:11.843+0000\n 1\n 22801\n \n 0\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n PUSH\n \n \n 1dece649-6c8f-404e-8c6e-c7e073be509a\n faa48fe6-fe2c-4f36-a43b-a070e2906ecb\n 41793026727\n 2015-02-23T15:22:37.413+0000\n 2015-02-23T15:22:37.437+0000\n 1\n 22801\n \n 0\n EUR\n \n \n 2\n UNDELIVERABLE\n 9\n UNDELIVERABLE_NOT_DELIVERED\n Message sent not delivered\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n PUSH\n \n \n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "omni-failover:message:send", "omni-failover:manage" ] } }, "/omni/1/logs":{ "get":{ "tags":[ "channels", "omni-failover", "send-omni-message" ], "summary":"Get OMNI failover message logs", "description":"If you need to show message logs in some GUI use this method. For message delivery status use [OMNI failover delivery reports](#programmable-communications/omni-failover/get-omni-failover-delivery-reports).", "operationId":"get-omni-failover-message-logs", "parameters":[ { "name":"from", "in":"query", "description":"Sender that can be alphanumeric or numeric.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"DemoViberApp" }, { "name":"to", "in":"query", "description":"The message destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":41793026727 }, { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"1dece649-6c8f-404e-8c6e-c7e073be509a,bafdeb3d-719b-4cce-8762-54d47b40f3c5" }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the message sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"1,2,3" }, { "name":"generalStatus", "in":"query", "description":"Sent message status group. Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IpCoreGeneralStatus" } }, { "name":"channel", "in":"query", "description":"Channel that was used for message delivering.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel" }, "example":"PUSH" }, { "name":"sentSince", "in":"query", "description":"Lower limit on date and time of sending messages.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" }, "example":"2015-02-22T17:42:05.390+01:00" }, { "name":"sentUntil", "in":"query", "description":"Upper limit on date and time of sending messages.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" }, "example":"2015-02-22T17:44:05.390+01:00" }, { "name":"limit", "in":"query", "description":"Maximal number of messages in returned logs. Default value is __50__. Maximum value is __1000__.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 }, "example":1 }, { "name":"mcc", "in":"query", "description":"Mobile country code.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"mnc", "in":"query", "description":"Mobile network code.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse" }, "examples":{ "Getting logs without any query parameter":{ "summary":"Getting logs without any query parameter", "description":"This request will return the last 50 message logs from the last 48h by default.", "value":{ "results":[ { "bulkId":"bafdeb3d-719b-4cce-8762-54d47b40f3c5", "messageId":"07e03aae-fabc-44ad-b1ce-222e14094d70", "to":"41793026727", "from":"InfoSMS", "text":"Test SMS.", "sentAt":"2015-02-23T16:41:11.833+0000", "doneAt":"2015-02-23T16:41:11.843+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0.01, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "channel":"SMS" }, { "bulkId":"06479ba3-5977-47f6-9346-fee0369bc76b", "messageId":"1f21d8d7-f306-4f53-9f6e-eddfce9849ea", "to":"41793026727", "from":"Demo PUSH Application", "text":"Test PUSH message.", "sentAt":"2015-02-23T16:40:31.773+0000", "doneAt":"2015-02-23T16:40:31.787+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "channel":"PUSH" } ] } }, "Getting logs with from, to and limit as filters":{ "summary":"Getting logs with from, to and limit as filters", "description":"This request will filter last messages by the rule - all messages sent from `from`, return last `limit` messages with destinations `to`.", "value":{ "results":[ { "bulkId":"bafdeb3d-719b-4cce-8762-54d47b40f3c5", "messageId":"07e03aae-fabc-44ad-b1ce-222e14094d70", "to":"41793026727", "from":"InfoSMS", "text":"Test SMS.", "sentAt":"2015-02-23T16:41:11.833+0000", "doneAt":"2015-02-23T16:41:11.843+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0.01, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "channel":"SMS" }, { "bulkId":"06479ba3-5977-47f6-9346-fee0369bc76b", "messageId":"1f21d8d7-f306-4f53-9f6e-eddfce9849ea", "to":"41793026727", "from":"Demo PUSH Application", "text":"Test PUSH message.", "sentAt":"2015-02-23T16:40:31.773+0000", "doneAt":"2015-02-23T16:40:31.787+0000", "messageCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "channel":"PUSH" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse" }, "examples":{ "Getting logs without any query parameter":{ "summary":"Getting logs without any query parameter", "description":"This request will return the last 50 message logs from the last 48h by default.", "value":"\n \n \n bafdeb3d-719b-4cce-8762-54d47b40f3c5\n 07e03aae-fabc-44ad-b1ce-222e14094d70\n 41793026727\n InfoSMS\n Test SMS.\n 2015-02-23T16:41:11.833+0000\n 2015-02-23T16:41:11.843+0000\n 1\n 22801\n \n 0.01\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n SMS\n \n \n 06479ba3-5977-47f6-9346-fee0369bc76b\n 1f21d8d7-f306-4f53-9f6e-eddfce9849ea\n 41793026727\n Demo PUSH Application\n Test PUSH message.\n 2015-02-23T16:40:31.773+0000\n 2015-02-23T16:40:31.787+0000\n 1\n 22801\n \n 0\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n PUSH\n \n \n\n" }, "Getting logs with from, to and limit as filters":{ "summary":"Getting logs with from, to and limit as filters", "description":"This request will filter last messages by the rule - all messages sent from `from`, return last `limit` messages with destinations `to`.", "value":"\n \n \n bafdeb3d-719b-4cce-8762-54d47b40f3c5\n 07e03aae-fabc-44ad-b1ce-222e14094d70\n 41793026727\n InfoSMS\n Test SMS.\n 2015-02-23T16:41:11.833+0000\n 2015-02-23T16:41:11.843+0000\n 1\n 22801\n \n 0.01\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n SMS\n \n \n 06479ba3-5977-47f6-9346-fee0369bc76b\n 1f21d8d7-f306-4f53-9f6e-eddfce9849ea\n 41793026727\n Demo PUSH Application\n Test PUSH message.\n 2015-02-23T16:40:31.773+0000\n 2015-02-23T16:40:31.787+0000\n 1\n 22801\n \n 0\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n PUSH\n \n \n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "omni-failover:logs:read", "omni-failover:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ] } } }, "components":{ "schemas":{ "033803db88cada38464c4e86c919c67cee20aa369072ec632b1c62ea0cc27514.ReferredProduct":{ "type":"object", "description":"Product information included in the incoming message.", "properties":{ "catalogId":{ "type":"string", "description":"The ID that uniquely identifies the catalog registered with Facebook, connected to the WhatsApp Business Account (WABA) the sender belongs to.", "minLength":0 }, "productRetailerId":{ "type":"string", "description":"Product unique identifier, as defined in catalog.", "minLength":0 } }, "title":"ReferredProduct" }, "04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"OMNI scenario name." }, "flow":{ "type":"array", "description":"Sender used in OMNI scenario’s step for sending message.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step" } }, "default":{ "type":"boolean", "description":"Indicates if created scenario should be set as a default." } }, "required":[ "flow" ], "title":"Scenario" }, "04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest":{ "type":"object", "properties":{ "scenarioKey":{ "type":"string", "description":"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.", "writeOnly":true }, "bulkId":{ "type":"string", "description":"The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.", "writeOnly":true }, "destinations":{ "type":"array", "description":"Destinations to which you are sending a message, such as phone number, email address, or unique ID.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Destination" }, "writeOnly":true }, "sms":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SmsData" }, "whatsApp":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.WhatsAppData" }, "viber":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ViberData" }, "voice":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VoiceData" }, "email":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.EmailData" }, "push":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PushData" }, "line":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineData" }, "kakaoChingu":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguData" }, "kakaoAlim":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimData" }, "notify":{ "type":"boolean", "description":"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." }, "intermediateReport":{ "type":"boolean", "description":"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`." }, "notifyUrl":{ "type":"string", "description":"The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`." }, "notifyContentType":{ "type":"string", "description":"Preferred delivery report content type, `application/json` or `application/xml`." }, "callbackData":{ "type":"string", "description":"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.", "maxLength":4000, "minLength":0 }, "sendAt":{ "type":"string", "format":"date-time", "description":"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." }, "vKontakte":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VKontakteData" } }, "title":"OmniAdvancedRequest" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Address":{ "type":"object", "properties":{ "street":{ "type":"string", "description":"Street name.", "readOnly":false, "writeOnly":true }, "city":{ "type":"string", "description":"City name.", "readOnly":false, "writeOnly":true }, "state":{ "type":"string", "description":"State name.", "readOnly":false, "writeOnly":true }, "zip":{ "type":"string", "description":"Zip value.", "readOnly":false, "writeOnly":true }, "country":{ "type":"string", "description":"Country name.", "readOnly":false, "writeOnly":true }, "countryCode":{ "type":"string", "description":"Country code value.", "readOnly":false, "writeOnly":true }, "type":{ "type":"string", "description":"Type of an address.", "enum":[ "HOME", "WORK" ], "readOnly":false, "writeOnly":true } }, "title":"Address" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ButtonReplyContent":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Identifier of the selected button.", "maxLength":256, "minLength":0 }, "title":{ "type":"string", "description":"Title of the selected button.", "maxLength":20, "minLength":0 } }, "required":[ "id", "title" ] } ], "title":"ButtonReplyContent" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Contact":{ "type":"object", "properties":{ "addresses":{ "type":"array", "description":"Address information.", "items":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Address" } }, "birthday":{ "type":"string", "format":"date-time", "description":"Birthday information, YYYY-MM-DD formatted string.", "readOnly":false, "writeOnly":true }, "emails":{ "type":"array", "description":"Email information.", "items":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Email" } }, "name":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Name" }, "org":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Organization" }, "phones":{ "type":"array", "description":"Phone information.", "items":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Phone" } }, "urls":{ "type":"array", "description":"URL information.", "items":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Url" } } }, "title":"Contact" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ContactName":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Contact name", "readOnly":false, "writeOnly":true }, "phoneNumber":{ "type":"string", "description":"Sender's phone number.", "writeOnly":true }, "userId":{ "type":"string", "description":"User ID", "readOnly":false, "writeOnly":true }, "parentUserId":{ "type":"string", "description":"parent user ID.", "readOnly":false, "writeOnly":true }, "username":{ "type":"string", "description":"Username.", "readOnly":false, "writeOnly":true } }, "title":"Contact" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Context":{ "type":"object", "description":"Information about the message to which the end user responded.", "properties":{ "id":{ "type":"string", "description":"MessageId of the message to which the end user responded.", "readOnly":false, "writeOnly":true }, "from":{ "type":"string", "description":"End user's phone number.", "readOnly":false, "writeOnly":true }, "referredProduct":{ "$ref":"#/components/schemas/033803db88cada38464c4e86c919c67cee20aa369072ec632b1c62ea0cc27514.ReferredProduct" } }, "title":"Context" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Email":{ "type":"object", "properties":{ "email":{ "type":"string", "description":"Email of a contact.", "readOnly":false, "writeOnly":true }, "type":{ "type":"string", "description":"Type of an email", "enum":[ "HOME", "WORK" ], "readOnly":false, "writeOnly":true } }, "title":"Email" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Identity":{ "type":"object", "description":"Information about the identity of the end user.", "properties":{ "acknowledged":{ "type":"boolean", "description":"Indicates whether identity is acknowledged.", "readOnly":false, "writeOnly":true }, "hash":{ "type":"string", "description":"Identifier for the latest user_identity_changed system notification", "readOnly":false, "writeOnly":true }, "createdAt":{ "type":"string", "format":"date-time", "description":"Indicates when the identity was changed. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "readOnly":false, "writeOnly":true } }, "title":"Identity" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundAudioMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Media" } ], "title":"InboundAudioMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundContactMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "contacts":{ "type":"array", "items":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Contact" } } } } ], "title":"InboundContactMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundDocumentMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Media" } ], "title":"InboundDocumentMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundImageMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Media" } ], "title":"InboundImageMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundLocationMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "longitude":{ "type":"number", "format":"double", "description":"Longitude. The value must be between -90 and 90.", "readOnly":false, "writeOnly":true }, "latitude":{ "type":"number", "format":"double", "description":"Latitude. The value must be between -180 and 180.", "readOnly":false, "writeOnly":true }, "name":{ "type":"string", "description":"Location name.", "readOnly":false, "writeOnly":true }, "address":{ "type":"string", "description":"Location address.", "readOnly":false, "writeOnly":true }, "url":{ "type":"string", "description":"Location URL.", "readOnly":false, "writeOnly":true } }, "required":[ "latitude", "longitude" ] } ], "title":"InboundLocationMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundTextMessage", "IMAGE":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundImageMessage", "DOCUMENT":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundDocumentMessage", "STICKER":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundStickerMessage", "LOCATION":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundLocationMessage", "CONTACT":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundContactMessage", "VIDEO":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundVideoMessage", "VOICE":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundVoiceMessage", "AUDIO":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundAudioMessage", "BUTTON":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.QuickReplyContent", "INTERACTIVE_BUTTON_REPLY":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ButtonReplyContent", "INTERACTIVE_LIST_REPLY":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ListReplyContent", "INTERACTIVE_PAYMENT_CONFIRMATION":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentConfirmationContent", "ORDER":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.OrderContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Type" }, "context":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Context" }, "identity":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Identity" }, "referral":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Referral" } }, "title":"MoMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageBase":{ "type":"object", "properties":{ "from":{ "type":"string", "description":"Number which sent the message.", "readOnly":false, "writeOnly":true }, "to":{ "type":"string", "description":"Sender provided during the activation process.", "readOnly":false, "writeOnly":true }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message.", "readOnly":false, "writeOnly":true }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message.", "readOnly":false, "writeOnly":true }, "price":{ "allOf":[ { "$ref":"#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price" } ], "description":"Message price.", "readOnly":false, "writeOnly":true } }, "title":"InboundMessageBase" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageBase" }, { "type":"object", "properties":{ "message":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, "contact":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ContactName" } ], "description":"Information about recipient.", "readOnly":false, "writeOnly":true } } } ], "title":"InboundMessageData" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundStickerMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"Url for media download.", "readOnly":false, "writeOnly":true } } } ], "title":"InboundStickerMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundTextMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Content of the end user's message.", "readOnly":false, "writeOnly":true } } } ], "title":"InboundTextMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundVideoMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Media" } ], "title":"InboundVideoMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundVoiceMessage":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Media" } ], "title":"InboundVoiceMessage" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ListReplyContent":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"ID of the selected row.", "maxLength":200, "minLength":0 }, "title":{ "type":"string", "description":"Title of the selected row.", "maxLength":24, "minLength":0 }, "description":{ "type":"string", "description":"Description of the selected row.", "maxLength":72, "minLength":0 } }, "required":[ "id", "title" ] } ], "title":"ListReplyContent" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Media":{ "type":"object", "properties":{ "caption":{ "type":"string", "description":"Media Caption.", "readOnly":false, "writeOnly":true }, "url":{ "type":"string", "description":"Url for media download.", "readOnly":false, "writeOnly":true } }, "title":"Media" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Name":{ "type":"object", "description":"Full contact name.", "properties":{ "firstName":{ "type":"string", "description":"First name of a contact. Mandatory value.", "readOnly":false, "writeOnly":true }, "formattedName":{ "type":"string", "description":"Full name as it normally appears. Mandatory value.", "readOnly":false, "writeOnly":true }, "lastName":{ "type":"string", "description":"Last name of a contact.", "readOnly":false, "writeOnly":true }, "middleName":{ "type":"string", "description":"Middle name of a contact.", "readOnly":false, "writeOnly":true }, "nameSuffix":{ "type":"string", "description":"Name suffix of a contact.", "readOnly":false, "writeOnly":true }, "namePrefix":{ "type":"string", "description":"Name prefix of a contact.", "readOnly":false, "writeOnly":true } }, "title":"Name" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.OrderContent":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "catalogId":{ "type":"string", "description":"The ID that uniquely identifies the catalog registered with Facebook, connected to the WhatsApp Business Account (WABA) the sender belongs to.", "minLength":0 }, "text":{ "type":"string", "description":"Text sent with order." }, "productItems":{ "type":"array", "description":"An array of selected products.", "items":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ProductItem" }, "minItems":1 } }, "required":[ "catalogId", "productItems" ] } ], "title":"OrderContent" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Organization":{ "type":"object", "description":"Organization information.", "properties":{ "company":{ "type":"string", "description":"Company name.", "readOnly":false, "writeOnly":true }, "department":{ "type":"string", "description":"Description name.", "readOnly":false, "writeOnly":true }, "title":{ "type":"string", "description":"Title.", "readOnly":false, "writeOnly":true } }, "title":"Organization" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentAmount":{ "type":"object", "description":"Total amount of the payment.", "properties":{ "value":{ "type":"integer", "description":"Value of the payment amount multiplied by the offset.", "minimum":1 }, "offset":{ "type":"integer", "description":"Offset of the payment amount (100 for INR and BRL).", "minimum":1 } }, "required":[ "offset", "value" ], "title":"PaymentAmount" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentConfirmationContent":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "referenceId":{ "type":"string", "description":"Unique identifier generated by the payment service provider.", "minLength":1 }, "paymentId":{ "type":"string", "description":"Unique identifier of the payment.", "minLength":1 }, "status":{ "type":"string", "description":"Status of the transaction.", "enum":[ "PENDING", "FAILED", "SUCCESS", "CANCELED", "UNKNOWN" ] }, "currency":{ "type":"string", "description":"Currency of the payment.", "enum":[ "INR", "BRL", "UNKNOWN" ] }, "totalAmount":{ "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentAmount" }, "transactionId":{ "type":"string", "description":"Unique identifier of the transaction.", "minLength":1 }, "transactionType":{ "type":"string", "description":"Type of the transaction.", "enum":[ "UPI", "BR", "UNKNOWN" ] } }, "required":[ "currency", "paymentId", "referenceId", "status", "totalAmount", "transactionId", "transactionType" ] } ], "title":"PaymentConfirmationContent" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Phone":{ "type":"object", "properties":{ "phone":{ "type":"string", "description":"Contact phone number.", "readOnly":false, "writeOnly":true }, "waId":{ "type":"string", "description":"WhatsApp ID.", "readOnly":false, "writeOnly":true }, "type":{ "type":"string", "description":"Type of a phone.", "enum":[ "CELL", "MAIN", "IPHONE", "HOME", "WORK" ], "readOnly":false, "writeOnly":true } }, "title":"Phone" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ProductItem":{ "type":"object", "properties":{ "currency":{ "type":"string", "description":"Currency of the product.", "minLength":0 }, "itemPrice":{ "type":"number", "description":"Price of the product." }, "productRetailerId":{ "type":"string", "description":"Product's unique identifier as defined in the catalog.", "minLength":0 }, "quantity":{ "type":"integer", "description":"Quantity of the ordered product.", "minimum":1 } }, "required":[ "currency", "itemPrice", "productRetailerId", "quantity" ], "title":"ProductItem" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.QuickReplyContent":{ "allOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text of the selected button.", "maxLength":20, "minLength":0 }, "payload":{ "type":"string", "description":"Payload of the selected button.", "maxLength":128, "minLength":0 } }, "required":[ "payload", "text" ] } ], "title":"QuickReplyContent" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Referral":{ "type":"object", "description":"Information about the referral which is either a Facebook ad or a post that triggered the message.", "properties":{ "sourceType":{ "type":"string", "description":"Indicates the source of the referral. Takes the value of `UNKNOWN` if there's no value or the value is different from `AD` or `POST`.", "enum":[ "AD", "POST", "UNKNOWN" ], "readOnly":false, "writeOnly":true }, "sourceId":{ "type":"string", "description":"Facebook ID of an ad or a post.", "readOnly":false, "writeOnly":true }, "sourceUrl":{ "type":"string", "description":"The URL that leads to a Facebook ad or a post.", "readOnly":false, "writeOnly":true }, "headline":{ "type":"string", "description":"Headline used in the ad that generated the message.", "readOnly":false, "writeOnly":true }, "body":{ "type":"string", "description":"Body from the ad that generated the message.", "readOnly":false, "writeOnly":true }, "ctwaClickId":{ "type":"string", "description":"Unique per click identifier exposed when the end user entering the conversation originated from a Click to WhatsApp (CTWA) ad.", "readOnly":false, "writeOnly":true }, "referralMedia":{ "$ref":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMedia" } }, "title":"Referral" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Type":{ "type":"string", "description":"Type of the message content. Select the type from the dropbox to view their parameters.", "enum":[ "TEXT", "IMAGE", "DOCUMENT", "STICKER", "LOCATION", "CONTACT", "VIDEO", "VOICE", "AUDIO", "BUTTON", "INTERACTIVE_BUTTON_REPLY", "INTERACTIVE_LIST_REPLY", "INTERACTIVE_PAYMENT_CONFIRMATION", "ORDER", "UNSUPPORTED" ], "title":"Type" }, "0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Url":{ "type":"object", "properties":{ "url":{ "type":"string", "description":"Contact URL.", "readOnly":false, "writeOnly":true }, "type":{ "type":"string", "description":"Type of a URL.", "enum":[ "HOME", "WORK" ], "readOnly":false, "writeOnly":true } }, "title":"Url" }, "17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse":{ "type":"object", "properties":{ "scenarios":{ "type":"array", "description":"Array of OMNI scenarios", "items":{ "$ref":"#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario" }, "readOnly":true } }, "title":"ScenariosResponse" }, "1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of logs.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniLog" }, "readOnly":true } }, "title":"OmniLogsResponse" }, "32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.IntegrationType":{ "type":"object", "properties":{ "integrationType":{ "type":"string", "description":"Integration type.", "enum":[ "WHATSAPP", "VIBER", "FACEBOOK" ], "readOnly":false, "writeOnly":true } }, "title":"IntegrationType" }, "32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase":{ "type":"object", "properties":{ "from":{ "type":"string", "description":"Number which sent the message.", "readOnly":false, "writeOnly":true }, "to":{ "type":"string", "description":"Sender provided during the activation process.", "readOnly":false, "writeOnly":true }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message.", "readOnly":false, "writeOnly":true }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message.", "readOnly":false, "writeOnly":true }, "pairedMessageId":{ "type":"string", "description":"", "readOnly":false, "writeOnly":true }, "callbackData":{ "type":"string", "description":"", "readOnly":false, "writeOnly":true }, "price":{ "allOf":[ { "$ref":"#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price" } ], "description":"Message price.", "readOnly":false, "writeOnly":true } }, "title":"MoReportBase" }, "3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.MessageCount":{ "type":"object", "properties":{ "messageCount":{ "type":"integer", "format":"int32", "description":"Number of returned messages in this request.", "readOnly":false, "writeOnly":true }, "pendingMessageCount":{ "type":"integer", "format":"int32", "description":"Number of remaining new messages on Infobip servers ready to be returned in the next request.", "readOnly":false, "writeOnly":true } }, "title":"MessageCount" }, "3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price":{ "type":"object", "properties":{ "currency":{ "type":"string", "description":"The currency in which the price is displayed.", "readOnly":false, "writeOnly":true }, "pricePerMessage":{ "type":"number", "format":"double", "description":"The price per individual message.", "readOnly":false, "writeOnly":true } }, "title":"Price" }, "450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.IntegrationType":{ "type":"object", "properties":{ "integrationType":{ "type":"string", "description":"Integration type.", "enum":[ "VIBER" ], "readOnly":false, "writeOnly":true } }, "title":"IntegrationType" }, "450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.Type":{ "type":"string", "enum":[ "TEXT", "FILE" ], "title":"Type" }, "46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.MoReport":{ "type":"object", "discriminator":{ "propertyName":"integrationType", "mapping":{ "WHATSAPP":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData", "VIBER":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport", "FACEBOOK":"#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport" } }, "oneOf":[ { "$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData" }, { "$ref":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport" }, { "$ref":"#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport" } ], "title":"MoReport" }, "46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport":{ "allOf":[ { "$ref":"#/components/schemas/32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.IntegrationType" }, { "properties":{ "message":{ "type":"object", "properties":{ "type":{ "type":"string", "description":"Message type.", "enum":[ "TEXT" ], "readOnly":false, "writeOnly":true }, "text":{ "type":"string", "description":"Incoming message text.", "readOnly":false, "writeOnly":true } } } } }, { "$ref":"#/components/schemas/32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase" } ], "title":"SimpleReport" }, "46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.ottReportResponse":{ "type":"object", "allOf":[ { "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every received message.", "items":{ "$ref":"#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.MoReport" } } } }, { "$ref":"#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.MessageCount" } ], "title":"OTTReportResponse" }, "477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.FileMessage":{ "allOf":[ { "$ref":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of received file.", "readOnly":false, "writeOnly":true }, "fileName":{ "type":"string", "description":"Name of received file.", "readOnly":false, "writeOnly":true }, "trackingData":{ "type":"string", "description":"Viber's tracking data from outgoing message that end user replies to. Might be random string of characters if not set explicitly in outgoing message.", "readOnly":false, "writeOnly":true }, "pairedMessageId":{ "type":"string", "description":"Message ID of paired outgoing message if matched by Infobip platform.", "readOnly":false, "writeOnly":true } } } ], "title":"FileMessage" }, "477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.TextMessage", "FILE":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.FileMessage" } }, "properties":{ "type":{ "$ref":"#/components/schemas/450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.Type" } }, "title":"MoMessage" }, "477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.IntegrationType" }, { "properties":{ "message":{ "allOf":[ { "$ref":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage" } ], "description":"Message content.", "readOnly":false, "writeOnly":true } } }, { "$ref":"#/components/schemas/32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase" } ], "title":"MoReport" }, "477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.TextMessage":{ "allOf":[ { "$ref":"#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text of received message.", "readOnly":false, "writeOnly":true }, "trackingData":{ "type":"string", "description":"Viber's tracking data from outgoing message that end user replies to. Might be random string of characters if not set explicitly in outgoing message.", "readOnly":false, "writeOnly":true }, "pairedMessageId":{ "type":"string", "description":"Message ID of paired outgoing message if matched by Infobip platform.", "readOnly":false, "writeOnly":true } } } ], "title":"TextMessage" }, "8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact":{ "type":"object", "description":"Contact information. Exists in case of WhatsApp Message.", "properties":{ "name":{ "type":"string", "description":"Contact name." }, "phoneNumber":{ "type":"string", "description":"Sender's phone number." }, "userId":{ "type":"string", "description":"User ID." }, "parentUserId":{ "type":"string", "description":"Parent user ID." }, "username":{ "type":"string", "description":"Username." } }, "title":"Contact" }, "8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.DeliveryReport" } } }, "title":"DeliveryReports" }, "8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.SeenReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every received message.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeenReport" } } }, "title":"SeenReports" }, "8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse":{ "type":"object", "properties":{ "bulkId":{ "type":"string", "description":"The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.", "readOnly":true }, "messages":{ "type":"array", "description":"Array of sent message objects, one object per every message.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniResponseDetails" }, "readOnly":true } }, "title":"OmniResponse" }, "9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario":{ "type":"object", "properties":{ "key":{ "type":"integer", "format":"int64", "description":"Key used to uniquely identify OMNI scenario.", "readOnly":true }, "name":{ "type":"string", "description":"OMNI scenario name." }, "flow":{ "type":"array", "description":"Sender used in OMNI scenario’s step for sending message.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step" } }, "default":{ "type":"boolean", "description":"Indicates if created scenario should be set as a default." } }, "title":"Scenario" }, "ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "ApiRequestError":{ "type":"object", "properties":{ "serviceException":{ "$ref":"#/components/schemas/ApiRequestErrorDetails" } }, "title":"ApiRequestError" }, "ApiRequestErrorDetails":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"Identifier of the error." }, "text":{ "type":"string", "description":"Detailed error description." }, "validationErrors":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "type":"string", "description":"Validation errors." } }, "description":"Validation errors." } }, "title":"ApiRequestErrorDetails" }, "a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType":{ "type":"string", "enum":[ "IMAGE", "VIDEO" ], "title":"Type" }, "a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMedia":{ "type":"object", "anyOf":[ { "$ref":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage" }, { "$ref":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo" } ], "description":"Media information of included referral.", "discriminator":{ "propertyName":"type", "mapping":{ "IMAGE":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage", "VIDEO":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo" } }, "properties":{ "type":{ "$ref":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType" } }, "readOnly":false, "title":"ReferralMedia", "writeOnly":true }, "a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage":{ "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType" }, "url":{ "type":"string", "description":"URL that leads to the image that end user saw and clicked.", "readOnly":false, "writeOnly":true } }, "title":"ReferralMediaImage" }, "a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo":{ "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType" }, "url":{ "type":"string", "description":"URL that leads to the video that end user saw and clicked.", "readOnly":false, "writeOnly":true } }, "title":"ReferralMediaVideo" }, "bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ActionType":{ "type":"string", "enum":[ "POSTBACK", "URI", "MESSAGE" ], "title":"ActionType" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Address":{ "type":"object", "description":"Address information.", "properties":{ "street":{ "type":"string", "description":"Street name.", "writeOnly":true }, "city":{ "type":"string", "description":"City name.", "writeOnly":true }, "state":{ "type":"string", "description":"State name.", "writeOnly":true }, "zip":{ "type":"string", "description":"Zip value.", "writeOnly":true }, "country":{ "type":"string", "description":"Country name.", "writeOnly":true }, "countryCode":{ "type":"string", "description":"Country code value.", "writeOnly":true }, "type":{ "type":"string", "description":"Type of an address. Can be HOME, WORK.", "writeOnly":true } }, "title":"Address", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Alignment":{ "type":"string", "enum":[ "START", "END", "CENTER" ], "title":"Alignment" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.AspectMode":{ "type":"string", "enum":[ "COVER", "FIT" ], "title":"AspectMode" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineBoxComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxComponent" }, { "type":"object", "properties":{ "contents":{ "type":"array", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineComponent" } } } } ], "required":[ "contents", "layout" ], "title":"BaselineBoxComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineComponent":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "FILLER":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FillerComponent", "TEXT":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TextComponent", "ICON":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IconComponent", "SPACER":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SpacerComponent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentType" } }, "title":"BaselineComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BlockComponentStyle":{ "type":"object", "properties":{ "backgroundColor":{ "type":"string" }, "separator":{ "type":"boolean" }, "separatorColor":{ "type":"string" } }, "title":"BlockComponentStyle" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxComponent":{ "type":"object", "discriminator":{ "propertyName":"layout", "mapping":{ "HORIZONTAL":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalBoxComponent", "VERTICAL":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalBoxComponent", "BASELINE":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineBoxComponent" } }, "properties":{ "layout":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxLayout" }, "flex":{ "type":"integer", "format":"int32", "maximum":10, "minimum":0 }, "spacing":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "margin":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "action":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" }, "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentType" }, "contents":{ "type":"array", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Component" } } }, "required":[ "contents", "layout" ], "title":"BoxComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxLayout":{ "type":"string", "enum":[ "HORIZONTAL", "VERTICAL", "BASELINE" ], "title":"BoxLayout" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BubbleFlexContainer":{ "type":"object", "properties":{ "direction":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Direction" }, "header":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxComponent" }, "hero":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ImageComponent" }, "body":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxComponent" }, "footer":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxComponent" }, "styles":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentStyle" }, "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ContainerType" } }, "required":[ "direction" ], "title":"BubbleFlexContainer" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "POSTBACK":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PostbackButtonAction", "URI":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.UriButtonAction", "MESSAGE":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MessageButtonAction" } }, "properties":{ "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ActionType" }, "label":{ "type":"string" } }, "title":"ButtonAction" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent" }, { "type":"object", "properties":{ "action":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" }, "flex":{ "type":"integer", "format":"int32", "maximum":10, "minimum":0 }, "margin":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "height":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Height" }, "style":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Style" }, "color":{ "type":"string" }, "gravity":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Gravity" } } } ], "required":[ "action" ], "title":"ButtonComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.CarouselFlexContainer":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FlexContainer" }, { "type":"object", "properties":{ "contents":{ "type":"array", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BubbleFlexContainer" } } } } ], "title":"CarouselFlexContainer" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Component":{ "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentType" } }, "title":"Component" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentStyle":{ "type":"object", "properties":{ "header":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BlockComponentStyle" }, "hero":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BlockComponentStyle" }, "body":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BlockComponentStyle" }, "footer":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BlockComponentStyle" } }, "title":"ComponentStyle" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentType":{ "type":"string", "enum":[ "BOX", "BUTTON", "FILLER", "ICON", "IMAGE", "SEPARATOR", "SPACER", "TEXT" ], "title":"ComponentType" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Contact":{ "type":"object", "properties":{ "addresses":{ "type":"array", "description":"Address information.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Address" }, "writeOnly":true }, "birthday":{ "type":"string", "description":"Birthday information, YYYY-MM-DD formatted string.", "writeOnly":true }, "emails":{ "type":"array", "description":"Email information.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Email" }, "writeOnly":true }, "name":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Name" }, "org":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Organization" }, "phones":{ "type":"array", "description":"Phone information.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Phone" }, "writeOnly":true }, "urls":{ "type":"array", "description":"Url information.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Url" }, "writeOnly":true } }, "required":[ "name" ], "title":"Contact" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ContainerType":{ "type":"string", "enum":[ "BUBBLE", "CAROUSEL" ], "title":"ContainerType" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.DeliveryReport":{ "type":"object", "description":"Collection of reports.", "properties":{ "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent." }, "to":{ "type":"string", "description":"The message destination address." }, "sentAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "doneAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.)." }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of sent message segments." }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes." }, "price":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price" }, "status":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status" }, "error":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Error" }, "channel":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel" }, "callbackData":{ "type":"string" }, "contact":{ "$ref":"#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact" } }, "title":"DeliveryReport" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Destination":{ "type":"object", "description":"Destinations to which you are sending a message, such as phone number, email address, or unique ID.", "properties":{ "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent." }, "to":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To" } }, "title":"Destination", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Direction":{ "type":"string", "enum":[ "LEFT_TO_RIGHT", "RIGHT_TO_LEFT" ], "title":"Direction" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Email":{ "type":"object", "description":"Email information.", "properties":{ "email":{ "type":"string", "description":"Email of a contact.", "writeOnly":true }, "type":{ "type":"string", "description":"Type of an email. Can be HOME, WORK.", "writeOnly":true } }, "title":"Email", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.EmailData":{ "type":"object", "description":"Email-specific data used if the message is sent through an email channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "maxLength":2147483647, "minLength":1, "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "subject":{ "type":"string", "description":"Message subject.", "writeOnly":true } }, "title":"EmailData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Error":{ "type":"object", "description":"Indicates whether the error occurred during the query execution.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Error group ID." }, "groupName":{ "type":"string", "description":"Error group name." }, "id":{ "type":"integer", "format":"int32", "description":"Error ID." }, "name":{ "type":"string", "description":"Error name." }, "description":{ "type":"string", "description":"Human-readable description of the error." }, "permanent":{ "type":"boolean", "description":"Tells if the error is permanent." } }, "title":"Error" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FillerComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent" }, { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineComponent" } ], "title":"FillerComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FlexContainer":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "BUBBLE":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BubbleFlexContainer", "CAROUSEL":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.CarouselFlexContainer" } }, "properties":{ "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ContainerType" } }, "title":"FlexContainer" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Gravity":{ "type":"string", "enum":[ "TOP", "BOTTOM", "CENTER" ], "title":"Gravity" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Height":{ "type":"string", "enum":[ "SM", "MD" ], "title":"Height" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalBoxComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BoxComponent" }, { "type":"object", "properties":{ "contents":{ "type":"array", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent" } } } } ], "required":[ "contents", "layout" ], "title":"HorizontalVerticalBoxComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "BOX":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalBoxComponent", "BUTTON":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonComponent", "FILLER":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FillerComponent", "IMAGE":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ImageComponent", "TEXT":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TextComponent", "SEPARATOR":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeparatorComponent", "SPACER":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SpacerComponent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentType" } }, "title":"HorizontalVerticalComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IconComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineComponent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "margin":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "size":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Size" }, "aspectRatio":{ "type":"string" } } } ], "required":[ "url" ], "title":"IconComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ImageComponent":{ "type":"object", "properties":{ "url":{ "type":"string" }, "flex":{ "type":"integer", "format":"int32", "maximum":10, "minimum":0 }, "margin":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "align":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Alignment" }, "gravity":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Gravity" }, "size":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ImageSize" }, "aspectRatio":{ "type":"string" }, "aspectMode":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.AspectMode" }, "backgroundColor":{ "type":"string" }, "action":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" }, "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ComponentType" } }, "required":[ "url" ], "title":"ImageComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ImageSize":{ "type":"string", "enum":[ "XXS", "XS", "SM", "MD", "LG", "XL", "XXL", "XXXL", "XXXXL", "XXXXXL", "FULL" ], "title":"ImageSize" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.InAppStyle":{ "type":"string", "description":"Set to `MODAL` to use in app dialog for actionable message, or `BANNER` to show a standard banner view. `MODAL` is supported on iOS from 3.6.0, on Android from 1.13.0 and on Cordova from 0.7.0. `BANNER` is supported from iOS 5.0.0, Android 2.0.0 and Cordova 1.0.0", "enum":[ "BANNER", "MODAL" ], "title":"InAppStyle", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IndiaDltOptions":{ "type":"object", "description":"Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.", "properties":{ "contentTemplateId":{ "type":"string", "description":"Id of your registered DTL content template that matches this message's text." }, "principalEntityId":{ "type":"string", "description":"Your assigned DTL principal entity id." }, "telemarketerId":{ "type":"string", "description":"Your assigned Telemarketer ID. (required for Aggregators)" } }, "required":[ "principalEntityId" ], "title":"IndiaDltOptions" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IpCoreGeneralStatus":{ "type":"string", "enum":[ "ACCEPTED", "PENDING", "UNDELIVERABLE", "DELIVERED", "EXPIRED", "REJECTED" ], "title":"IpCoreGeneralStatus" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimAddChannelButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" } ], "required":[ "buttonText" ], "title":"KakaoAlimAddChannelButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimAppLinkButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" }, { "type":"object", "properties":{ "androidScheme":{ "type":"string", "description":"Scheme to use on Android devices. At least two parameters among schemeIos, schemeAndroid, and urlMobile must be set. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true }, "iosScheme":{ "type":"string", "description":"Scheme to use on iOS devices. At least two parameters among schemeIos, schemeAndroid, and urlMobile must be set. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true }, "buttonUrlMobile":{ "type":"string", "description":"URL for mobile devices to open upon button press. At least two parameters among schemeIos, schemeAndroid, and urlMobile must be set. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true }, "buttonUrlPc":{ "type":"string", "description":"URL for PCs to open upon button press. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true } } } ], "required":[ "buttonText" ], "title":"KakaoAlimAppLinkButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimBotKeywordButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" } ], "required":[ "buttonText" ], "title":"KakaoAlimBotKeywordButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton":{ "type":"object", "description":"Buttons to include in the message. Optional value. Max 5 buttons.", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimAppLinkButton", "URL":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimUrlButton", "DELIVERY_TRACKING":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimDeliveryTrackingAlimButton", "CHATBOT_SWITCH":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimChatbotSwitchButton", "MESSAGE_DELIVERY":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimMessageDeliveryButton", "BOT_KEYWORD":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimBotKeywordButton", "ADD_CHANNEL":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimAddChannelButton" } }, "properties":{ "buttonText":{ "type":"string", "description":"Text of the button. Max 28 characters.", "maxLength":28, "minLength":1, "writeOnly":true }, "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButtonType" } }, "required":[ "buttonText" ], "title":"KakaoAlimButton", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButtonType":{ "type":"string", "enum":[ "URL", "APP_LINK", "DELIVERY_TRACKING", "CHATBOT_SWITCH", "MESSAGE_DELIVERY", "BOT_KEYWORD", "ADD_CHANNEL" ], "title":"KakaoAlimButtonType" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimChatbotSwitchButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" }, { "type":"object", "properties":{ "chatExtra":{ "type":"string", "description":"Meta information passed when switching chat bots. Max 50 characters.", "maxLength":50, "minLength":0, "writeOnly":true }, "chatEvent":{ "type":"string", "description":"Chat bot event name to connect when switching chat bots. Max 50 characters.", "maxLength":50, "minLength":0, "writeOnly":true } } } ], "required":[ "buttonText", "chatEvent", "chatExtra" ], "title":"KakaoAlimChatbotSwitchButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimData":{ "type":"object", "description":"Kakao AlimTalk-specific data used if the message is sent through a Kakao AlimTalk channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message.", "maxLength":1000, "minLength":1, "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "templateCode":{ "type":"string", "description":"Code of the template. Max 30 characters.", "maxLength":30, "minLength":1, "writeOnly":true }, "buttons":{ "type":"array", "description":"Buttons to include in the message. Optional value. Max 5 buttons.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" }, "maxItems":5, "minItems":1, "writeOnly":true }, "title":{ "type":"string", "description":"Title of the message.", "maxLength":50, "minLength":0, "writeOnly":true }, "groupKey":{ "type":"string", "description":"Group key of the profile. Required if the template was created using it.", "writeOnly":true } }, "title":"KakaoAlimData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimDeliveryTrackingAlimButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" } ], "required":[ "buttonText" ], "title":"KakaoAlimDeliveryTrackingAlimButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimMessageDeliveryButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" } ], "required":[ "buttonText" ], "title":"KakaoAlimMessageDeliveryButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton" }, { "type":"object", "properties":{ "buttonUrl":{ "type":"string", "deprecated":true, "description":"URL to open upon button press. Max 500 characters. This field is deprecated and will be removed in the future, buttonUrlMobile and buttonUrlPc should be used instead to set URL for each destination device.", "maxLength":500, "minLength":1, "writeOnly":true }, "buttonUrlMobile":{ "type":"string", "description":"URL for mobile devices to open upon button press. This field is mandatory if buttonUrl is not set, can't be used together with buttonUrl. It replaces deprecated buttonUrl field. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true }, "buttonUrlPc":{ "type":"string", "description":"URL for PCs to open upon button press. It replaces deprecated buttonUrl field. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true }, "target":{ "type":"string", "description":"Launches web page in external browser when set to \"out\"", "enum":[ "out" ], "pattern":"^out$", "writeOnly":true } } } ], "required":[ "buttonText" ], "title":"KakaoAlimUrlButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguAppLinkButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton" }, { "type":"object", "properties":{ "androidScheme":{ "type":"string", "description":"Scheme to use on Android devices.", "maxLength":500, "minLength":1, "writeOnly":true }, "iosScheme":{ "type":"string", "description":"Scheme to use on iOS devices.", "maxLength":500, "minLength":1, "writeOnly":true } } } ], "required":[ "androidScheme", "buttonText", "iosScheme" ], "title":"KakaoChinguAppLinkButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguBotKeywordButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton" } ], "required":[ "buttonText" ], "title":"KakaoChinguBotKeywordButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton":{ "type":"object", "description":"Buttons to include in the message. Optional value. Max 5 buttons.", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguAppLinkButton", "URL":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguUrlButton", "MESSAGE_DELIVERY":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguMessageDeliveryButton", "BOT_KEYWORD":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguBotKeywordButton" } }, "properties":{ "buttonText":{ "type":"string", "description":"Text of the button. Max 28 characters.", "maxLength":28, "minLength":1, "writeOnly":true }, "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButtonType" } }, "required":[ "buttonText" ], "title":"KakaoChinguButton", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButtonType":{ "type":"string", "enum":[ "URL", "APP_LINK", "BOT_KEYWORD", "MESSAGE_DELIVERY" ], "title":"KakaoChinguButtonType" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguData":{ "type":"object", "description":"Kakao ChinguTalk-specific data used if the message is sent through a Kakao ChinguTalk channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "buttons":{ "type":"array", "description":"Buttons to include in the message. Optional value. Max 5 buttons.", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton" }, "maxItems":5, "minItems":1, "writeOnly":true }, "imageUrl":{ "type":"string", "description":"URL of the image sent in the message. Optional value. Max 250 characters.", "maxLength":250, "minLength":1, "writeOnly":true }, "imageLink":{ "type":"string", "description":"Link of the image sent in the message. Optional value. Max 250 characters.", "maxLength":250, "minLength":1, "writeOnly":true }, "isPromotional":{ "type":"boolean", "description":"Flag that defines the message as promotional or not. Optional value.", "writeOnly":true } }, "required":[ "imageUrl", "text" ], "title":"KakaoChinguData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguMessageDeliveryButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton" } ], "required":[ "buttonText" ], "title":"KakaoChinguMessageDeliveryButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton" }, { "type":"object", "properties":{ "buttonUrl":{ "type":"string", "description":"URL to open upon button press. Max 500 characters.", "maxLength":500, "minLength":1, "writeOnly":true } } } ], "required":[ "buttonText", "buttonUrl" ], "title":"KakaoChinguUrlButton" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KoreaOptions":{ "type":"object", "description":"Specific parameters required for sending SMS to phone numbers registered in Korea.", "properties":{ "title":{ "type":"string", "description":"Title of the message that will be sent.", "maxLength":66, "minLength":0 } }, "title":"KoreaOptions" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Language":{ "type":"object", "description":"By setting the `languageCode` parameter you can send your language specific characters", "properties":{ "languageCode":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LanguageCode" } }, "title":"Language", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LanguageCode":{ "type":"string", "description":"Code for language character set of a message text.", "enum":[ "NONE", "TR", "ES", "PT", "AUTODETECT" ], "title":"LanguageCode", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineData":{ "type":"object", "description":"Line-specific data used if the message is sent through a Line channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "type":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineDataType" }, "url":{ "type":"string", "description":"Url of the image sent in the Line message. Max 1000 characters.", "maxLength":1000, "minLength":0, "writeOnly":true }, "thumbnailUrl":{ "type":"string", "description":"Thumbnail of the image sent in the Line message. Max 1000 characters.", "maxLength":1000, "minLength":0, "writeOnly":true }, "duration":{ "type":"integer", "format":"int64", "description":"Duration of the audio file.", "writeOnly":true }, "packageId":{ "type":"string", "description":"Package id of sticker that will be sent.", "writeOnly":true }, "stickerId":{ "type":"string", "description":"Sticker id that will be sent.", "writeOnly":true }, "altText":{ "type":"string", "maxLength":400, "minLength":0 }, "contents":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FlexContainer" } }, "required":[ "altText", "contents", "duration", "packageId", "stickerId", "thumbnailUrl", "url" ], "title":"LineData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineDataType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "VIDEO", "AUDIO", "STICKER", "FLEX" ], "title":"LineDataType" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateBodyContent":{ "type":"object", "description":"Media template body", "properties":{ "placeholders":{ "type":"array", "description":"Media template body placeholders. The value must not be null, but can be an empty array. Values within the array must not be null or empty.", "items":{ "type":"string", "description":"Media template body placeholders. The value must not be null, but can be an empty array. Values within the array must not be null or empty.", "writeOnly":true }, "writeOnly":true } }, "required":[ "placeholders" ], "title":"MediaTemplateBodyContent", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateButtonContent":{ "type":"object", "description":"Media template buttons", "properties":{ "urlPlaceholder":{ "type":"string", "description":"URL placeholder. Required for URL buttons that have a parameterized URL.", "maxLength":1500, "minLength":0, "writeOnly":true }, "quickReplyPayload":{ "type":"string", "description":"QuickReply payload. Required for quick reply buttons.", "maxLength":128, "minLength":0, "writeOnly":true } }, "title":"MediaTemplateButtonContent", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateData":{ "type":"object", "description":"Media template definitions", "properties":{ "header":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateHeaderContent" }, "body":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateBodyContent" }, "buttons":{ "type":"array", "description":"Media template buttons", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateButtonContent" }, "writeOnly":true } }, "required":[ "body" ], "title":"MediaTemplateData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateHeaderContent":{ "type":"object", "description":"Media template header. Required for media templates which contain headers", "properties":{ "textPlaceholder":{ "type":"string", "description":"Text placeholder. Required for templates that contain a text header.", "writeOnly":true }, "documentUrl":{ "type":"string", "description":"Document URL. Required for templates that contain a document header.Supported document types are PDF, DOC(X), PPT(X), XLS(X). Maximum document size is 100MB.", "writeOnly":true }, "documentFilename":{ "type":"string", "description":"Document name. Required for templates that contain a document header.", "writeOnly":true }, "imageUrl":{ "type":"string", "description":"Image URL. Required for templates that contain an image header. Supported image types: JPG, JPEG, PNG. Maximum image size is 5MB.", "writeOnly":true }, "videoUrl":{ "type":"string", "description":"Video URL. Required for templates that contain a video header. Supported video types are MP4, 3GPP. Maximum video size is 16MB.", "writeOnly":true }, "latitude":{ "type":"number", "format":"double", "description":"Location latitude. The value must be between -90 and 90. Required for templates that contain a location header.", "maximum":90, "minimum":-90, "writeOnly":true }, "longitude":{ "type":"number", "format":"double", "description":"Location longitude. The value must be between -180 and 180. Required for templates that contain a location header.", "maximum":180, "minimum":-180, "writeOnly":true } }, "required":[ "documentFilename", "documentUrl", "imageUrl", "latitude", "longitude", "textPlaceholder", "videoUrl" ], "title":"MediaTemplateHeaderContent", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MessageButtonAction":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" }, { "type":"object", "properties":{ "label":{ "type":"string", "maxLength":20, "minLength":0 }, "text":{ "type":"string", "maxLength":300, "minLength":0 } } } ], "required":[ "label", "text" ], "title":"MessageButtonAction" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Name":{ "type":"object", "description":"Contains information about the name and last of a contact.", "properties":{ "firstName":{ "type":"string", "description":"First name of a contact. Mandatory value.", "writeOnly":true }, "lastName":{ "type":"string", "description":"Last name of a contact.", "writeOnly":true }, "middleName":{ "type":"string", "description":"Middle name of a contact.", "writeOnly":true }, "nameSuffix":{ "type":"string", "description":"Name suffix of a contact. ", "writeOnly":true }, "namePrefix":{ "type":"string", "description":"Name prefix of a contact.", "writeOnly":true }, "formattedName":{ "type":"string", "description":"Full name as it normally appears. Mandatory value.", "writeOnly":true } }, "required":[ "firstName", "formattedName" ], "title":"Name", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.NotificationOptions":{ "type":"object", "description":"Options on how to alert the user when the Push message is received.", "properties":{ "vibrationEnabled":{ "type":"boolean", "description":"Notification vibration (Android only).", "writeOnly":true }, "soundEnabled":{ "type":"boolean", "description":"Sound when notification arrives on a device.", "writeOnly":true }, "soundName":{ "type":"string", "description":"Name of the custom sound played when notification arrives on a device. File should be located in the app with max 30 seconds length. File extension is required for iOS and optional for Android. For custom sound to be played soundEnabled shouldn’t be false (Example: `notification_sound.wav`). Check Android and iOS usage details.", "writeOnly":true }, "badge":{ "type":"integer", "format":"int32", "description":"Badge counter (iOS only).", "writeOnly":true }, "contentUrl":{ "type":"string", "description":"URL of the image displayed in the notification. Rich push notifications are available on devices with iOS 10 and Android 4.1.+. Supported on iOS since MM SDK version 2.5.8. Supported on Android since MM SDK version 1.6.4.", "writeOnly":true }, "category":{ "type":"string", "description":"Category id for actionable notification. Supported on Android since MM SDK version 1.6.16. Supported on iOS since MM SDK version 2.6.9. Predefined category ids: `mm_accept_decline` - Accept & Decline button actions.", "writeOnly":true }, "inAppStyle":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.InAppStyle" }, "title":{ "type":"string", "description":"Notification title displayed within notification. Requires iOS 10+ or Android 4.1+ (may depend on Android custom firmware)", "writeOnly":true }, "isSilent":{ "type":"boolean", "description":"Set to `true` to send silent push message. Such messages are not displayed on device lock screen and in the notification center. Silent messages can be used to deliver custom data to your mobile application or to trigger an in-app notification.", "writeOnly":true }, "webViewUrl":{ "type":"string", "description":"URL to open external web page within the mobile app (web view).", "writeOnly":true }, "inboxTopic":{ "type":"string", "description":"A case sensitive topic name to save a message to an inbox. If the topic name does not exist for a specified account, message sending will be rejected.", "writeOnly":true } }, "title":"NotificationOptions", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel":{ "type":"string", "description":"Channel that was used for message delivering.", "enum":[ "SMS", "EMAIL", "VOICE", "PUSH", "VIBER", "LINE", "VKONTAKTE", "KAKAO_CHINGU", "KAKAO_ALIM", "WHATSAPP" ], "title":"OmniChannel" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniLog":{ "type":"object", "description":"Collection of logs.", "properties":{ "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request.", "readOnly":true }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent.", "readOnly":true }, "to":{ "type":"string", "description":"The message destination address.", "readOnly":true }, "from":{ "type":"string", "description":"Sender ID that can be alphanumeric or numeric.", "readOnly":true }, "text":{ "type":"string", "description":"Text of the message that was sent.", "readOnly":true }, "sentAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was sent. It has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "readOnly":true }, "doneAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.)", "readOnly":true }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of sent message segments.", "readOnly":true }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes.", "readOnly":true }, "price":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price" }, "status":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status" }, "channel":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel" } }, "readOnly":true, "title":"OmniLog" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniResponseDetails":{ "type":"object", "description":"Array of sent message objects, one object per every message.", "properties":{ "to":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To" }, "status":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status" }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the sent message." } }, "readOnly":true, "title":"OmniResponseDetails" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Organization":{ "type":"object", "description":"Company information.", "properties":{ "company":{ "type":"string", "description":"Company name.", "writeOnly":true }, "department":{ "type":"string", "description":"Department name.", "writeOnly":true }, "title":{ "type":"string", "description":"Title value", "writeOnly":true } }, "title":"Organization", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Phone":{ "type":"object", "description":"Phone information.", "properties":{ "phone":{ "type":"string", "description":"Phone of contact.", "writeOnly":true }, "type":{ "type":"string", "description":"Type of a phone. Can be CELL, MAIN, IPHONE, HOME, WORK.", "writeOnly":true }, "waId":{ "type":"string", "description":"WhatsApp ID.", "writeOnly":true } }, "title":"Phone", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PostbackButtonAction":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" }, { "type":"object", "properties":{ "label":{ "type":"string", "maxLength":20, "minLength":0 }, "data":{ "type":"string", "maxLength":300, "minLength":0 }, "displayText":{ "type":"string", "maxLength":300, "minLength":0 } } } ], "required":[ "data", "displayText", "label" ], "title":"PostbackButtonAction" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price":{ "type":"object", "description":"Sent message price.", "properties":{ "pricePerMessage":{ "type":"number", "description":"Price per message." }, "currency":{ "type":"string", "description":"Currency." } }, "title":"Price" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PushData":{ "type":"object", "description":"Push-specific data used if the message is sent through a Push channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "maxLength":2000, "minLength":1, "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "customPayload":{ "type":"object", "additionalProperties":{ "type":"object", "writeOnly":true }, "description":"Additional custom data delivered with the Push message.", "writeOnly":true }, "notificationOptions":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.NotificationOptions" }, "targetOnlyPrimaryDevices":{ "type":"boolean", "description":"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.", "writeOnly":true }, "includeNotificationsDisabledDevices":{ "type":"boolean", "description":"Flag which shows if devices with disabled notifications are included.", "writeOnly":true }, "personSubscriptions":{ "type":"array", "description":"Key set of custom attributes on person for additional filtering.", "items":{ "type":"string", "description":"Key set of custom attributes on person for additional filtering.", "writeOnly":true }, "uniqueItems":true, "writeOnly":true }, "deviceSubscriptions":{ "type":"array", "description":"Key set of custom attributes on device for additional filtering.", "items":{ "type":"string", "description":"Key set of custom attributes on device for additional filtering.", "writeOnly":true }, "uniqueItems":true, "writeOnly":true } }, "title":"PushData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.RegionalData":{ "type":"object", "description":"Region specific parameters, often specified by local laws. Use this if country or region that you are sending SMS to requires some extra parameters.", "properties":{ "indiaDlt":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IndiaDltOptions" }, "korea":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KoreaOptions" } }, "title":"RegionalData" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeenReport":{ "type":"object", "description":"Collection of reports, one per every received message.", "properties":{ "messageId":{ "type":"string", "description":"The ID of the sent message." }, "from":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "sendAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was sent." }, "seenAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was seen." }, "contact":{ "$ref":"#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact" } }, "title":"SeenReport" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeparatorComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent" }, { "type":"object", "properties":{ "margin":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "color":{ "type":"string" } } } ], "title":"SeparatorComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Size":{ "type":"string", "enum":[ "XXS", "XS", "SM", "MD", "LG", "XL", "XXL", "XXXL", "XXXXL", "XXXXXL" ], "title":"Size" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SmsData":{ "type":"object", "description":"SMS-specific data used if the message is sent through an SMS channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "maxLength":2147483647, "minLength":1, "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "transliteration":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TransliterationCode" }, "language":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Language" }, "regional":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.RegionalData" } }, "title":"SmsData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SpacerComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent" }, { "type":"object", "properties":{ "size":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" } } }, { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineComponent" } ], "title":"SpacerComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing":{ "type":"string", "enum":[ "XS", "SM", "MD", "LG", "XL", "XXL", "NONE" ], "title":"Spacing" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status":{ "type":"object", "description":"Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Status group ID." }, "groupName":{ "type":"string", "description":"Status group name." }, "id":{ "type":"integer", "format":"int32", "description":"Status ID." }, "name":{ "type":"string", "description":"Status name." }, "description":{ "type":"string", "description":"Human-readable description of the status." }, "action":{ "type":"string", "description":"Action that should be taken to eliminate the error." } }, "title":"Status" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step":{ "type":"object", "description":"Sender used in OMNI scenario’s step for sending message.", "properties":{ "from":{ "type":"string", "description":"Sender used in OMNI scenario’s step for sending message." }, "channel":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel" } }, "required":[ "channel" ], "title":"Step" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Style":{ "type":"string", "enum":[ "LINK", "PRIMARY", "SECONDARY" ], "title":"Style" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TextComponent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.HorizontalVerticalComponent" }, { "type":"object", "properties":{ "text":{ "type":"string" }, "flex":{ "type":"integer", "format":"int32", "maximum":10, "minimum":0 }, "margin":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Spacing" }, "size":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Size" }, "align":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Alignment" }, "gravity":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Gravity" }, "wrap":{ "type":"boolean" }, "maxLines":{ "type":"integer", "format":"int32", "minimum":0 }, "color":{ "type":"string" }, "weight":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Weight" }, "action":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" } } }, { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BaselineComponent" } ], "required":[ "text" ], "title":"TextComponent" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit":{ "type":"string", "default":"MINUTES", "description":"The message validity period time unit, allowing finer time granulation.", "enum":[ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "title":"TimeUnit", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To":{ "type":"object", "description":"The message destination address.", "properties":{ "phoneNumber":{ "type":"string", "description":"Destination phone number. Phone numbers must be in international format (example: `41793026727`)." }, "emailAddress":{ "type":"string", "description":"Destination email address." }, "pushRegistrationId":{ "type":"string", "description":"Unique ID for push registration." }, "whatsAppUserId":{ "type":"string", "description":"WhatsApp Business-Scoped User ID (BSUID). Format: `{CC}.{alphanumeric}` (e.g. `US.13491208655302741918`). Max 150 characters. Phone number takes precedence when both are provided." } }, "title":"To" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TransliterationCode":{ "type":"string", "description":"Conversion of a message text from one script to another.", "enum":[ "NONE", "ALL", "BALTIC", "CENTRAL_EUROPEAN", "COLOMBIAN", "CYRILLIC", "GREEK", "NON_UNICODE", "PORTUGUESE", "SERBIAN_CYRILLIC", "TURKISH", "BULGARIAN_CYRILLIC" ], "title":"TransliterationCode", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.UriButtonAction":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ButtonAction" }, { "type":"object", "properties":{ "label":{ "type":"string", "maxLength":20, "minLength":0 }, "uri":{ "type":"string", "maxLength":1000, "minLength":0 } } } ], "required":[ "label", "uri" ], "title":"UriButtonAction" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Url":{ "type":"object", "description":"Url information.", "properties":{ "url":{ "type":"string", "description":"Url of a contact.", "writeOnly":true }, "type":{ "type":"string", "description":"Type of a url. Can be HOME, WORK.", "writeOnly":true } }, "title":"Url", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VKontakteData":{ "type":"object", "description":"VKontakte-specific data used if the message is sent through a VKontakte channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "templateName":{ "type":"string", "description":"Template name", "writeOnly":true }, "templateData":{ "type":"object", "additionalProperties":{ "type":"object", "writeOnly":true }, "description":"JSON object where the keys are names of parameters in the template.", "writeOnly":true } }, "title":"VKontakteData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ViberData":{ "type":"object", "description":"Viber-specific data used if the message is sent through a Viber channel. Must be one of: text, image, file, text with button or text with image and button.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 14 days is not supported. Additionally, period should be longer than 35 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "imageURL":{ "type":"string", "description":"URL of the image sent in the Viber message.", "maxLength":1000, "minLength":0, "writeOnly":true }, "fileName":{ "type":"string", "description":"File name of the file sent in the Viber message.", "maxLength":25, "minLength":0, "writeOnly":true }, "fileType":{ "type":"string", "description":"File type (extension) of the file sent in the Viber message. Has to be one of: doc, docx, rtf, dot, dotx, odt ,odf, fodt, txt, info, pdf, xps, pdax, eps, xls, xlsx, ods, fods, csv, xlsm, xltx", "writeOnly":true }, "fileUrl":{ "type":"string", "description":"URL of the file sent in the Viber message. For example: http://example.com/document.docx", "pattern":"^(https?)://.*$", "writeOnly":true }, "buttonText":{ "type":"string", "description":"Viber button label. Max 30 characters.", "maxLength":30, "minLength":0, "writeOnly":true }, "buttonURL":{ "type":"string", "description":"Viber Button Call To Action. Should contain URL or telephone number to call. Format for telephone number is tel:.", "maxLength":1000, "minLength":0, "writeOnly":true }, "trackingData":{ "type":"string", "description":"Viber tracking data. Enables tracking messages, sent tracking_data value will be passed back with user's reply", "maxLength":100, "minLength":0, "writeOnly":true }, "isPromotional":{ "type":"boolean", "description":"Indicates if content is of promotional character.", "writeOnly":true }, "forcePrimaryDevice":{ "type":"boolean", "description":"Defines if Text message will be sent only to the users primary device (smartphone).", "writeOnly":true } }, "title":"ViberData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VoiceData":{ "type":"object", "description":"Voice-specific data used if the message is sent through a voice channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "maxLength":2147483647, "minLength":1, "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "language":{ "type":"string", "description":"Supported languages for Voice messages. List of supported languages can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech)", "writeOnly":true } }, "title":"VoiceData", "writeOnly":true }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Weight":{ "type":"string", "enum":[ "BOLD", "REGULAR" ], "title":"Weight" }, "e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.WhatsAppData":{ "type":"object", "description":"WhatsApp-specific data used if the message is sent through a WhatsApp channel.", "properties":{ "text":{ "type":"string", "description":"Text of the message that will be sent.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.", "writeOnly":true }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit" }, "templateNamespace":{ "type":"string", "description":"Template namespace", "writeOnly":true }, "templateName":{ "type":"string", "description":"Template name", "writeOnly":true }, "templateData":{ "type":"array", "description":"Template parameters values ordered as registered in template", "items":{ "type":"string", "description":"Template parameters values ordered as registered in template", "writeOnly":true }, "writeOnly":true }, "mediaTemplateData":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateData" }, "language":{ "type":"string", "description":"The code of the language or locale to use. Needs to be exactly the code with which the template was registered.", "writeOnly":true }, "fileUrl":{ "type":"string", "description":"URL of the file sent in the WhatsApp message. Max 2048 characters. Supported file types are PDF, DOC(X), PPT(X), XLS(X). Maximum file size is 100MB.", "maxLength":2048, "minLength":0, "writeOnly":true }, "imageUrl":{ "type":"string", "description":"URL of the image sent in the WhatsApp message. Max 2048 characters. Supported image types: JPG, JPEG, PNG. Maximum image size is 5MB.", "maxLength":2048, "minLength":0, "writeOnly":true }, "audioUrl":{ "type":"string", "description":"URL of the audio file sent in the WhatsApp message. Max 2048 characters. Supported audio types are AAC, AMR, MP3, OPUS. Maximum audio size is 16MB.", "maxLength":2048, "minLength":0, "writeOnly":true }, "videoUrl":{ "type":"string", "description":"URL of the video sent in the WhatsApp message. Max 2048 characters. Supported video types are MP4, 3GPP. Maximum video size is 16MB.", "maxLength":2048, "minLength":0, "writeOnly":true }, "locationName":{ "type":"string", "description":"Name of the location. Optional value. ", "maxLength":1000, "minLength":0, "writeOnly":true }, "address":{ "type":"string", "description":"Address location. Optional value.", "maxLength":1000, "minLength":0, "writeOnly":true }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of a coordinate. The value must be between -180 and 180", "maximum":180, "minimum":-180, "writeOnly":true }, "latitude":{ "type":"number", "format":"double", "description":"Latitude of a coordinate. The value must be between -90 and 90.", "maximum":90, "minimum":-90, "writeOnly":true }, "previewUrl":{ "type":"boolean", "description":"`Options`: false (default), true
Specifying previewUrl in the request is optional when not including a URL in your message.
To include a URL preview, set previewUrl to true in the message body and make sure that URL begins with http:// or https:/", "writeOnly":true }, "contacts":{ "type":"array", "items":{ "$ref":"#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Contact" } } }, "required":[ "mediaTemplateData", "text" ], "title":"WhatsAppData" } }, "responses":{ "ApiException401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"UNAUTHORIZED", "text":"Unauthorized" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n" } } }, "ApiException403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"FORBIDDEN", "text":"Forbidden" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n" } } }, "ApiException429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n" } } }, "ApiException500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"GENERAL_ERROR", "text":"Something went wrong. Please contact support." } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\n" } } } }, "parameters":{}, "examples":{}, "requestBodies":{}, "headers":{}, "securitySchemes":{ "APIKeyHeader":{ "type":"apiKey", "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n", "name":"Authorization", "in":"header" }, "Basic":{ "type":"http", "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n", "scheme":"basic" }, "IBSSOTokenHeader":{ "type":"apiKey", "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n", "name":"Authorization", "in":"header" }, "OAuth2":{ "type":"oauth2", "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```", "flows":{ "clientCredentials":{ "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token", "scopes":{} } } } }, "links":{}, "callbacks":{} }, "webhooks":{ "receive-omni-failover-message-delivery-reports":{ "post":{ "tags":[ "channels", "omni-failover", "send-omni-message" ], "summary":"Receive delivery status report", "description":"For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Once the setup is complete, we will be able to deliver the [reports](https://www.infobip.com/docs/essentials/response-status-and-error-codes) to you in real time. Alternatively you can specify the endpoint per each message via the `notifyUrl` parameter. Contact support@infobip.com if you require help. Use one URL for all report types.", "operationId":"receive-omni-failover-message-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"1dece649-6c8f-404e-8c6e-c7e073be509a", "messageId":"fb469d73-d362-463f-b30f-1e959b53badc", "to":"41793026731", "sentAt":"2023-04-06T15:22:37.413+0000", "doneAt":"2023-04-06T15:22:37.437+0000", "messageCount":1, "price":{ "pricePerMessage":0.21, "currency":"BRL" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "channel":"WHATSAPP" } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-omni-failover-message-seen-reports":{ "post":{ "tags":[ "channels", "omni-failover", "send-omni-message" ], "summary":"Receive seen reports", "description":"For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Once the setup is complete, we will be able to deliver the [reports](https://www.infobip.com/docs/essentials/response-status-and-error-codes) to you in real time. Alternatively you can specify the endpoint per each message via the `notifyUrl` parameter. Contact support@infobip.com if you require help. Use one URL for all report types.", "operationId":"receive-omni-failover-message-seen-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.SeenReports" }, "examples":{ "Seen reports":{ "summary":"Seen reports", "value":{ "results":[ { "messageId":"1215f543ab19-345f-adbd-12ad31451ed25f35", "from":"385919998888", "to":"41793026731", "sendAt":"2023-04-05T11:21:57.793+0000", "seenAt":"2023-04-05T11:22:10.251+0000" } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-omni-failover-inbound-messages":{ "post":{ "tags":[ "channels", "omni-failover", "receive-incoming-messages" ], "summary":"Receive incoming message", "description":"Incoming messages will be forwarded in real time to the end-point client provided during the setup. This way, 2-way communication will be established, and the enterprise is enabled to create a certain logic for processing incoming messages.", "operationId":"receive-omni-failover-incoming-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.ottReportResponse" }, "examples":{ "Received WhatsApp TEXT message":{ "summary":"Received WhatsApp TEXT message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2019-07-19T11:23:26.998+0000", "messageId":"ABEGOFl3VCQoAhBalbc6rTQT6mgS29EmGZ7a", "pairedMessageId":null, "callbackData":null, "message":{ "type":"TEXT", "text":"Support hello" }, "contact":{ "name":"Frank" }, "price":{ "pricePerMessage":0, "currency":"EUR" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp IMAGE message":{ "summary":"Received WhatsApp IMAGE message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2018-09-10T11:27:17.980+0000", "messageId":"ABEGOFkWA5EBAgo6B82cNiWIAMKC", "pairedMessageId":null, "callbackData":null, "message":{ "type":"IMAGE", "caption":"Image Caption", "url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe" }, "price":{ "pricePerMessage":0.0, "currency":"HRK" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp STICKER message":{ "summary":"Received WhatsApp STICKER message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2018-09-10T11:27:17.980+0000", "messageId":"ABEGOFkWA5EBAgo6B82cNiWIAMKC", "pairedMessageId":null, "callbackData":null, "message":{ "type":"STICKER", "url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe" }, "price":{ "pricePerMessage":0.0, "currency":"HRK" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp AUDIO message":{ "summary":"Received WhatsApp AUDIO message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "pairedMessageId":null, "callbackData":null, "message":{ "type":"AUDIO", "url":"https://{base_url/whatsapp/1/senders/551140038883/media/cb5608eb-aa38-454f-a045-899df74324e2" }, "price":{ "pricePerMessage":0.0, "currency":"EUR" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp VIDEO message":{ "summary":"Received WhatsApp VIDEO message", "value":{ "results":[ { "from":"385918889999", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2019-09-24T12:21:06.486+0000", "messageId":"ABEGOFmJJRkFAhDvgHvPWYmCNKXZSQaqgH2A", "pairedMessageId":null, "callbackData":null, "message":{ "caption":"Look at this!", "type":"VIDEO", "url":"https://{base_url}/whatsapp/1/senders/447860098731/media/42f076b9-1d1e-4d56-8c1e-02d0a402a1e3" }, "price":{ "pricePerMessage":0, "currency":"EUR" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp DOCUMENT message":{ "summary":"Received WhatsApp DOCUMENT message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2018-09-10T12:10:18.379+0000", "messageId":"ABEGOFkWA5EBAgo6B82cNiWIAMKC", "pairedMessageId":null, "callbackData":null, "message":{ "type":"DOCUMENT", "caption":"Document caption", "url":"https://{base_url}/whatsapp/1/senders/447796344125/media/c256e11d-a7e9-4dbb-aa9c-2a6028ddf7e8" }, "price":{ "pricePerMessage":0.0, "currency":"HRK" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp LOCATION message":{ "summary":"Received WhatsApp LOCATION message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2018-09-10T12:13:53.864+0000", "messageId":"ABEGOFkWA5EBAgo6B82cNiWIAMKC", "pairedMessageId":null, "callbackData":null, "message":{ "type":"LOCATION", "longitude":-73.985655555556, "latitude":40.748433333333, "name":"Empire State Building", "url":"https://www.facebook.com/113272675352744", "address":"350 5th Ave, New York, NY" }, "price":{ "pricePerMessage":0.0, "currency":"HRK" } } ], "messageCount":1, "pendingMessageCount":1 } }, "Received WhatsApp VOICE message":{ "summary":"Received WhatsApp VOICE message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2020-02-04T20:42:48.790+0000", "messageId":"ABEGVUGWh3gEAgo6XoxYzF6sEhdys", "pairedMessageId":null, "callbackData":null, "message":{ "type":"VOICE", "url":"https://{base_url}/whatsapp/1/senders/554332947008/media/a852fb92-8506-4c3d-aab2-81bf436786e6" }, "price":{ "pricePerMessage":0.0, "currency":"EUR" } } ], "messageCount":1, "pendingMessageCount":1113 } }, "Received WhatsApp CONTACT message":{ "summary":"Received WhatsApp CONTACT message", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2019-09-24T10:07:04.070+0000", "messageId":"ABEGOFmJJRkFAhA7ud6mcWKmglIlIO6xibx9", "pairedMessageId":null, "callbackData":null, "message":{ "type":"CONTACT", "contacts":[ { "name":{ "firstName":"Frank", "lastName":"Bipper", "formattedName":"Frank Bipper" }, "org":{ "company":"Infobip" }, "phones":[ { "phone":"+385 91 888 9999", "type":"CELL", "waId":"385918889999" } ] } ] }, "price":{ "pricePerMessage":0, "currency":"EUR" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received WhatsApp TEXT message with Identity notification":{ "summary":"Received WhatsApp TEXT message with Identity notification", "value":{ "results":[ { "from":"385919998888", "to":"41793026731", "integrationType":"WHATSAPP", "receivedAt":"2019-07-19T11:23:26.998+0000", "messageId":"ABEGOFl3VCQoAhBalbc6rTQT6mgS29EmGZ7a", "pairedMessageId":null, "callbackData":null, "message":{ "type":"TEXT", "text":"Support hello" }, "identity":{ "createdAt":"2020-01-01T00:00:00.000+0000", "acknowledged":true, "hash":"eU2Fdi4EMUw=" }, "contact":{ "name":"Frank" }, "price":{ "pricePerMessage":0, "currency":"EUR" } } ], "messageCount":1, "pendingMessageCount":0 } }, "Received Viber TEXT message":{ "summary":"Received Viber TEXT message", "value":{ "results":[ { "from":"385912345678", "to":"givenClient", "integrationType":"VIBER", "receivedAt":"2020-04-01T11:02:43.594+0000", "messageId":"1234567890123456789", "pairedMessageId":null, "callbackData":null, "message":{ "text":"givenText", "type":"TEXT" }, "price":{ "pricePerMessage":36.666667, "currency":"RUB" } } ], "messageCount":1, "pendingMessageCount":1 } }, "Received Viber FILE message":{ "summary":"Received Viber FILE message", "value":{ "results":[ { "from":"385912345678", "to":"givenClient", "integrationType":"VIBER", "receivedAt":"2020-04-01T11:02:43.594+0000", "messageId":"1234567890123456789", "pairedMessageId":null, "callbackData":null, "message":{ "url":"https://example.com/givenUrl.pdf", "fileName":"givenFileName", "trackingData":"givenTrackingData", "type":"FILE" }, "price":{ "pricePerMessage":36.666667, "currency":"RUB" } } ], "messageCount":1, "pendingMessageCount":1 } }, "Received Facebook message":{ "summary":"Received Facebook message", "value":{ "results":[ { "from":"1234567891234567", "to":"987654321987654", "integrationType":"FACEBOOK", "receivedAt":"2020-03-31T16:13:59.142+0000", "messageId":"m_Bb2C5U8lYXqoN8ASsoi58LW9ID_zBzKWkzEmnthGcWOhCCK9r93h7onrN5HHvWtF9C4BzitxUtXQbtzCg3xNsw", "pairedMessageId":null, "callbackData":null, "message":{ "text":"givenText", "type":"TEXT" }, "price":{ "pricePerMessage":0.0, "currency":"MMK" } } ], "messageCount":1, "pendingMessageCount":845 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback" } } } } } }