{
"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:49.65866687Z"
},
"tags":[
{
"name":"customer-engagement",
"description":"Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.\n",
"x-type":"category",
"x-displayName":"Customer Engagement"
},
{
"name":"answers",
"description":"Answers is the Infobip fully-encompassed chatbot building platform that enables you to build, test, and deploy highly customized chatbots of different types. Multiple channels are supported on Answers like WhatsApp, Facebook Messenger, Live Chat, Apple Business Chat, Viber, Google Business Messaging and other. Communication with Bot is achieved through existing Conversations solution infrastructure which enables integration and switching between communicating with bot and a live agent. Processing can start by receiving MO message or by receiving a trigger event. Users can manage bots (create, update, delete, start and stop bots) through a web interface. For more details, visit the [Answers documentation](https://www.infobip.com/docs/answers).\n\nAnswers API is in Early access stage.\n",
"x-type":"product",
"x-displayName":"Answers"
},
{
"name":"answers-testing-start-test",
"description":"",
"x-type":"section",
"x-displayName":"Start Answers test"
},
{
"name":"answers-testing-stop-test",
"description":"",
"x-type":"section",
"x-displayName":"Stop Answers test"
},
{
"name":"answers-testing-send-message",
"description":"",
"x-type":"section",
"x-displayName":"Send inbound message to test"
},
{
"name":"answers-testing-receive-message",
"description":"",
"x-type":"section",
"x-displayName":"Receive testing message"
}
],
"paths":{
"/bots/1/testing/start":{
"post":{
"tags":[
"customer-engagement",
"answers",
"answers-testing-start-test"
],
"summary":"Start test",
"description":"Start the bot simulation to begin test scenario.",
"operationId":"start-test",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiError400"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"answers:manage",
"answers:testing"
],
"x-is-early-access":true
}
},
"/bots/1/testing/{testId}/stop":{
"post":{
"tags":[
"customer-engagement",
"answers",
"answers-testing-stop-test"
],
"summary":"Stop test",
"description":"Stop the bot simulation to finish test scenario.",
"operationId":"stop-test",
"parameters":[
{
"name":"testId",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
}
}
],
"responses":{
"204":{
"description":"No Content"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"answers:manage",
"answers:testing"
],
"x-is-early-access":true
}
},
"/bots/1/testing/{testId}/send-message":{
"post":{
"tags":[
"customer-engagement",
"answers",
"answers-testing-send-message"
],
"summary":"Send message",
"description":"Send inbound message to active test scenario.",
"operationId":"send-test-message",
"parameters":[
{
"name":"testId",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.InboundTestingRequest"
},
"examples":{
"default_whatsapp_text_inbound_message":{
"summary":"WhatsApp TEXT inbound message",
"value":{
"message":{
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_image_inbound_message":{
"summary":"WhatsApp IMAGE inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Image caption",
"type":"IMAGE"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_document_inbound_message":{
"summary":"WhatsApp DOCUMENT inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Document caption",
"type":"DOCUMENT"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_audio_inbound_message":{
"summary":"WhatsApp AUDIO inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Audio caption",
"type":"AUDIO"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_video_inbound_message":{
"summary":"WhatsApp VIDEO inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Video caption",
"type":"VIDEO"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_voice_inbound_message":{
"summary":"WhatsApp VOICE inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Voice caption",
"type":"VOICE"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_location_inbound_message":{
"summary":"WhatsApp LOCATION inbound message",
"value":{
"message":{
"content":{
"latitude":45.8428647,
"longitude":15.8819638,
"address":"Street address 20, Country",
"name":"Location name",
"url":"http://example.com",
"type":"LOCATION"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_quick_reply_inbound_message":{
"summary":"WhatsApp QUICK_REPLY inbound message",
"value":{
"message":{
"content":{
"text":"quick reply",
"payload":"payload",
"type":"QUICK_REPLY"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_button_reply_inbound_message":{
"summary":"WhatsApp BUTTON_REPLY inbound message",
"value":{
"message":{
"content":{
"id":"buttonId",
"title":"Button title",
"type":"BUTTON_REPLY"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_list_reply_inbound_message":{
"summary":"WhatsApp LIST_REPLY inbound message",
"value":{
"message":{
"content":{
"id":"itemId",
"title":"Item title",
"description":"Item description",
"type":"LIST_REPLY"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_flow_reply_inbound_message":{
"summary":"WhatsApp FLOW_REPLY inbound message",
"value":{
"message":{
"content":{
"text":"Flow reply",
"response":{
"key1":"value1",
"key2":"value2"
},
"type":"FLOW_REPLY"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_call_reply_inbound_message":{
"summary":"WhatsApp CALL_REPLY inbound message",
"value":{
"message":{
"content":{
"callResponseType":"ACCEPT",
"expiration":"2025-01-01T00:00:00.000+0000",
"type":"CALL_REPLY"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_order_inbound_message":{
"summary":"WhatsApp ORDER inbound message",
"value":{
"message":{
"content":{
"catalogId":"catalogId",
"items":[
{
"currency":"id",
"itemPrice":20,
"productRetailerId":"EUR",
"quantity":10
}
],
"text":"Order title",
"type":"ORDER"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_whatsapp_contact_inbound_message":{
"summary":"WhatsApp CONTACT inbound message",
"value":{
"message":{
"content":{
"contacts":[
{
"addresses":[
{
"street":"Street name 1",
"city":"city name",
"state":"state name",
"zip":"123123",
"country":"country name",
"countryCode":"HR",
"type":"home address"
}
],
"birthday":"2024-01-10",
"emails":[
{
"email":"example@example.com",
"type":"work email"
}
],
"name":{
"firstName":"John",
"lastName":"Doe",
"middleName":"Joe",
"nameSuffix":"PhD",
"namePrefix":"Dr.",
"formattedName":"Dr. John Doe"
},
"organisation":{
"company":"company name",
"department":"department name",
"title":"company title"
},
"phones":[
{
"phone":"38595112233",
"type":"work phone",
"waId":"waId"
}
],
"urls":[
{
"url":"https://example.com",
"type":"work url"
}
]
}
],
"type":"CONTACT"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
}
},
"default_live_chat_text_inbound_message":{
"summary":"Live Chat TEXT inbound message",
"value":{
"message":{
"content":{
"text":"Hello",
"type":"TEXT"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_live_chat_audio_inbound_message":{
"summary":"Live Chat AUDIO inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"type":"AUDIO"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_live_chat_video_inbound_message":{
"summary":"Live Chat VIDEO inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Video caption",
"type":"VIDEO"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_live_chat_document_inbound_message":{
"summary":"Live Chat DOCUMENT inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Document caption",
"type":"DOCUMENT"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_live_chat_image_inbound_message":{
"summary":"Live Chat IMAGE inbound message",
"value":{
"message":{
"content":{
"url":"https://example.com",
"caption":"Image caption",
"type":"IMAGE"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_live_chat_button_reply_inbound_message":{
"summary":"Live Chat BUTTON_REPLY inbound message",
"value":{
"message":{
"content":{
"text":"Button text",
"buttonPayloadType":"POSTBACK",
"payload":"Button reply payload",
"type":"BUTTON_REPLY"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_live_chat_bundle_inbound_message":{
"summary":"Live Chat BUNDLE inbound message",
"value":{
"message":{
"content":{
"content":{
"text":"Hello",
"type":"TEXT"
},
"type":"BUNDLE"
},
"channel":"LIVE_CHAT"
},
"userDestination":"38595112233"
}
},
"default_calls_start_call_inbound_message":{
"summary":"Calls START_CALL inbound message",
"value":{
"message":{
"content":{
"type":"START_CALL"
},
"channel":"CALLS"
},
"userDestination":"38595112233"
}
},
"default_calls_text_inbound_message":{
"summary":"Calls TEXT inbound message",
"value":{
"message":{
"content":{
"text":"Hello",
"interrupted":false,
"type":"TEXT"
},
"channel":"CALLS"
},
"userDestination":"38595112233"
}
},
"default_calls_hang_up_inbound_message":{
"summary":"Calls HANG_UP inbound message",
"value":{
"message":{
"content":{
"type":"HANG_UP"
},
"channel":"CALLS"
},
"userDestination":"38595112233"
}
},
"default_calls_dtmf_code_response_inbound_message":{
"summary":"Calls DTMF_CODE_RESPONSE inbound message",
"value":{
"message":{
"content":{
"text":"1",
"timeout":false,
"type":"DTMF_CODE_RESPONSE"
},
"channel":"CALLS"
},
"userDestination":"38595112233"
}
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"No Content"
},
"400":{
"$ref":"#/components/responses/ApiError400"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"answers:manage",
"answers:testing"
],
"x-is-early-access":true
}
}
},
"components":{
"schemas":{
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.BotInformationExample":{
"type":"object",
"description":"Details about bot.",
"properties":{
"botId":{
"type":"integer",
"format":"int64",
"description":"Bot identifier."
},
"botSender":{
"type":"string",
"description":"Bot sender."
},
"botName":{
"type":"string",
"description":"Bot name."
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingApiChannel"
},
"testId":{
"type":"integer",
"format":"int64",
"description":"Test identifier."
}
},
"required":[
"botId",
"botName",
"botSender",
"channel",
"testId"
],
"title":"BotInformationExample"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.ButtonPayloadType":{
"type":"string",
"enum":[
"URL",
"POSTBACK"
],
"title":"ButtonPayloadType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallResponseType":{
"type":"string",
"enum":[
"ACCEPT",
"REJECT"
],
"title":"CallResponseType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsDtmfInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"timeout":{
"type":"boolean"
}
}
}
],
"title":"CallsDtmfInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsDtmfMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"dtmfMaxCodeLength":{
"type":"integer",
"format":"int32"
},
"dtmfTerminator":{
"type":"string"
},
"timeoutSeconds":{
"type":"integer",
"format":"int32"
}
}
}
],
"title":"CallsDtmfMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsFileMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"title":"CallsFileMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsHangUpInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessageContent"
}
],
"title":"CallsHangUpInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsHangUpMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicMessageContent"
}
],
"title":"CallsHangUpMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsInboundMessageContentType":{
"type":"string",
"enum":[
"START_CALL",
"TEXT",
"HANG_UP",
"DTMF_CODE_RESPONSE"
],
"title":"CallsInboundMessageContentType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"FILE",
"HANG_UP",
"DTMF_CODE_REQUEST"
],
"title":"CallsMessageContentType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessage":{
"type":"object",
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessageContent"
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"CallsPublicInboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessageContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"START_CALL":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsStartCallInboundMessageContent",
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsTextInboundMessageContent",
"HANG_UP":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsHangUpInboundMessageContent",
"DTMF_CODE_RESPONSE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsDtmfInboundMessageContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsInboundMessageContentType"
}
},
"title":"CallsPublicInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicMessageContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsTextMessageContent",
"FILE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsFileMessageContent",
"HANG_UP":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsHangUpMessageContent",
"DTMF_CODE_REQUEST":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsDtmfMessageContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsMessageContentType"
}
},
"title":"CallsPublicMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicOutboundMessage":{
"type":"object",
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicMessageContent"
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"CallsPublicOutboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsStartCallInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessageContent"
}
],
"title":"CallsStartCallInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsTextInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"interrupted":{
"type":"boolean"
}
}
}
],
"title":"CallsTextInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsTextMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"canBeInterrupted":{
"type":"boolean"
}
}
}
],
"title":"CallsTextMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.Contact":{
"type":"object",
"properties":{
"name":{
"type":"string",
"maxLength":28,
"minLength":0
},
"phoneNumber":{
"type":"string",
"maxLength":18,
"minLength":0
}
},
"required":[
"name",
"phoneNumber"
],
"title":"Contact"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.DialogInformation":{
"type":"object",
"description":"Dialog in which the event occurred.",
"properties":{
"id":{
"type":"integer",
"format":"int64"
},
"name":{
"type":"string"
}
},
"required":[
"id",
"name"
],
"title":"DialogInformation"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.EventType":{
"type":"string",
"description":"The type of the event.",
"enum":[
"MESSAGE_SENT",
"GET_ATTRIBUTE_VALUE_QUESTION_SENT",
"CSAT_FEEDBACK_QUESTION_SENT",
"CSAT_FALLBACK_MESSAGE_SENT",
"CSAT_SCORE_QUESTION_SENT",
"CSAT_THANK_YOU_MESSAGE_SENT",
"PUI_REPEAT_MESSAGE_SENT",
"FALLBACK_MESSAGE_SENT",
"TIMEOUT_MESSAGE_SENT",
"INTERACTIVE_MESSAGE_SENT"
],
"title":"EventType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.InboundTestingRequest":{
"type":"object",
"example":{
"message":{
"content":{
"text":"Hello",
"type":"TEXT"
},
"channel":"WHATSAPP"
},
"userDestination":"38595112233"
},
"properties":{
"message":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicInboundMessage"
},
"userDestination":{
"type":"string",
"description":"Inbound message sender."
}
},
"required":[
"message",
"userDestination"
],
"title":"InboundTestingRequest"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAction":{
"type":"object",
"properties":{
"title":{
"type":"string"
},
"payload":{
"type":"string"
},
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatActionType"
}
},
"title":"LiveChatAction"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatActionType":{
"type":"string",
"enum":[
"URL",
"POSTBACK"
],
"title":"LiveChatActionType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAudioInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"type":"AUDIO"
},
"title":"LiveChatAudioInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAudioMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"title":"LiveChatAudioMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatBundleInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
}
}
}
],
"title":"LiveChatBundleInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatButtonMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"url":{
"type":"string"
},
"buttons":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAction"
}
}
}
}
],
"title":"LiveChatButtonMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatButtonReplyInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"buttonPayloadType":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.ButtonPayloadType"
},
"payload":{
"type":"string"
}
}
}
],
"example":{
"text":"Button text",
"buttonPayloadType":"POSTBACK",
"payload":"Button reply payload",
"type":"BUTTON_REPLY"
},
"title":"LiveChatButtonReplyInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatCarouselCard":{
"type":"object",
"properties":{
"title":{
"type":"string"
},
"image":{
"type":"string"
},
"imageUrl":{
"type":"string"
},
"actions":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAction"
}
}
},
"title":"LiveChatCarouselCard"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatCarouselMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"cards":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatCarouselCard"
}
},
"quickReplies":{
"type":"array",
"items":{
"type":"string"
}
}
}
}
],
"title":"LiveChatCarouselMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatDocumentInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Document caption",
"type":"DOCUMENT"
},
"title":"LiveChatDocumentInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatDocumentMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"title":"LiveChatDocumentMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatImageInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Image caption",
"type":"IMAGE"
},
"title":"LiveChatImageInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatImageMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"title":"LiveChatImageMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatInboundMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"AUDIO",
"VIDEO",
"DOCUMENT",
"IMAGE",
"BUTTON_REPLY",
"BUNDLE"
],
"title":"LiveChatInboundMessageContentType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"DOCUMENT",
"AUDIO",
"VIDEO",
"BUTTON",
"CAROUSEL"
],
"title":"LiveChatMessageContentType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessage":{
"type":"object",
"example":{
"content":{
"text":"Hello",
"type":"TEXT"
},
"channel":"LIVE_CHAT"
},
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"LiveChatPublicInboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatTextInboundMessageContent",
"AUDIO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAudioInboundMessageContent",
"VIDEO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatVideoInboundMessageContent",
"DOCUMENT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatDocumentInboundMessageContent",
"IMAGE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatImageInboundMessageContent",
"BUTTON_REPLY":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatButtonReplyInboundMessageContent",
"BUNDLE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatBundleInboundMessageContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatInboundMessageContentType"
}
},
"title":"LiveChatPublicInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatTextMessageContent",
"IMAGE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatImageMessageContent",
"DOCUMENT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatDocumentMessageContent",
"AUDIO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatAudioMessageContent",
"VIDEO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatVideoMessageContent",
"BUTTON":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatButtonMessageContent",
"CAROUSEL":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatCarouselMessageContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatMessageContentType"
}
},
"title":"LiveChatPublicMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicOutboundMessage":{
"type":"object",
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"LiveChatPublicOutboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatTextInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
}
}
}
],
"example":{
"text":"Hello",
"type":"TEXT"
},
"title":"LiveChatTextInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatTextMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
}
}
}
],
"title":"LiveChatTextMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatVideoInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Video caption",
"type":"VIDEO"
},
"title":"LiveChatVideoInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatVideoMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"title":"LiveChatVideoMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel":{
"type":"object",
"title":"MessageChannel"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.Product":{
"type":"object",
"properties":{
"currency":{
"type":"string"
},
"itemPrice":{
"type":"number"
},
"productRetailerId":{
"type":"string"
},
"quantity":{
"type":"integer",
"format":"int32"
}
},
"title":"Product"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicAnswersEventExample":{
"type":"object",
"properties":{
"accountKey":{
"type":"string",
"description":"Account key."
},
"sessionInformation":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.SessionInformationExample"
},
"timestamp":{
"type":"string",
"format":"date-time",
"description":"The timestamp of the event."
},
"lastDialog":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.DialogInformation"
},
"outboundMessage":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicOutboundMessage"
},
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.EventType"
}
},
"title":"PublicAnswersEventExample"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicInboundMessage":{
"type":"object",
"description":"Inbound message.",
"discriminator":{
"propertyName":"channel",
"mapping":{
"WHATSAPP":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessage",
"CALLS":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessage",
"LIVE_CHAT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessage"
}
},
"properties":{
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"PublicInboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicOutboundMessage":{
"type":"object",
"description":"Received testing message.",
"discriminator":{
"propertyName":"channel",
"mapping":{
"WHATSAPP":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicOutboundMessage",
"CALLS":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicOutboundMessage",
"LIVE_CHAT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicOutboundMessage"
}
},
"properties":{
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"PublicOutboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicWhatsAppListItem":{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"title":{
"type":"string"
},
"description":{
"type":"string"
}
},
"title":"PublicWhatsAppListItem"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicWhatsAppListSection":{
"type":"object",
"properties":{
"title":{
"type":"string"
},
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicWhatsAppListItem"
}
}
},
"title":"PublicWhatsAppListSection"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.SessionInformationExample":{
"type":"object",
"description":"Details about session.",
"properties":{
"botInformation":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.BotInformationExample"
},
"endUserDestination":{
"type":"string",
"description":"End-user destination."
},
"sessionId":{
"type":"string",
"format":"uuid",
"description":"Unique session identifier."
},
"externalId":{
"type":"string",
"description":"External identifier."
},
"externalMetadata":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"External metadata."
},
"callbackData":{
"type":"string",
"description":"Callback data from last received message."
}
},
"required":[
"botInformation",
"callbackData",
"endUserDestination",
"externalId",
"externalMetadata",
"sessionId"
],
"title":"SessionInformationExample"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingApiChannel":{
"type":"string",
"description":"Channel name.",
"enum":[
"WHATSAPP",
"LIVE_CHAT",
"CALLS"
],
"title":"TestingApiChannel"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartRequest":{
"type":"object",
"example":{
"botId":123,
"sender":"12343534",
"webhookUrl":"http://example.com"
},
"properties":{
"botId":{
"type":"integer",
"format":"int64",
"description":"Chatbot Id."
},
"sender":{
"type":"string",
"description":"Chatbot sender, if omitted will default to WEB_SIMULATION."
},
"webhookUrl":{
"type":"string",
"description":"Url to send bot test events."
}
},
"required":[
"botId",
"webhookUrl"
],
"title":"TestingStartRequest"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartResponse":{
"type":"object",
"example":{
"testId":123,
"sender":"12343534"
},
"properties":{
"testId":{
"type":"integer",
"format":"int64",
"description":"Test Id."
},
"sender":{
"type":"string",
"description":"Sender used in test."
}
},
"title":"TestingStartResponse"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppAudioInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Audio caption",
"type":"AUDIO"
},
"title":"WhatsAppAudioInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppAudioMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"title":"WhatsAppAudioMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppButtonAction":{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"title":{
"type":"string"
}
},
"title":"WhatsAppButtonAction"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppButtonMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"header":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader"
},
"body":{
"type":"string"
},
"footer":{
"type":"string"
},
"actions":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppButtonAction"
}
}
}
}
],
"title":"WhatsAppButtonMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppButtonReplyInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"title":{
"type":"string"
}
}
}
],
"example":{
"id":"buttonId",
"title":"Button title",
"type":"BUTTON_REPLY"
},
"title":"WhatsAppButtonReplyInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppCallReplyInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"callResponseType":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallResponseType"
},
"expiration":{
"type":"string",
"format":"date-time"
}
}
}
],
"example":{
"callResponseType":"ACCEPT",
"expiration":"2025-01-01T00:00:00Z",
"type":"CALL_REPLY"
},
"title":"WhatsAppCallReplyInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppContactInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"contacts":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.Contact"
}
}
}
}
],
"example":{
"contacts":[
{
"addresses":[
{
"street":"Street name 1",
"city":"city name",
"state":"state name",
"zip":"123123",
"country":"country name",
"countryCode":"HR",
"type":"home address"
}
],
"birthday":"2024-01-10",
"emails":[
{
"email":"example@example.com",
"type":"work email"
}
],
"name":{
"firstName":"John",
"lastName":"Doe",
"middleName":"Joe",
"nameSuffix":"PhD",
"namePrefix":"Dr.",
"formattedName":"Dr. John Doe"
},
"organisation":{
"company":"company name",
"department":"department name",
"title":"company title"
},
"phones":[
{
"phone":"38595112233",
"type":"work phone",
"waId":"waId"
}
],
"urls":[
{
"url":"https://example.com",
"type":"work url"
}
]
}
],
"type":"CONTACT"
},
"title":"WhatsAppContactInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppDocumentHeader":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"filename":{
"type":"string"
}
}
}
],
"title":"WhatsAppDocumentHeader"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppDocumentInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Document caption",
"type":"DOCUMENT"
},
"title":"WhatsAppDocumentInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppDocumentMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
},
"filename":{
"type":"string"
}
}
}
],
"title":"WhatsAppDocumentMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppFlowReplyInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"response":{
"type":"object",
"additionalProperties":{
"type":"object"
}
}
}
}
],
"example":{
"text":"Flow reply",
"response":{
"key1":"value1",
"key2":"value2"
},
"type":"FLOW_REPLY"
},
"title":"WhatsAppFlowReplyInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppTextHeader",
"IMAGE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppImageHeader",
"VIDEO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVideoHeader",
"DOCUMENT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppDocumentHeader"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeaderType"
}
},
"title":"WhatsAppHeader"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeaderType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"DOCUMENT"
],
"title":"WhatsAppHeaderType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppImageHeader":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"title":"WhatsAppImageHeader"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppImageInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Image caption",
"type":"IMAGE"
},
"title":"WhatsAppImageInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppImageMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"title":"WhatsAppImageMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppInboundMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"DOCUMENT",
"AUDIO",
"VIDEO",
"VOICE",
"LOCATION",
"QUICK_REPLY",
"BUTTON_REPLY",
"LIST_REPLY",
"FLOW_REPLY",
"CALL_REPLY",
"ORDER",
"CONTACT"
],
"title":"WhatsAppInboundMessageContentType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppListMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"header":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader"
},
"body":{
"type":"string"
},
"footer":{
"type":"string"
},
"button":{
"type":"string"
},
"sections":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicWhatsAppListSection"
}
}
}
}
],
"title":"WhatsAppListMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppListReplyInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"title":{
"type":"string"
},
"description":{
"type":"string"
}
}
}
],
"example":{
"id":"itemId",
"title":"Item title",
"description":"Item description",
"type":"LIST_REPLY"
},
"title":"WhatsAppListReplyInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppLocationInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"latitude":{
"type":"number",
"format":"double"
},
"longitude":{
"type":"number",
"format":"double"
},
"address":{
"type":"string"
},
"name":{
"type":"string"
},
"url":{
"type":"string"
}
}
}
],
"example":{
"latitude":45.8428647,
"longitude":15.8819638,
"address":"Street address 20, Country",
"name":"Location name",
"url":"http://example.com",
"type":"LOCATION"
},
"title":"WhatsAppLocationInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppLocationMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"latitude":{
"type":"number",
"format":"double"
},
"longitude":{
"type":"number",
"format":"double"
},
"name":{
"type":"string"
},
"address":{
"type":"string"
}
}
}
],
"title":"WhatsAppLocationMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppLocationRequestMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"body":{
"type":"string"
}
}
}
],
"title":"WhatsAppLocationRequestMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"DOCUMENT",
"AUDIO",
"VIDEO",
"URL_BUTTON",
"LOCATION",
"LOCATION_REQUEST",
"STICKER",
"BUTTON",
"LIST"
],
"title":"WhatsAppMessageContentType"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppOrderInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"catalogId":{
"type":"string"
},
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.Product"
}
},
"text":{
"type":"string"
}
}
}
],
"example":{
"catalogId":"catalogId",
"items":[
{
"currency":"EUR",
"itemPrice":20,
"productRetailerId":"id",
"quantity":10
}
],
"text":"Order title",
"type":"ORDER"
},
"title":"WhatsAppOrderInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessage":{
"type":"object",
"example":{
"content":{
"text":"Hello",
"type":"TEXT"
},
"channel":"WHATSAPP"
},
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"WhatsAppPublicInboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppTextInboundMessageContent",
"IMAGE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppImageInboundMessageContent",
"DOCUMENT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppDocumentInboundMessageContent",
"AUDIO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppAudioInboundMessageContent",
"VIDEO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVideoInboundMessageContent",
"VOICE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVoiceInboundMessageContent",
"LOCATION":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppLocationInboundMessageContent",
"QUICK_REPLY":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppQuickReplyInboundMessageContent",
"BUTTON_REPLY":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppButtonReplyInboundMessageContent",
"LIST_REPLY":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppListReplyInboundMessageContent",
"FLOW_REPLY":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppFlowReplyInboundMessageContent",
"CALL_REPLY":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppCallReplyInboundMessageContent",
"ORDER":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppOrderInboundMessageContent",
"CONTACT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppContactInboundMessageContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppInboundMessageContentType"
}
},
"title":"WhatsAppPublicInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppTextMessageContent",
"IMAGE":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppImageMessageContent",
"DOCUMENT":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppDocumentMessageContent",
"AUDIO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppAudioMessageContent",
"VIDEO":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVideoMessageContent",
"URL_BUTTON":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppUrlButtonMessageContent",
"LOCATION":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppLocationMessageContent",
"LOCATION_REQUEST":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppLocationRequestMessageContent",
"STICKER":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppStickerMessageContent",
"BUTTON":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppButtonMessageContent",
"LIST":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppListMessageContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppMessageContentType"
}
},
"title":"WhatsAppPublicMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicOutboundMessage":{
"type":"object",
"properties":{
"content":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
"channel":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel"
}
},
"title":"WhatsAppPublicOutboundMessage"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppQuickReplyInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"payload":{
"type":"string"
}
}
}
],
"example":{
"text":"quick reply",
"payload":"payload",
"type":"QUICK_REPLY"
},
"title":"WhatsAppQuickReplyInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppStickerMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"title":"WhatsAppStickerMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppTextHeader":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
}
}
}
],
"title":"WhatsAppTextHeader"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppTextInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
}
}
}
],
"example":{
"text":"Hello",
"type":"TEXT"
},
"title":"WhatsAppTextInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppTextMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string"
},
"showPreview":{
"type":"boolean"
}
}
}
],
"title":"WhatsAppTextMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppUrlButtonMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"header":{
"type":"string"
},
"body":{
"type":"string"
},
"footer":{
"type":"string"
},
"displayText":{
"type":"string"
},
"url":{
"type":"string"
}
}
}
],
"title":"WhatsAppUrlButtonMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVideoHeader":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppHeader"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
}
}
}
],
"title":"WhatsAppVideoHeader"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVideoInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Video caption",
"type":"VIDEO"
},
"title":"WhatsAppVideoInboundMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVideoMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"title":"WhatsAppVideoMessageContent"
},
"781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppVoiceInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessageContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string"
},
"caption":{
"type":"string"
}
}
}
],
"example":{
"url":"http://example.com",
"caption":"Voice caption",
"type":"VOICE"
},
"title":"WhatsAppVoiceInboundMessageContent"
},
"ApiError":{
"type":"object",
"properties":{
"errorCode":{
"type":"string",
"description":"An error code uniquely identifying the error case."
},
"description":{
"type":"string",
"description":"A detailed description of an error."
},
"action":{
"type":"string",
"description":"An action that should be taken to recover from the error."
},
"violations":{
"type":"array",
"description":"List of violations that caused the error.",
"items":{
"$ref":"#/components/schemas/ApiErrorViolation"
}
},
"resources":{
"type":"array",
"description":"List of available resources to recover from the error.",
"items":{
"$ref":"#/components/schemas/ApiErrorResource"
}
}
},
"required":[
"action",
"description",
"errorCode",
"resources",
"violations"
],
"title":"ApiError"
},
"ApiErrorResource":{
"type":"object",
"description":"List of available resources to recover from the error.",
"properties":{
"name":{
"type":"string",
"description":"Resource name."
},
"url":{
"type":"string",
"description":"Resource URL."
}
},
"title":"ApiErrorResource"
},
"ApiErrorViolation":{
"type":"object",
"description":"List of violations that caused the error.",
"properties":{
"property":{
"type":"string",
"description":"Request property that caused the error."
},
"violation":{
"type":"string",
"description":"Detailed violation description."
}
},
"title":"ApiErrorViolation"
}
},
"responses":{
"ApiError400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n\n"
}
}
},
"ApiError401":{
"description":"Unauthorized",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E401",
"description":"The request lacks valid authentication credentials for the requested resource.",
"action":"Check the resources and adjust authentication credentials.",
"violations":[],
"resources":[
{
"name":"API Authentication",
"url":"https://www.infobip.com/docs/essentials/api-authentication"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n"
}
}
},
"ApiError403":{
"description":"Forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E403",
"description":"Insufficient permissions to access the requested resource.",
"action":"Repeat the request with new or different credentials.",
"violations":[],
"resources":[
{
"name":"API Scopes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n"
}
}
},
"ApiError404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E404",
"description":"Not found - request URL doesn't exist on the API server or resource is not found.",
"action":"Check the resources and adjust your request.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E404\n Not found - request URL doesn't exist on the API server or resource is not found.\n Check the resources and adjust your request.\n \n \n\n"
}
}
},
"ApiError429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E429",
"description":"Too many requests sent.",
"action":"Check request rate limit specified in the API endpoint documentation resource.",
"violations":[],
"resources":[
{
"name":"Throttling handling errors",
"url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n"
}
}
},
"ApiError500":{
"description":"Internal Server Error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E500",
"description":"Something went wrong.",
"action":"Contact the support.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E500\n Something went wrong.\n Contact the 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-test-message":{
"post":{
"tags":[
"customer-engagement",
"answers",
"answers-testing-receive-message"
],
"summary":"Receive testing message",
"description":"Incoming test messages will be forwarded to this endpoint. For now supported channels are WhatsApp, Live Chat and Calls.",
"operationId":"receive-test-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicAnswersEventExample"
},
"examples":{
"default_whatsapp_text_event":{
"summary":"WhatsApp TEXT event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"text":"Hello",
"showPreview":false,
"type":"TEXT"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"TEXT"
]
}
},
"default_whatsapp_image_event":{
"summary":"WhatsApp IMAGE event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/image.jpg",
"caption":"image_caption",
"type":"IMAGE"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"IMAGE"
]
}
},
"default_whatsapp_document_event":{
"summary":"WhatsApp DOCUMENT event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/document.pdf",
"caption":"document_caption",
"filename":"document.pdf",
"type":"DOCUMENT"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"DOCUMENT"
]
}
},
"default_whatsapp_audio_event":{
"summary":"WhatsApp AUDIO event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/audio.mp3",
"type":"AUDIO"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"AUDIO"
]
}
},
"default_whatsapp_video_event":{
"summary":"WhatsApp VIDEO event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/video.mp4",
"caption":"video_caption",
"type":"VIDEO"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"VIDEO"
]
}
},
"default_whatsapp_url_button_event":{
"summary":"WhatsApp URL_BUTTON event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"header":"header",
"body":"body",
"footer":"footer",
"displayText":"display_text",
"url":"https://example.com/button/content",
"type":"URL_BUTTON"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"URL_BUTTON"
]
}
},
"default_whatsapp_location_event":{
"summary":"WhatsApp LOCATION event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"latitude":45.793668123,
"longitude":-73.123456789,
"name":"location_name",
"address":"location_address",
"type":"LOCATION"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"LOCATION"
]
}
},
"default_whatsapp_location_request_event":{
"summary":"WhatsApp LOCATION_REQUEST event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"body":"body",
"type":"LOCATION_REQUEST"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"LOCATION_REQUEST"
]
}
},
"default_whatsapp_sticker_event":{
"summary":"WhatsApp STICKER event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/sticker.png",
"type":"STICKER"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"STICKER"
]
}
},
"default_whatsapp_button_event":{
"summary":"WhatsApp BUTTON event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"header":{
"text":"header",
"type":"TEXT"
},
"body":"body",
"footer":"footer",
"actions":[
{
"id":"id",
"title":"title"
}
],
"type":"BUTTON"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"BUTTON"
]
}
},
"default_whatsapp_list_event":{
"summary":"WhatsApp LIST event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"header":{
"text":"header",
"type":"TEXT"
},
"body":"body",
"footer":"footer",
"button":"button",
"sections":[
{
"title":"title",
"items":[
{
"id":"id",
"title":"title",
"description":"description"
}
]
}
],
"type":"LIST"
},
"channel":"WHATSAPP"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"WhatsApp"
],
"message type":[
"LIST"
]
}
},
"default_live_chat_text_event":{
"summary":"Live Chat TEXT event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"text":"Hello",
"type":"TEXT"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"TEXT"
]
}
},
"default_live_chat_image_event":{
"summary":"Live Chat IMAGE event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/image.jpg",
"caption":"image_caption",
"type":"IMAGE"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"IMAGE"
]
}
},
"default_live_chat_document_event":{
"summary":"Live Chat DOCUMENT event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/document.pdf",
"caption":"document_caption",
"type":"DOCUMENT"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"DOCUMENT"
]
}
},
"default_live_chat_audio_event":{
"summary":"Live Chat AUDIO event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/audio.mp3",
"type":"AUDIO"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"AUDIO"
]
}
},
"default_live_chat_video_event":{
"summary":"Live Chat VIDEO event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/video.mp4",
"caption":"video_caption",
"type":"VIDEO"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"VIDEO"
]
}
},
"default_live_chat_button_event":{
"summary":"Live Chat BUTTON event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"text":"text",
"url":"https://example.com/",
"buttons":[
{
"title":"title",
"payload":"payload",
"type":"URL"
}
],
"type":"BUTTON"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"BUTTON"
]
}
},
"default_live_chat_carousel_event":{
"summary":"Live Chat CAROUSEL event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"cards":[
{
"title":"title",
"image":"image",
"imageUrl":"url",
"actions":[
{
"title":"title",
"payload":"payload",
"type":"URL"
}
]
}
],
"quickReplies":[
"reply"
],
"type":"CAROUSEL"
},
"channel":"LIVE_CHAT"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Live Chat"
],
"message type":[
"CAROUSEL"
]
}
},
"default_calls_text_event":{
"summary":"Calls TEXT event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"text":"Hello",
"canBeInterrupted":false,
"type":"TEXT"
},
"channel":"CALLS"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Calls"
],
"message type":[
"TEXT"
]
}
},
"default_calls_file_event":{
"summary":"Calls FILE event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"url":"https://example.com/file.pdf",
"type":"FILE"
},
"channel":"CALLS"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Calls"
],
"message type":[
"FILE"
]
}
},
"default_calls_hang_up_event":{
"summary":"Calls HANG_UP event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"type":"HANG_UP"
},
"channel":"CALLS"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Calls"
],
"message type":[
"HANG_UP"
]
}
},
"default_calls_dtmf_code_request_event":{
"summary":"Calls DTMF_CODE_REQUEST event",
"value":{
"accountKey":"6828B51B5FC42873D3E5434FA42F62FF",
"sessionInformation":{
"botInformation":{
"botId":1,
"botSender":"WEB_SIMULATION",
"botName":"testing bot",
"channel":"WHATSAPP",
"testId":12345
},
"endUserDestination":"38595112233",
"sessionId":"123e4567-e89b-12d3-a456-426614174000",
"externalId":"TESTING",
"externalMetadata":{},
"callbackData":"callback_data_example"
},
"timestamp":"2023-01-01T00:00:00.000+0000",
"lastDialog":{
"id":1,
"name":"dialog_name"
},
"outboundMessage":{
"content":{
"text":"Hello",
"dtmfMaxCodeLength":10,
"dtmfTerminator":"#",
"timeoutSeconds":15,
"type":"DTMF_CODE_REQUEST"
},
"channel":"CALLS"
},
"type":"MESSAGE_SENT"
},
"x-label":{
"channel":[
"Calls"
],
"message type":[
"DTMF_CODE_REQUEST"
]
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
},
"x-is-early-access":true
}
}
}
}