{
"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.109269417Z"
},
"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":"whatsapp",
"description":"With 2 billion users, WhatsApp is the most used application worldwide. It enables you to reach more customers, sharing important and timely notifications, as well as provide real-time customer support. Infobip is an official WhatsApp Business solution provider. Send and manage WhatsApp messages over Infobip's WhatsApp API.\n\nTo utilize WhatsApp in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n\n[Learn more about WhatsApp channel and use cases](https://www.infobip.com/docs/whatsapp).\n",
"x-type":"product",
"x-displayName":"WhatsApp"
},
{
"name":"whatsapp-outbound-messages",
"description":"When you send a WhatsApp message to a phone number belonging to an end user's device you are sending an outbound WhatsApp message. \nThere are several types of WhatsApp messages:\n - Template message – use a pre-defined template to send text, images, videos, share location, documents, attach buttons, and configure SMS failover.\n - Free-form text or media – use it only when contacted by the end user within a certain timeframe to send text, images, audio, video, stickers, share location, or contacts.\n - Interactive messages – send a message that your end user can interact with, such as interactive buttons, lists, or product messages.\n",
"x-type":"module",
"x-displayName":"Outbound messages"
},
{
"name":"whatsapp-template-message",
"description":"",
"x-type":"section",
"x-displayName":"Template Message"
},
{
"name":"whatsapp-text-and-media-messages",
"description":"",
"x-type":"section",
"x-displayName":"Text and media messages"
},
{
"name":"send-whatsapp-interactive-messages",
"description":"",
"x-type":"section",
"x-displayName":"Interactive messages"
},
{
"name":"whatsapp-events",
"description":"",
"x-type":"section",
"x-displayName":"Events"
},
{
"name":"whatsapp-inbound-messages",
"description":"When the end user sends a WhatsApp from their device to a phone number, they have sent an inbound WhatsApp message. \nThe inbound message is routed to the Infobip Platform and Infobip in turn routes the message to its customer who has registered the WhatsApp sender.\nTypical supporting features you’d use with inbound messages are:\n - Marking messages as read to communicate to the end user that you have read their message.\n - Downloading media and its metadata sent over by the end user.\n",
"x-type":"module",
"x-displayName":"Inbound messages"
},
{
"name":"whatsapp-receive-inbound-message",
"description":"",
"x-type":"section",
"x-displayName":"Receive inbound message"
},
{
"name":"whatsapp-get-inbound-media",
"description":"",
"x-type":"section",
"x-displayName":"Get inbound media"
},
{
"name":"whatsapp-mark-message-as-read",
"description":"",
"x-type":"section",
"x-displayName":"Mark message as read"
},
{
"name":"whatsapp-message-status-reports",
"description":"Status Reports tell you what happened to the WhatsApp message you sent, whether it was successfully delivered or failed to be delivered, whether it’s been seen. \nStatus Reports can be pushed in real time to a customer's webhook or can be retrieved by an API call. \nLogs provide similar information to Status Reports but are only available to query for 48hrs.\nThere are a few reports you can set up for your WhatsApp messaging:\n - Delivery Reports - In case of a failure, you’ll receive a timestamp with a delivery failure message and a status code indicating the reason behind it.\n - Seen Reports – In case the message has been delivered successfully to the end user, this report will additionally inform you whether the message has been seen.\n - Payments - It provides all updates to your payment transaction in real time. It's also possible to fetch current state of the payment transaction in any time.\n",
"x-type":"module",
"x-displayName":"Message Status Reports"
},
{
"name":"whatsapp-status-reports",
"description":"",
"x-type":"section",
"x-displayName":"Status Reports"
},
{
"name":"whatsapp-payments",
"description":"",
"x-type":"section",
"x-displayName":"Payments"
},
{
"name":"whatsapp-marketing-update",
"description":"",
"x-type":"section",
"x-displayName":"Marketing Update"
},
{
"name":"whatsapp-service-management",
"description":"As opposed to free-form messages, template messages can be sent and delivered at any time. \nHere, you can manage your templates, from template registration, retrieving template statuses, to deleting existing templates.\nWith each WhatsApp message, you can send various types of media. Here, you can manage your media and configure additional feature enhancing their functionality.\nMoreover you can fetch quality and business info of your senders.\n",
"x-type":"module",
"x-displayName":"Service Management"
},
{
"name":"whatsapp-template-management",
"description":"",
"x-type":"section",
"x-displayName":"Template Management"
},
{
"name":"whatsapp-flow-management",
"description":"",
"x-type":"section",
"x-displayName":"Flow Management"
},
{
"name":"whatsapp-media-management",
"description":"",
"x-type":"section",
"x-displayName":"Media Management"
},
{
"name":"whatsapp-sender-management",
"description":"",
"x-type":"section",
"x-displayName":"Sender Management"
},
{
"name":"whatsapp-bulk-sender-registration",
"description":"",
"x-type":"section",
"x-displayName":"Bulk Sender Registration"
},
{
"name":"whatsapp-identity-management",
"description":"Set up identity change, an add-on available for senders hosted by Infobip. This is supported for interactive buttons, interactive lists, or an interactive product message. \nIdentity change allows you to increase your security by preventing messages from being sent to unverified end users. \nOnce enabled for a sender, you would receive notifications when an end user's WhatsApp account (MSISDN) has potentially been transferred to a different user. \nWhen a potential identity change has been detected, the outbound traffic towards that end user is blocked until you verify the user outside the channel and acknowledge the change.\nContact your Account Executive for more information.\n",
"x-type":"module",
"x-displayName":"Identity Management"
},
{
"name":"whatsapp-ad-conversions",
"description":"The Conversions API for Business Messaging enables advertisers to consolidate web, app, physical store, and business messaging events into a single endpoint for Meta. With Infobip, you can submit Purchase or LeadSubmitted conversion events for WhatsApp.\n",
"x-type":"module",
"x-displayName":"Ad Conversions"
}
],
"paths":{
"/whatsapp/1/message/template":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-template-message"
],
"summary":"Send WhatsApp template message",
"description":"Send a single or multiple template messages to one or more recipients. Template messages can be sent and delivered at anytime. Each template needs to be registered and pre-approved by WhatsApp.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-template-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessage"
},
"examples":{
"Body template message":{
"summary":"Body template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1",
"Placeholder Value 2"
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Text header template message":{
"summary":"Text header template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"header":{
"type":"TEXT",
"placeholder":"placeholder value"
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Document header template message":{
"summary":"Document header template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"header":{
"type":"DOCUMENT",
"mediaUrl":"http://example.com/document",
"filename":"document.pdf"
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Image header template message":{
"summary":"Image header template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"header":{
"type":"IMAGE",
"mediaUrl":"http://example.com/image"
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Video header template message":{
"summary":"Video header template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"header":{
"type":"VIDEO",
"mediaUrl":"http://example.com/video"
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Location header template message":{
"summary":"Location header template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"header":{
"type":"LOCATION",
"latitude":45.79359,
"longitude":15.94613
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Quick reply button template message":{
"summary":"Quick reply button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"QUICK_REPLY",
"parameter":"Yes"
},
{
"type":"QUICK_REPLY",
"parameter":"No"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Coupon template message":{
"summary":"Coupon template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"COPY_CODE",
"parameter":"exampleCode"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Dynamic URL button template message":{
"summary":"Dynamic URL button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"URL",
"parameter":"docs"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Static URL button template message":{
"summary":"Static URL button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1"
]
},
"buttons":[]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Template message with SMS failover":{
"summary":"Template message with SMS failover",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1"
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
},
"smsFailover":{
"from":"InfoSMS",
"text":"SMS message to be sent if WhatsApp template message could not be delivered."
}
}
]
}
},
"Bulk template messages":{
"summary":"Bulk template messages",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1"
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
},
{
"from":"441134960000",
"to":"441134960002",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381db",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1"
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
],
"bulkId":"BULK-ID-123-xyz"
}
},
"Authentication with one-tap button template message":{
"summary":"Authentication with one-tap button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Authentication Code Value"
]
},
"buttons":[
{
"type":"URL",
"parameter":"Authentication Code Value"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Authentication with copy code button template message":{
"summary":"Authentication with copy code button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Authentication Code Value"
]
},
"buttons":[
{
"type":"URL",
"parameter":"Authentication Code Value"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Carousel message":{
"summary":"Carousel message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"carousel":{
"cards":[
{
"header":{
"type":"IMAGE",
"mediaUrl":"http://example.com/image"
}
}
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Carousel message with buttons in card":{
"summary":"Carousel message with buttons in card",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"carousel":{
"cards":[
{
"header":{
"type":"IMAGE",
"mediaUrl":"http://example.com/image"
},
"buttons":[
{
"type":"QUICK_REPLY",
"parameter":"Yes"
},
{
"type":"QUICK_REPLY",
"parameter":"No"
}
]
}
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Limited-time offer without expiration time":{
"summary":"Limited-time offer without expiration time",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1"
]
},
"buttons":[
{
"type":"URL",
"parameter":"docs"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Limited-time offer with expiration time":{
"summary":"Limited-time offer with expiration time",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[
"Placeholder Value 1"
]
},
"buttons":[
{
"type":"COPY_CODE",
"parameter":"exampleCode"
},
{
"type":"URL",
"parameter":"docs"
}
],
"limitedTimeOffer":{
"expirationTime":"2030-01-01T10:00:00.000Z"
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Flow button template message":{
"summary":"Flow button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"FLOW"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Flow button with flow token and data template message":{
"summary":"Flow button with flow token and data template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"FLOW",
"flowToken":"Flow token",
"data":{
"key":"value",
"key2":"value2"
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Catalog button template message":{
"summary":"Catalog button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"CATALOG",
"thumbnailProductRetailerId":"qihxicpdu3"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Catalog button template message without optional fields":{
"summary":"Catalog button template message without optional fields",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"CATALOG"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Multi Product button template message":{
"summary":"Multi Product button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"MULTI_PRODUCT",
"thumbnailProductRetailerId":"qihxicpdu3",
"sections":[
{
"title":"Title",
"productRetailerIds":[
"1",
"2"
]
}
]
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Multi Product button template message without optional fields":{
"summary":"Multi Product button template message without optional fields",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"MULTI_PRODUCT",
"sections":[
{
"title":"Title",
"productRetailerIds":[
"1",
"2"
]
}
]
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for Brazil Pix DC button template message":{
"summary":"Order Details for Brazil Pix DC button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"BRAZIL_PIX_DC",
"id":"fd3e847h2",
"code":"00020101021226900014br.gov.bcb.pix2568pix",
"merchantName":"Company Name",
"keyType":"CNPJ",
"key":"01234567891234"
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for Brazil Link button template message":{
"summary":"Order Details for Brazil Link button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"BRAZIL_LINK",
"id":"fd3e847h2",
"paymentLink":"https://example.com/payment-link"
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for Brazil Boleto button template message":{
"summary":"Order Details for Brazil Boleto button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"BRAZIL_BOLETO",
"id":"fd3e847h2",
"code":"03399026944140000002628346101018898510000008848"
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for Brazil Payments button template message":{
"summary":"Order Details for Brazil Payments button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"BRAZIL_PAYMENTS",
"payments":[
{
"type":"BRAZIL_PIX_DC",
"id":"fd3e847h2",
"code":"00020101021226900014br.gov.bcb.pix2568pix",
"merchantName":"Company Name",
"keyType":"CNPJ",
"key":"01234567891234"
},
{
"type":"BRAZIL_BOLETO",
"id":"fd3e847h2",
"code":"03399026944140000002628346101018898510000008848"
}
]
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for PG PayU button template message":{
"summary":"Order Details for PG PayU button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"PG_PAYU",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4"
]
},
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for PG Razorpay button template message":{
"summary":"Order Details for PG Razorpay button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"PG_RAZORPAY",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"callbackData":{
"key0":"customData1",
"key1":"customData2",
"key2":"customData3",
"key3":"customData4",
"key4":"customData5",
"key5":"customData6",
"key6":"customData7",
"key7":"customData8",
"key8":"customData9",
"key9":"customData10",
"key10":"customData11",
"key11":"customData12",
"key12":"customData13",
"key13":"customData14",
"key14":"customData15"
}
},
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for UPI Intent Link button template message":{
"summary":"Order Details for UPI Intent Link button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"UPI_INTENT",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"format":{
"type":"LINK",
"paymentLink":"upi://pay?pa=example@upi&pn=Example%20Merchant&mc=4722&&tr=1234567890"
}
},
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Details for UPI Link button template message":{
"summary":"Order Details for UPI Link button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"action":{
"payment":{
"type":"UPI_LINK",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"paymentLink":"https://payment.example.com/upi-link"
},
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
}
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Order Status template message":{
"summary":"Order Status template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"orderStatus":{
"orderStatuses":[
{
"type":"ORDER_STATUS",
"payment":{
"type":"UPI_INTENT",
"id":"paymentId"
},
"status":"PROCESSING",
"description":"Order status description"
}
]
}
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
},
"Voice call button template message":{
"summary":"Voice call button template message",
"value":{
"messages":[
{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"templateName":"template_name",
"templateData":{
"body":{
"placeholders":[]
},
"buttons":[
{
"type":"VOICE_CALL",
"callValidityPeriod":1440,
"callContextPayload":"context-payload"
}
]
},
"language":"en_GB"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"messages":[
{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
],
"bulkId":"2034072219640523073"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Extra whitespaces error response":{
"summary":"Extra whitespaces error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.templateData.header.placeholder":[
"cannot have new-line/tab characters or more than 4 consecutive spaces"
]
}
}
}
}
},
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.templateData.header.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Filename validation error response":{
"summary":"Filename validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.templateData.header.filename":[
"size must be between 1 and 240"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/text":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp text message",
"description":"Send a text message to a single recipient. Text messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-text-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextMessage"
},
"examples":{
"Text message":{
"summary":"Text message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"text":"Some text"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Text message with previewable url":{
"summary":"Text message with previewable url",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"text":"Some text with url: http://example.com",
"previewUrl":true
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":false
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Text validation error response":{
"summary":"Text validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.text":[
"size must be between 1 and 4096",
"must not be blank"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/document":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp document message",
"description":"Send a document to a single recipient. Document messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-document-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentMessage"
},
"examples":{
"Document message":{
"summary":"Document message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/document"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Document message with all fields":{
"summary":"Document message with all fields",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/document",
"caption":"Some document caption",
"filename":"filename.pdf"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Caption validation error response":{
"summary":"Caption validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.caption":[
"size must be between 0 and 3000"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/image":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp image message",
"description":"Send an image to a single recipient. Image messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-image-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMessage"
},
"examples":{
"Image message":{
"summary":"Image message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/image"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Image message with caption":{
"summary":"Image message with caption",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/image",
"caption":"Some image caption"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Caption validation error response":{
"summary":"Caption validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.caption":[
"size must be between 0 and 3000"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/audio":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp audio message",
"description":"Send an audio to a single recipient. Audio messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-audio-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioMessage"
},
"examples":{
"Audio message":{
"summary":"Audio message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/audio"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
},
"Voice note":{
"summary":"Voice note",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/voice.ogg",
"voice":true
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/video":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp video message",
"description":"Send a video to a single recipient. Video messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-video-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMessage"
},
"examples":{
"Video message":{
"summary":"Video message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/video"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Video message with caption":{
"summary":"Video message with caption",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/video",
"caption":"Some video caption"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Caption validation error response":{
"summary":"Caption validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.caption":[
"size must be between 0 and 3000"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/sticker":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp sticker message",
"description":"Send a sticker to a single recipient. Sticker messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-sticker-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerMessage"
},
"examples":{
"Sticker message":{
"summary":"Sticker message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"mediaUrl":"http://example.com/sticker"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/location":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp location message",
"description":"Send a location to a single recipient. Location messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-location-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationMessage"
},
"examples":{
"Location message":{
"summary":"Location message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"latitude":44.9526862,
"longitude":13.8545217
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
},
"Location message with all fields":{
"summary":"Location message with all fields",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"latitude":44.9526862,
"longitude":13.8545217,
"name":"Infobip",
"address":"Vodnjan, Croatia"
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Location validation error response":{
"summary":"Location validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.latitude":[
"must be greater than or equal to -90"
],
"content.longitude":[
"must be less than or equal to 180"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/contact":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-text-and-media-messages"
],
"summary":"Send WhatsApp contact message",
"description":"Send a contact to a single recipient. Contact messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-contact-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsMessage"
},
"examples":{
"Single contact message":{
"summary":"Single contact message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"contacts":[
{
"addresses":[
{
"street":"Istarska",
"city":"Vodnjan",
"zip":"52215",
"country":"Croatia",
"countryCode":"HR",
"type":"WORK"
},
{
"street":"Istarska",
"city":"Vodnjan",
"zip":"52215",
"country":"Croatia",
"countryCode":"HR",
"type":"HOME"
}
],
"birthday":"2010-01-01",
"emails":[
{
"email":"John.Smith@example.com",
"type":"WORK"
},
{
"email":"John.Smith.priv@example.com",
"type":"HOME"
}
],
"name":{
"firstName":"John",
"lastName":"Smith",
"middleName":"B",
"namePrefix":"Mr.",
"formattedName":"Mr. John Smith"
},
"org":{
"company":"Company Name",
"department":"Department",
"title":"Director"
},
"phones":[
{
"phone":"+441134960019",
"type":"HOME",
"waId":"441134960019"
},
{
"phone":"+441134960000",
"type":"WORK",
"waId":"441134960000"
}
],
"urls":[
{
"url":"http://example.com/John.Smith",
"type":"WORK"
},
{
"url":"http://example.com/home/John.Smith",
"type":"HOME"
}
]
}
]
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
},
"Multiple contacts message":{
"summary":"Multiple contacts message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"contacts":[
{
"addresses":[
{
"street":"Istarska",
"city":"Vodnjan",
"zip":"52215",
"country":"Croatia",
"countryCode":"HR",
"type":"WORK"
},
{
"street":"Istarska",
"city":"Vodnjan",
"zip":"52215",
"country":"Croatia",
"countryCode":"HR",
"type":"HOME"
}
],
"birthday":"2010-01-01",
"emails":[
{
"email":"John.Smith@example.com",
"type":"WORK"
},
{
"email":"John.Smith.priv@example.com",
"type":"HOME"
}
],
"name":{
"firstName":"John",
"lastName":"Smith",
"middleName":"B",
"namePrefix":"Mr.",
"formattedName":"Mr. John Smith"
},
"org":{
"company":"Company Name",
"department":"Department",
"title":"Director"
},
"phones":[
{
"phone":"+441134960019",
"type":"HOME",
"waId":"441134960019"
},
{
"phone":"+441134960000",
"type":"WORK",
"waId":"441134960000"
}
],
"urls":[
{
"url":"http://example.com/John.Smith",
"type":"WORK"
},
{
"url":"http://example.com/home/John.Smith",
"type":"HOME"
}
]
},
{
"addresses":[
{
"street":"Istarska",
"city":"Vodnjan",
"zip":"52215",
"country":"Croatia",
"countryCode":"HR",
"type":"WORK"
},
{
"street":"Istarska",
"city":"Vodnjan",
"zip":"52215",
"country":"Croatia",
"countryCode":"HR",
"type":"HOME"
}
],
"birthday":"2010-01-01",
"emails":[
{
"email":"Alexander.Abraham@example.com",
"type":"WORK"
},
{
"email":"Alexander.Abraham.priv@example.com",
"type":"HOME"
}
],
"name":{
"firstName":"Alexander",
"lastName":"Abraham",
"middleName":"B",
"namePrefix":"Mr.",
"formattedName":"Mr. Alexander Abraham"
},
"org":{
"company":"Company Name",
"department":"Department",
"title":"Director"
},
"phones":[
{
"phone":"+441134960010",
"type":"HOME",
"waId":"441134960010"
},
{
"phone":"+441134960011",
"type":"WORK",
"waId":"441134960011"
}
],
"urls":[
{
"url":"http://example.com/Alexander.Abraham",
"type":"WORK"
},
{
"url":"http://example.com/home/Alexander.Abraham",
"type":"HOME"
}
]
}
]
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Incorrect date format error response":{
"summary":"Incorrect date format error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.contacts[0].birthday":[
"must be in the YYYY-MM-DD format"
]
}
}
}
}
},
"Incorrect email error response":{
"summary":"Incorrect email error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.contacts[0].emails[0].email":[
"must be a well-formed email address"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/buttons":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive buttons message",
"description":"Send an interactive buttons message to a single recipient. Interactive buttons messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-buttons-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsMessage"
},
"examples":{
"Interactive reply buttons message":{
"summary":"Interactive reply buttons message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"buttons":[
{
"type":"REPLY",
"id":"1",
"title":"Yes"
},
{
"type":"REPLY",
"id":"2",
"title":"No"
}
]
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Text header interactive reply buttons message":{
"summary":"Text header interactive reply buttons message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"buttons":[
{
"type":"REPLY",
"id":"1",
"title":"Yes"
},
{
"type":"REPLY",
"id":"2",
"title":"No"
}
]
},
"header":{
"type":"TEXT",
"text":"Header"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Video header interactive reply buttons message":{
"summary":"Video header interactive reply buttons message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"buttons":[
{
"type":"REPLY",
"id":"1",
"title":"Yes"
},
{
"type":"REPLY",
"id":"2",
"title":"No"
}
]
},
"header":{
"type":"VIDEO",
"mediaUrl":"https://example.com/video"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Image header interactive reply buttons message":{
"summary":"Image header interactive reply buttons message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"buttons":[
{
"type":"REPLY",
"id":"1",
"title":"Yes"
},
{
"type":"REPLY",
"id":"2",
"title":"No"
}
]
},
"header":{
"type":"IMAGE",
"mediaUrl":"https://example.com/image"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Document header interactive reply buttons message":{
"summary":"Document header interactive reply buttons message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"buttons":[
{
"type":"REPLY",
"id":"1",
"title":"Yes"
},
{
"type":"REPLY",
"id":"2",
"title":"No"
}
]
},
"header":{
"type":"DOCUMENT",
"mediaUrl":"https://example.com/document",
"filename":"document.pdf"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.header.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Body text validation error response":{
"summary":"Body text validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.body.text":[
"size must be between 1 and 1024",
"must not be blank"
]
}
}
}
}
},
"Buttons validation error response":{
"summary":"Buttons validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.buttons":[
"ids and titles must be unique",
"size must be between 1 and 3"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/list":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive list message",
"description":"Send an interactive list message to a single recipient. Interactive list messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-list-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListMessage"
},
"examples":{
"Interactive list message":{
"summary":"Interactive list message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"title":"Choose one",
"sections":[
{
"rows":[
{
"id":"1",
"title":"row title"
}
]
}
]
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Header interactive list message":{
"summary":"Header interactive list message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"title":"Choose one",
"sections":[
{
"title":"First section title",
"rows":[
{
"id":"1",
"title":"first row title",
"description":"first row description"
},
{
"id":"2",
"title":"second row title",
"description":"second row description"
}
]
},
{
"title":"Second section title",
"rows":[
{
"id":"3",
"title":"third row title"
}
]
}
]
},
"header":{
"type":"TEXT",
"text":"Header"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Header text validation error response":{
"summary":"Header text validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.header.text":[
"size must be between 1 and 60",
"must not be blank"
]
}
}
}
}
},
"Sections validation error response":{
"summary":"Sections validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.sections":[
"number of rows must be between 1 and 10",
"row's ids must be unique across sections",
"titles must not be blank when more than one section provided"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/media-carousel":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive media carousel message",
"description":"Send an interactive media carousel message to a single recipient. Interactive media carousel messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-media-carousel-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselMessage"
},
"examples":{
"Interactive media carousel message with url button":{
"summary":"Interactive media carousel message with url button",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"cards":[
{
"header":{
"url":"https://www.example.com/image.png",
"type":"IMAGE"
},
"body":{
"text":"Some text"
},
"button":{
"displayText":"some button text",
"url":"https://www.example.com"
}
},
{
"header":{
"url":"https://www.example.com/image.png",
"type":"IMAGE"
},
"body":{
"text":"Some text"
},
"button":{
"displayText":"some button text",
"url":"https://www.example.com"
}
}
],
"type":"URL"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Header interactive media carousel message":{
"summary":"Header interactive media carousel message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"cards":[
{
"header":{
"url":"https://www.example.com/image.png",
"type":"IMAGE"
},
"body":{
"text":"Some text"
},
"buttons":[
{
"id":"some button id",
"title":"some button title"
}
]
},
{
"header":{
"url":"https://www.example.com/image.png",
"type":"IMAGE"
},
"body":{
"text":"Some text"
},
"buttons":[
{
"id":"some button id",
"title":"some button title"
}
]
}
],
"type":"QUICK_REPLY"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Action cards validation error response":{
"summary":"Action cards validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.cards":[
"size must be between 2 and 10"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/location-request":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive location request message",
"description":"Send an interactive location request message to a single recipient. Interactive location request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-location-request-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestMessage"
},
"examples":{
"Interactive location request message":{
"summary":"Interactive location request message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/product":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive product message",
"description":"Send an interactive product message to a single recipient. Interactive product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-product-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductMessage"
},
"examples":{
"Interactive product message":{
"summary":"Interactive product message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"catalogId":"1",
"productRetailerId":"2"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Body interactive product message":{
"summary":"Body interactive product message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"catalogId":"1",
"productRetailerId":"2"
},
"body":{
"text":"Some text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Footer interactive product message":{
"summary":"Footer interactive product message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"catalogId":"1",
"productRetailerId":"2"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Body and footer interactive product message":{
"summary":"Body and footer interactive product message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"catalogId":"1",
"productRetailerId":"2"
},
"body":{
"text":"Some text"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Footer text validation error response":{
"summary":"Footer text validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.footer.text":[
"size must be between 1 and 60",
"must not be blank"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/multi-product":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive multi-product message",
"description":"Send an interactive multi-product message to a single recipient. Interactive multi-product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-multi-product-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductMessage"
},
"examples":{
"Interactive multi-product message":{
"summary":"Interactive multi-product message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"header":{
"type":"TEXT",
"text":"Header"
},
"body":{
"text":"Some text"
},
"action":{
"catalogId":"1",
"sections":[
{
"title":"Title",
"productRetailerIds":[
"1",
"2"
]
}
]
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Footer interactive multi-product message":{
"summary":"Footer interactive multi-product message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"header":{
"type":"TEXT",
"text":"Header"
},
"body":{
"text":"Some text"
},
"action":{
"catalogId":"1",
"sections":[
{
"title":"Title",
"productRetailerIds":[
"1",
"2"
]
}
]
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Footer text validation error response":{
"summary":"Footer text validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.footer.text":[
"size must be between 1 and 60",
"must not be blank"
]
}
}
}
}
},
"Sections validation error response":{
"summary":"Sections validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.sections":[
"size must be between 1 and 10",
"titles must not be blank when more than one section provided",
"number of products must be between 1 and 30"
]
}
}
}
}
},
"Product retailer ids validation error response":{
"summary":"Product retailer ids validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.sections[0].productRetailerIds":[
"products in section must be unique"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/order-details":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive order-details message",
"description":"Send an interactive order-details message to a single recipient.
An order-details message is a structured message containing essential information about the customer's selected products. Alternatively, a [single](#channels/whatsapp/send-whatsapp-interactive-product-message) or [multi-product](#channels/whatsapp/send-whatsapp-interactive-multi-product-message) interactive message can serve this purpose.
Interactive order-details messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-order-details-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsMessage"
},
"examples":{
"Interactive UPI PayU order-details message":{
"summary":"Interactive UPI PayU order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"UPI_PAYU",
"id":"fd3e847h2",
"productDescription":"tshirt100",
"customerFirstName":"John",
"customerLastName":"Smith",
"customerEmail":"John.Smith@example.com",
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4",
"customData5"
]
},
"paymentConfiguration":"payment-config",
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
},
"orderDetailsType":"QUICK_PAY"
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive Brazil order-details message":{
"summary":"Interactive Brazil order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"BRAZIL",
"id":"fd3e847h2"
},
"paymentConfiguration":"payment-config",
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive Brazil Pix DC order-details message":{
"summary":"Interactive Brazil Pix DC order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"BRAZIL_PIX_DC",
"id":"fd3e847h2",
"code":"00020101021226900014br.gov.bcb.pix2568pix",
"merchantName":"Company Name",
"keyType":"CNPJ",
"key":"01234567891234"
},
"paymentConfiguration":"payment-config",
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive Brazil Pix DC order-details message without paymentConfiguration":{
"summary":"Interactive Brazil Pix DC order-details message without paymentConfiguration",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"BRAZIL_PIX_DC",
"id":"fd3e847h2",
"code":"00020101021226900014br.gov.bcb.pix2568pix",
"merchantName":"Company Name",
"keyType":"CNPJ",
"key":"01234567891234"
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive Brazil Link order-details message":{
"summary":"Interactive Brazil Link order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"BRAZIL_LINK",
"id":"fd3e847h2",
"paymentLink":"https://example.com/payment-link"
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive Brazil Boleto order-details message":{
"summary":"Interactive Brazil Boleto order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"BRAZIL_BOLETO",
"id":"fd3e847h2",
"code":"03399026944140000002628346101018898510000008848"
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive Brazil Payments order-details message":{
"summary":"Interactive Brazil Payments order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"BRAZIL_PAYMENTS",
"payments":[
{
"type":"BRAZIL_PIX_DC",
"id":"fd3e847h2",
"code":"00020101021226900014br.gov.bcb.pix2568pix",
"merchantName":"Company Name",
"keyType":"CNPJ",
"key":"01234567891234"
},
{
"type":"BRAZIL_BOLETO",
"id":"fd3e847h2",
"code":"03399026944140000002628346101018898510000008848"
}
]
},
"orderCurrency":"BRL",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive PG PayU order-details message":{
"summary":"Interactive PG PayU order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"PG_PAYU",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4"
]
},
"paymentConfiguration":"payment-config",
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive PG Razorpay order-details message":{
"summary":"Interactive PG Razorpay order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"PG_RAZORPAY",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"callbackData":{
"key0":"customData1",
"key1":"customData2",
"key2":"customData3",
"key3":"customData4",
"key4":"customData5",
"key5":"customData6",
"key6":"customData7",
"key7":"customData8",
"key8":"customData9",
"key9":"customData10",
"key10":"customData11",
"key11":"customData12",
"key12":"customData13",
"key13":"customData14",
"key14":"customData15"
}
},
"paymentConfiguration":"payment-config",
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive UPI Intent Link order-details message":{
"summary":"Interactive UPI Intent Link order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"UPI_INTENT",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"format":{
"type":"LINK",
"paymentLink":"upi://pay?pa=example@upi&pn=Example%20Merchant&mc=4722&&tr=1234567890"
}
},
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive UPI Link order-details message":{
"summary":"Interactive UPI Link order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"UPI_LINK",
"id":"fd3e847h2",
"beneficiary":{
"name":"John Smith",
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"state":"state",
"country":"INDIA",
"postalCode":"123456"
},
"paymentLink":"https://payment.example.com/upi-link"
},
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"catalogId":"1",
"items":[
{
"retailerId":"1",
"name":"discounted product",
"amount":{
"value":10000
},
"saleAmount":{
"value":5000
},
"quantity":2
},
{
"retailerId":"2",
"name":"product",
"amount":{
"value":10000
},
"quantity":1
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Header interactive UPI PayU order-details message":{
"summary":"Header interactive UPI PayU order-details message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"payment":{
"type":"UPI_PAYU",
"id":"fd3e847h2",
"productDescription":"tshirt100",
"customerFirstName":"John",
"customerLastName":"Smith",
"customerEmail":"John.Smith@example.com",
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4",
"customData5"
]
},
"paymentConfiguration":"payment-config",
"orderCurrency":"INR",
"orderType":"DIGITAL_GOODS",
"totalAmount":{
"value":21000
},
"order":{
"items":[
{
"retailerId":"1",
"name":"product",
"amount":{
"value":10000
},
"quantity":2,
"originCountry":"country of origin",
"importerName":"importer name",
"importerAddress":{
"firstAddressLine":"address line",
"secondAddressLine":"address line",
"city":"city",
"zoneCode":"zone code",
"postalCode":"postal code",
"countryCode":"country code"
}
}
],
"subtotal":{
"value":20000
},
"tax":{
"value":1000,
"description":"tax included"
},
"shipping":{
"value":1000,
"description":"shipping cost"
},
"discount":{
"amount":{
"value":1000,
"description":"discount"
},
"programName":"membership discount"
},
"orderExpiration":{
"expirationSeconds":500,
"description":"limited offer"
}
}
},
"header":{
"type":"IMAGE",
"mediaUrl":"https://example.com/image"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.header.mediaUrl":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Missing catalogId validation error response":{
"summary":"Missing catalogId validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.order":[
"if catalogId is not present then originCountry, importerName and importerAddress must be specified"
]
}
}
}
}
},
"Total amount validation error response":{
"summary":"Total amount validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action":[
"totalAmount must be sum of subtotal, tax and shipping reduced by discount"
]
}
}
}
}
},
"Sale amount validation error response":{
"summary":"Sale amount validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.order.items[0]":[
"saleAmount must be less than amount"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/order-status":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive order-status message",
"description":"Send an interactive order-status message to a single recipient.
An order-status message delivers real-time updates to customers about the current status of their order.
Interactive order-status messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-order-status-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusMessage"
},
"examples":{
"Interactive order-status message":{
"summary":"Interactive order-status message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"payment":{
"type":"UPI_PAYU",
"id":"16085194825"
},
"status":"SHIPPED",
"description":"Order shipped"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Body interactive order-status message":{
"summary":"Body interactive order-status message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"payment":{
"type":"UPI_PAYU",
"id":"16085194825"
},
"status":"SHIPPED",
"description":"Order shipped"
},
"body":{
"text":"Some text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Footer interactive order-status message":{
"summary":"Footer interactive order-status message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"payment":{
"type":"UPI_PAYU",
"id":"16085194825"
},
"status":"SHIPPED",
"description":"Order shipped"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Body and footer interactive order-status message":{
"summary":"Body and footer interactive order-status message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"action":{
"payment":{
"type":"UPI_PAYU",
"id":"16085194825"
},
"status":"SHIPPED",
"description":"Order shipped"
},
"body":{
"text":"Some text"
},
"footer":{
"text":"Footer"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Payment validation error response":{
"summary":"Payment validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.payment.id":[
"must not be blank"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/flow":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive flow message",
"description":"Send an interactive flow message to a single recipient. Interactive flow messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-flow-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowMessage"
},
"examples":{
"Interactive flow message":{
"summary":"Interactive flow message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"mode":"PUBLISHED",
"flowMessageVersion":3,
"flowToken":"Flow token",
"flowId":"98E8D4AA79E2697757FAA",
"callToActionButton":"Button text",
"flowAction":"NAVIGATE",
"flowActionPayload":{
"screen":"product_screen",
"data":{
"product_name":"name",
"product_price":200
}
}
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Header and footer interactive flow message":{
"summary":"Header and footer interactive flow message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"mode":"PUBLISHED",
"flowMessageVersion":3,
"flowToken":"Flow token",
"flowId":"98E8D4AA79E2697757FAA",
"callToActionButton":"Button text",
"flowAction":"NAVIGATE",
"flowActionPayload":{
"screen":"product_screen",
"data":{
"product_name":"name",
"product_price":200
}
}
},
"header":{
"type":"TEXT",
"text":"Header text"
},
"footer":{
"text":"Footer text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Flow action payload validation error response":{
"summary":"Flow action payload validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.flowActionPayload.screen":[
"must not be blank"
]
}
}
}
}
},
"Call to action button validation error response":{
"summary":"Call to action button validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.callToActionButton":[
"must not be blank",
"size must be between 1 and 20"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/url-button":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive url button message",
"description":"Send an interactive url button message to a single recipient.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-url-button-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonMessage"
},
"examples":{
"Interactive url button message":{
"summary":"Interactive url button message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"displayText":"Display text",
"url":"https://www.example.com"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Header and footer interactive url button message":{
"summary":"Header and footer interactive url button message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"displayText":"Display text",
"url":"https://www.example.com"
},
"header":{
"type":"TEXT",
"text":"Header text"
},
"footer":{
"text":"Footer text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Url validation error response":{
"summary":"Url validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.url":[
"size must be between 1 and 2048",
"is not a valid url",
"must not be blank"
]
}
}
}
}
},
"Url button display text validation error response":{
"summary":"Url button display text validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.displayText":[
"must not be blank",
"size must be between 1 and 20"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/call-permission-request":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive call permission request message",
"description":"Send an interactive call permission request message to a single recipient. Interactive call permission request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-call-permission-request-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveCallPermissionRequestMessage"
},
"examples":{
"Interactive call permission request message":{
"summary":"Interactive call permission request message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/voice-button":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive voice button message",
"description":"Send an interactive voice button message to a single recipient. Interactive voice button messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-voice-button-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessage"
},
"examples":{
"Interactive voice button message":{
"summary":"Interactive voice button message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
},
"Interactive voice button message with all action fields":{
"summary":"Interactive voice button message with all action fields",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
},
"action":{
"buttonDisplayText":"Call us",
"callValidityPeriod":1440,
"callContextPayload":"context-payload"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Voice button action validation error response":{
"summary":"Voice button action validation error response",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content.action.callValidityPeriod":[
"must be less than or equal to 43200"
],
"content.action.callContextPayload":[
"size must be between 1 and 512"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/in-thread-authentication-request":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive in-thread authentication request message",
"description":"Send an interactive in-thread authentication request message to a single recipient. Interactive in-thread authentication request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-in-thread-authentication-request-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveInThreadAuthenticationRequestMessage"
},
"examples":{
"Interactive in-thread authentication request message":{
"summary":"Interactive in-thread authentication request message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/message/interactive/request-contact-info":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"send-whatsapp-interactive-messages"
],
"summary":"Send WhatsApp interactive request contact info message",
"description":"Send an interactive request contact info message to a single recipient. Interactive request contact info messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-interactive-request-contact-info-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoMessage"
},
"examples":{
"Interactive request contact info message":{
"summary":"Interactive request contact info message",
"value":{
"from":"441134960000",
"to":"441134960001",
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content":{
"body":{
"text":"Some text"
}
},
"callbackData":"Callback data",
"notifyUrl":"https://www.example.com/whatsapp",
"urlOptions":{
"shortenUrl":true,
"trackClicks":true,
"trackingUrl":"https://example.com/click-report",
"removeProtocol":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
},
"examples":{
"Success Response":{
"summary":"Success Response",
"value":{
"to":"441134960001",
"messageCount":1,
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/events":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-outbound-messages",
"whatsapp-events"
],
"summary":"Send WhatsApp events",
"description":"Send WhatsApp events to multiple recipients.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"send-whatsapp-events",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventRequest"
},
"examples":{
"Typing indicator":{
"summary":"Typing indicator",
"value":{
"events":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"type":"TYPING_INDICATOR"
}
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"examples":{
"Success":{
"summary":"Success",
"value":{
"bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
"messages":[
{
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message sent to next instance"
},
"destination":"441134960001"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"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":[
"message:send",
"whatsapp:message:send",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/media/{mediaId}":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-inbound-messages",
"whatsapp-get-inbound-media"
],
"summary":"Download inbound media",
"description":"Download WhatsApp media sent by end-users.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"download-whatsapp-inbound-media",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"mediaId",
"in":"path",
"description":"ID of the media.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"20250_13_123e4567-e89b-12d3-a456-426655440000"
}
],
"responses":{
"200":{
"description":"Media successfully downloaded",
"content":{
"*/*":{
"schema":{
"type":"string",
"format":"binary",
"description":"Media binary stream response"
}
}
}
},
"302":{
"description":"Redirect to CDN URL for cached media"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Media not found or expired"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"inbound-message:read",
"whatsapp:inbound-message:read",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"head":{
"tags":[
"channels",
"whatsapp",
"whatsapp-inbound-messages",
"whatsapp-get-inbound-media"
],
"summary":"Get media metadata",
"description":"Get metadata of WhatsApp media sent by end-users to check media type and the size of a file without downloading the content.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-media-metadata",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"mediaId",
"in":"path",
"description":"ID of the media.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"20250_13_123e4567-e89b-12d3-a456-426655440000"
}
],
"responses":{
"200":{
"description":"Media metadata successfully downloaded",
"headers":{
"Content-Length":{
"description":"The size of a media file in bytes.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
"Content-Type":{
"description":"The Content type of a media file.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Media not found or expired"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/message/{messageId}/read":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-inbound-messages",
"whatsapp-mark-message-as-read"
],
"summary":"Mark as read",
"description":"Mark WhatsApp messages sent by end-users as read.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"mark-whatsapp-message-as-read",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"messageId",
"in":"path",
"description":"ID of the message to be marked as read.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"abcdef_ghij124567890klmnopr"
}
],
"responses":{
"204":{
"description":"Message successfully marked as read"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.MarkAsReadErrorResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/payments/upi/payu/{paymentId}":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-payments"
],
"summary":"Get India UPI PayU payment status",
"description":"Get India UPI PayU payment and transaction status.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-upi-payu-payment-status",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"paymentId",
"in":"path",
"description":"Unique identifier of the payment.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":25,
"minLength":1
},
"example":16085194825
}
],
"responses":{
"200":{
"description":"Payment successfully retrieved.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment"
},
"examples":{
"Success response":{
"summary":"Success response",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
]
}
},
"Success response with callbackData":{
"summary":"Success response with callbackData",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
],
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4"
]
}
},
"Success response with key-value callbackData":{
"summary":"Success response with key-value callbackData",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
],
"callbackData":{
"customKey1":"customValue1",
"customKey2":"customValue2",
"customKey3":"customValue3"
}
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Transaction not found."
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"inbound-message:read",
"whatsapp:inbound-message:read",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/payments/br/{paymentId}":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-payments"
],
"summary":"Get Brazil payment status",
"description":"Get Brazil payment and transaction status.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-brazil-payment-status",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"paymentId",
"in":"path",
"description":"Unique identifier of the payment.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"pattern":"^[A-Za-z0-9\\-_.]{1,35}$"
},
"example":16085194825
}
],
"responses":{
"200":{
"description":"Payment successfully retrieved.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment"
},
"examples":{
"Success response":{
"summary":"Success response",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
]
}
},
"Success response with callbackData":{
"summary":"Success response with callbackData",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
],
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4"
]
}
},
"Success response with key-value callbackData":{
"summary":"Success response with key-value callbackData",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
],
"callbackData":{
"customKey1":"customValue1",
"customKey2":"customValue2",
"customKey3":"customValue3"
}
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Transaction not found."
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"inbound-message:read",
"whatsapp:inbound-message:read",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/payments/upi/{paymentId}":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-payments"
],
"summary":"Get India UPI PayU/Razorpay payment status",
"description":"Get India UPI PayU/Razor payment and transaction status.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-upi-payment-status",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"paymentId",
"in":"path",
"description":"Unique identifier of the payment.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"pattern":"^[A-Za-z0-9\\-_.]{1,35}$"
},
"example":16085194825
}
],
"responses":{
"200":{
"description":"Payment successfully retrieved.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment"
},
"examples":{
"Success response":{
"summary":"Success response",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
]
}
},
"Success response with callbackData":{
"summary":"Success response with callbackData",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
],
"callbackData":[
"customData1",
"customData2",
"customData3",
"customData4"
]
}
},
"Success response with key-value callbackData":{
"summary":"Success response with key-value callbackData",
"value":{
"referenceId":"72123248136",
"paymentId":"16085194825",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T00:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
],
"callbackData":{
"customKey1":"customValue1",
"customKey2":"customValue2",
"customKey3":"customValue3"
}
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Transaction not found."
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"inbound-message:read",
"whatsapp:inbound-message:read",
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/2/senders/{sender}/templates":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Get WhatsApp Templates",
"description":"Get all the templates and their statuses for a given sender.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-templates",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"List of all templates and their statuses for a given sender.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatesApiResponse"
},
"examples":{
"Media Template":{
"summary":"Media Template",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"HIGH",
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
},
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
]
}
},
"Media Template with Text header":{
"summary":"Media Template with Text header",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_header",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"text":"exampleContent",
"format":"TEXT"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"MEDIUM",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
]
}
},
"Media Template with Buttons":{
"summary":"Media Template with Buttons",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_buttons",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
]
}
},
"Text template":{
"summary":"Text template",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Create WhatsApp Template",
"description":"Create a WhatsApp template. Once created, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"create-whatsapp-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest"
},
"examples":{
"Template":{
"summary":"Template",
"value":{
"name":"text_template",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
}
}
}
},
"Template with image header":{
"summary":"Template with image header",
"value":{
"name":"media_template_with_image_header",
"language":"en",
"category":"MARKETING",
"structure":{
"header":{
"example":"https://www.example.com/image.png",
"format":"IMAGE"
},
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
}
}
}
},
"Template with footer":{
"summary":"Template with footer",
"value":{
"name":"media_template_with_footer",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"footer":{
"text":"footer content"
}
}
}
},
"Template with quick reply buttons":{
"summary":"Template with quick reply buttons",
"value":{
"name":"media_template_with_quick_reply_buttons",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"QUICK_REPLY",
"text":"quick reply 1"
},
{
"type":"QUICK_REPLY",
"text":"quick reply 2"
},
{
"type":"QUICK_REPLY",
"text":"quick reply 3"
}
]
}
}
},
"Template with call to action buttons":{
"summary":"Template with call to action buttons",
"value":{
"name":"media_template_with_call_to_action_buttons",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"call agent",
"phoneNumber":"007"
},
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
]
}
}
},
"template with dynamic url button":{
"summary":"template with dynamic url button",
"value":{
"name":"media_template_with_dynamic_url_button",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
]
}
}
},
"Template with all elements":{
"summary":"Template with all elements",
"value":{
"name":"media_template_with_all_elements",
"language":"en",
"category":"MARKETING",
"structure":{
"header":{
"example":"https://www.example.com/image.png",
"format":"IMAGE"
},
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"footer":{
"text":"footer content"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"call agent",
"phoneNumber":"007"
},
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
]
}
}
},
"Template with copy code button":{
"summary":"Template with copy code button",
"value":{
"name":"media_template_with_copy_code_button",
"language":"en",
"category":"MARKETING",
"structure":{
"header":{
"example":"https://www.example.com/image.png",
"format":"IMAGE"
},
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"COPY_CODE",
"example":"exampleCode"
}
]
}
}
},
"Template with flow button":{
"summary":"Template with flow button",
"value":{
"name":"media_template_with_flow_button",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"FLOW",
"text":"exampleText",
"flowId":123456,
"flowAction":"NAVIGATE",
"navigateScreen":"exampleNavigateScreen"
}
]
}
}
},
"Template with catalog button":{
"summary":"Template with catalog button",
"value":{
"name":"media_template_with_catalog_button",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"CATALOG"
}
]
}
}
},
"Template with multi product button":{
"summary":"Template with multi product button",
"value":{
"name":"media_template_with_multi_product_button",
"language":"en",
"category":"MARKETING",
"structure":{
"header":{
"example":"https://www.example.com/image.png",
"format":"IMAGE"
},
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"MULTI_PRODUCT"
}
]
}
}
},
"Template with order details button":{
"summary":"Template with order details button",
"value":{
"name":"media_template_with_order_details_button",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"ORDER_DETAILS",
"variant":"BRAZIL"
}
]
}
}
},
"Template with voice call button":{
"summary":"Template with voice call button",
"value":{
"name":"media_template_with_order_details_button",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"VOICE_CALL",
"text":"Call Now",
"callValidityPeriod":1440
}
]
}
}
},
"Template with request contact info button":{
"summary":"Template with request contact info button",
"value":{
"name":"media_template_with_request_contact_info",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"REQUEST_CONTACT_INFO",
"text":"Share Contact Info"
}
]
}
}
},
"Template with order status subcategory":{
"summary":"Template with order status subcategory",
"value":{
"name":"media_template_with_order_status_subcategory",
"language":"en",
"category":"UTILITY",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
}
},
"subCategory":"ORDER_STATUS"
}
},
"Template with carousel":{
"summary":"Template with carousel",
"value":{
"name":"media_template_with_carousel",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"carousel":{
"cards":[
{
"header":{
"example":"https://www.example.com/image.png",
"format":"IMAGE"
},
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"call agent",
"phoneNumber":"007"
},
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
]
}
]
}
}
}
},
"Template with limited time offer":{
"summary":"Template with limited time offer",
"value":{
"name":"media_template_with_limited_time_offer",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
],
"limitedTimeOffer":{
"hasExpiration":false,
"text":"Example offer"
}
}
}
},
"Template with limited time offer with expiration":{
"summary":"Template with limited time offer with expiration",
"value":{
"name":"media_template_with_limited_time_offer",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"COPY_CODE",
"example":"exampleCode"
},
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
],
"limitedTimeOffer":{
"hasExpiration":true,
"text":"Example offer"
}
}
}
},
"Template with call permission request":{
"summary":"Template with call permission request",
"value":{
"name":"media_template_with_call_permission_request",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"callPermissionRequest":{}
}
}
},
"Authentication template with copy code button":{
"summary":"Authentication template with copy code button",
"value":{
"name":"authentication_template_with_copy_code_button",
"language":"en",
"category":"AUTHENTICATION",
"structure":{
"body":{
"addSecurityRecommendation":true
},
"footer":{
"codeExpirationMinutes":5
},
"buttons":[
{
"text":"Copy code",
"otpType":"COPY_CODE"
}
]
}
}
},
"Authentication template with one-tap button":{
"summary":"Authentication template with one-tap button",
"value":{
"name":"authentication_template_with_one_tap_button",
"language":"en",
"category":"AUTHENTICATION",
"structure":{
"body":{
"addSecurityRecommendation":false
},
"footer":{
"codeExpirationMinutes":10
},
"buttons":[
{
"text":"123456",
"autofillText":"123456",
"packageName":"com.example.myapplication",
"signatureHash":"K8a%2FAINcGX7",
"otpType":"ONE_TAP"
}
]
}
}
},
"Authentication template with validity period":{
"summary":"Authentication template with validity period",
"value":{
"name":"authentication_template_with_validity_period",
"language":"en",
"category":"AUTHENTICATION",
"structure":{
"body":{
"addSecurityRecommendation":true
},
"footer":{
"codeExpirationMinutes":5
},
"buttons":[
{
"text":"Copy code",
"otpType":"COPY_CODE"
}
]
},
"validityPeriod":{
"amount":5,
"timeUnit":"MINUTES"
}
}
},
"Template platform data":{
"summary":"Template platform data",
"value":{
"name":"text_template",
"language":"en",
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
}
},
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Template created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
},
"examples":{
"Media Template":{
"summary":"Media Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"HIGH",
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
},
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Text header":{
"summary":"Media Template with Text header",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_header",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"text":"exampleContent",
"format":"TEXT"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"MEDIUM",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Buttons":{
"summary":"Media Template with Buttons",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_buttons",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Copy Code":{
"summary":"Media Template with Copy Code",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_copy_code",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"COPY_CODE",
"text":"Copy offer code",
"example":"exampleCopyCode"
}
],
"shorteningOptions":{
"customDomain":"my-domain"
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Order Details":{
"summary":"Media Template with Order Details",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_order_details",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"ORDER_DETAILS",
"variant":"BRAZIL"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Voice Call":{
"summary":"Media Template with Voice Call",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_voice_call",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"VOICE_CALL",
"text":"Call Now"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Request Contact Info":{
"summary":"Media Template with Request Contact Info",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_request_contact_info",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"REQUEST_CONTACT_INFO",
"text":"Share Contact Info"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Order Status Template":{
"summary":"Order Status Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"order_status_template",
"language":"en",
"status":"APPROVED",
"category":"UTILITY",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000",
"subCategory":"ORDER_STATUS"
}
},
"Media Template with Carousel":{
"summary":"Media Template with Carousel",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_carousel",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"carousel":{
"cards":[
{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
]
}
]
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Flow Button":{
"summary":"Media Template with Flow Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_flow_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"FLOW",
"text":"example text",
"flowId":123456,
"flowAction":"NAVIGATE",
"navigateScreen":"exampleScreen"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Catalog Button":{
"summary":"Media Template with Catalog Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_catalog_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"CATALOG",
"text":"View catalog"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Multi Product Button":{
"summary":"Media Template with Multi Product Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_multi_product_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"MULTI_PRODUCT",
"text":"View items"
}
],
"shorteningOptions":{
"customDomain":"example.com"
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Text template":{
"summary":"Text template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Authentication Template":{
"summary":"Authentication Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"authentication_template",
"language":"en",
"status":"APPROVED",
"category":"AUTHENTICATION",
"structure":{
"body":{
"text":"*{{1}}* is your verification code.",
"examples":[
"123456"
]
},
"footer":{
"text":"This code expires in 15 minutes."
},
"buttons":[
{
"type":"URL",
"text":"Copy Code",
"url":"https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}"
}
],
"type":"MEDIA"
},
"quality":"HIGH",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Authentication Template with validity period":{
"summary":"Authentication Template with validity period",
"value":{
"id":"111",
"businessAccountId":222,
"name":"authentication_template",
"language":"en",
"status":"APPROVED",
"category":"AUTHENTICATION",
"structure":{
"body":{
"text":"*{{1}}* is your verification code.",
"examples":[
"123456"
]
},
"footer":{
"text":"This code expires in 15 minutes."
},
"buttons":[
{
"type":"URL",
"text":"Copy Code",
"url":"https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}"
}
],
"type":"MEDIA"
},
"quality":"HIGH",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000",
"validityPeriod":{
"amount":2,
"timeUnit":"MINUTES"
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1000,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/2/senders/{sender}/templates/{templateName}":{
"delete":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Delete WhatsApp Template",
"description":"Delete a WhatsApp template.\n* If registered in multiple languages, deleting the message template will also delete all its languages.\n* The template will be deleted for all senders registered under the same WhatsApp Business Account (WABA).\n* The system will attempt to deliver sent messages for 30 days, regardless of the template deletion.\n* Once deleted, the name of the approved template cannot be reused for 30 days.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"delete-whatsapp-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"templateName",
"in":"path",
"description":"Template name. Must only contain lowercase alphanumeric characters and underscores.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"pattern":"^[a-z0-9_]{1,512}$"
},
"example":"template_name"
}
],
"responses":{
"204":{
"description":"Template deleted."
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":200,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/2/senders/{sender}/templates/{id}":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Get WhatsApp Template",
"description":"Get a single template with its status for a given template ID.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"id",
"in":"path",
"description":"Template ID. Must be a number.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"5653923468715475"
}
],
"responses":{
"200":{
"description":"Template with its status for a given template ID.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
},
"examples":{
"Media Template":{
"summary":"Media Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"HIGH",
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
},
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Text header":{
"summary":"Media Template with Text header",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_header",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"text":"exampleContent",
"format":"TEXT"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"MEDIUM",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Buttons":{
"summary":"Media Template with Buttons",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_buttons",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Copy Code":{
"summary":"Media Template with Copy Code",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_copy_code",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"COPY_CODE",
"text":"Copy offer code",
"example":"exampleCopyCode"
}
],
"shorteningOptions":{
"customDomain":"my-domain"
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Order Details":{
"summary":"Media Template with Order Details",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_order_details",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"ORDER_DETAILS",
"variant":"BRAZIL"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Voice Call":{
"summary":"Media Template with Voice Call",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_voice_call",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"VOICE_CALL",
"text":"Call Now"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Request Contact Info":{
"summary":"Media Template with Request Contact Info",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_request_contact_info",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"REQUEST_CONTACT_INFO",
"text":"Share Contact Info"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Order Status Template":{
"summary":"Order Status Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"order_status_template",
"language":"en",
"status":"APPROVED",
"category":"UTILITY",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000",
"subCategory":"ORDER_STATUS"
}
},
"Media Template with Carousel":{
"summary":"Media Template with Carousel",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_carousel",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"carousel":{
"cards":[
{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
]
}
]
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Flow Button":{
"summary":"Media Template with Flow Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_flow_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"FLOW",
"text":"example text",
"flowId":123456,
"flowAction":"NAVIGATE",
"navigateScreen":"exampleScreen"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Catalog Button":{
"summary":"Media Template with Catalog Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_catalog_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"CATALOG",
"text":"View catalog"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Multi Product Button":{
"summary":"Media Template with Multi Product Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_multi_product_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"MULTI_PRODUCT",
"text":"View items"
}
],
"shorteningOptions":{
"customDomain":"example.com"
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Text template":{
"summary":"Text template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Authentication Template":{
"summary":"Authentication Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"authentication_template",
"language":"en",
"status":"APPROVED",
"category":"AUTHENTICATION",
"structure":{
"body":{
"text":"*{{1}}* is your verification code.",
"examples":[
"123456"
]
},
"footer":{
"text":"This code expires in 15 minutes."
},
"buttons":[
{
"type":"URL",
"text":"Copy Code",
"url":"https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}"
}
],
"type":"MEDIA"
},
"quality":"HIGH",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Authentication Template with validity period":{
"summary":"Authentication Template with validity period",
"value":{
"id":"111",
"businessAccountId":222,
"name":"authentication_template",
"language":"en",
"status":"APPROVED",
"category":"AUTHENTICATION",
"structure":{
"body":{
"text":"*{{1}}* is your verification code.",
"examples":[
"123456"
]
},
"footer":{
"text":"This code expires in 15 minutes."
},
"buttons":[
{
"type":"URL",
"text":"Copy Code",
"url":"https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}"
}
],
"type":"MEDIA"
},
"quality":"HIGH",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000",
"validityPeriod":{
"amount":2,
"timeUnit":"MINUTES"
}
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Template with the specified ID does not exist.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"patch":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Edit WhatsApp Template",
"description":"Edit a WhatsApp template. Once edited, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info.\n* Only templates with an approved, rejected, or paused status can be edited.\n* Use the structure provided in the [Create WhatsApp Template](#channels/whatsapp/whatsapp-service-management/create-whatsapp-template) endpoint.\n* Category of an approved template cannot be edited.\n* Approved templates can be edited up to 10 times in a 30-day window, or 1 time in a 24-hour window. Rejected or paused templates can be edited an unlimited number of times.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"edit-whatsapp-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"id",
"in":"path",
"description":"Template ID. Must be a number.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"5653923468715475"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateEditPublicApiRequest"
},
"examples":{
"Template":{
"summary":"Template",
"value":{
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"type":"TEXT"
}
}
},
"Authentication template":{
"summary":"Authentication template",
"value":{
"category":"AUTHENTICATION",
"structure":{
"body":{
"addSecurityRecommendation":true
},
"footer":{
"codeExpirationMinutes":5
},
"buttons":[
{
"text":"Copy code",
"otpType":"COPY_CODE"
}
]
}
}
},
"Template category":{
"summary":"Template category",
"value":{
"category":"MARKETING"
}
},
"Template structure":{
"summary":"Template structure",
"value":{
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"type":"TEXT"
}
}
},
"Template validity period":{
"summary":"Template validity period",
"value":{
"validityPeriod":{
"amount":120,
"timeUnit":"SECONDS"
}
}
},
"Carousel template structure":{
"summary":"Carousel template structure",
"value":{
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"carousel":{
"cards":[
{
"header":{
"example":"https://www.example.com/image.png",
"format":"IMAGE"
},
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"QUICK_REPLY",
"text":"quick reply 1"
},
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
]
}
]
},
"type":"MEDIA"
}
}
},
"Limited time offer template structure":{
"summary":"Limited time offer template structure",
"value":{
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"COPY_CODE",
"example":"Copy code"
},
{
"type":"URL",
"text":"visit website",
"url":"https://www.infobip.com/{{1}}",
"example":"https://www.infobip.com/docs"
}
],
"limitedTimeOffer":{
"hasExpiration":true,
"text":"Example offer"
},
"type":"MEDIA"
}
}
},
"Call permission request template structure":{
"summary":"Call permission request template structure",
"value":{
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"callPermissionRequest":{},
"type":"MEDIA"
}
}
},
"Request contact info template structure":{
"summary":"Request contact info template structure",
"value":{
"category":"MARKETING",
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"buttons":[
{
"type":"REQUEST_CONTACT_INFO",
"text":"Share Contact Info"
}
],
"type":"MEDIA"
}
}
},
"Template platform data":{
"summary":"Template platform data",
"value":{
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
}
}
},
"Order status template structure":{
"summary":"Order status template structure",
"value":{
"structure":{
"body":{
"text":"body {{1}} content",
"examples":[
"example"
]
},
"type":"TEXT"
},
"subCategory":"ORDER_STATUS"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Template edited.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
},
"examples":{
"Media Template":{
"summary":"Media Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"HIGH",
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
},
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Text header":{
"summary":"Media Template with Text header",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_header",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"text":"exampleContent",
"format":"TEXT"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"MEDIUM",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Buttons":{
"summary":"Media Template with Buttons",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_buttons",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Copy Code":{
"summary":"Media Template with Copy Code",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_copy_code",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"COPY_CODE",
"text":"Copy offer code",
"example":"exampleCopyCode"
}
],
"shorteningOptions":{
"customDomain":"my-domain"
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Order Details":{
"summary":"Media Template with Order Details",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_order_details",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"ORDER_DETAILS",
"variant":"BRAZIL"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Voice Call":{
"summary":"Media Template with Voice Call",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_voice_call",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"VOICE_CALL",
"text":"Call Now"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Request Contact Info":{
"summary":"Media Template with Request Contact Info",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_request_contact_info",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"REQUEST_CONTACT_INFO",
"text":"Share Contact Info"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Order Status Template":{
"summary":"Order Status Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"order_status_template",
"language":"en",
"status":"APPROVED",
"category":"UTILITY",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000",
"subCategory":"ORDER_STATUS"
}
},
"Media Template with Carousel":{
"summary":"Media Template with Carousel",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_carousel",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"carousel":{
"cards":[
{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"PHONE_NUMBER",
"text":"Dial 911",
"phoneNumber":"911"
},
{
"type":"URL",
"text":"Visit our website",
"url":"https://www.infobip.com"
}
]
}
]
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Flow Button":{
"summary":"Media Template with Flow Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_flow_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"FLOW",
"text":"example text",
"flowId":123456,
"flowAction":"NAVIGATE",
"navigateScreen":"exampleScreen"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Catalog Button":{
"summary":"Media Template with Catalog Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_catalog_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"CATALOG",
"text":"View catalog"
}
],
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Media Template with Multi Product Button":{
"summary":"Media Template with Multi Product Button",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_multi_product_button",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"buttons":[
{
"type":"MULTI_PRODUCT",
"text":"View items"
}
],
"shorteningOptions":{
"customDomain":"example.com"
},
"type":"MEDIA"
},
"quality":"LOW",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Text template":{
"summary":"Text template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Authentication Template":{
"summary":"Authentication Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"authentication_template",
"language":"en",
"status":"APPROVED",
"category":"AUTHENTICATION",
"structure":{
"body":{
"text":"*{{1}}* is your verification code.",
"examples":[
"123456"
]
},
"footer":{
"text":"This code expires in 15 minutes."
},
"buttons":[
{
"type":"URL",
"text":"Copy Code",
"url":"https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}"
}
],
"type":"MEDIA"
},
"quality":"HIGH",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
},
"Authentication Template with validity period":{
"summary":"Authentication Template with validity period",
"value":{
"id":"111",
"businessAccountId":222,
"name":"authentication_template",
"language":"en",
"status":"APPROVED",
"category":"AUTHENTICATION",
"structure":{
"body":{
"text":"*{{1}}* is your verification code.",
"examples":[
"123456"
]
},
"footer":{
"text":"This code expires in 15 minutes."
},
"buttons":[
{
"type":"URL",
"text":"Copy Code",
"url":"https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}"
}
],
"type":"MEDIA"
},
"quality":"HIGH",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000",
"validityPeriod":{
"amount":2,
"timeUnit":"MINUTES"
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/templates":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Get WhatsApp Templates",
"description":"Get all the templates and their statuses for a given sender. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channels/whatsapp/get-whatsapp-templates).",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"deprecated-get-whatsapp-templates",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"List of all templates and their statuses for a given sender.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplatesApiResponse"
},
"examples":{
"Media Template":{
"summary":"Media Template",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"header":{
"format":"IMAGE"
},
"body":"example {{1}} body",
"footer":"exampleFooter",
"type":"MEDIA"
}
}
]
}
},
"Media Template with Text header":{
"summary":"Media Template with Text header",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_header",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"header":{
"text":"exampleContent",
"format":"TEXT"
},
"body":"example {{1}} body",
"footer":"exampleFooter",
"type":"MEDIA"
}
}
]
}
},
"Media Template with Buttons":{
"summary":"Media Template with Buttons",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_buttons",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"header":{
"format":"IMAGE"
},
"body":"example {{1}} body",
"footer":"exampleFooter",
"buttons":[
{
"text":"Dial 911",
"type":"PHONE_NUMBER",
"phoneNumber":"911"
},
{
"text":"Visit our website",
"type":"URL",
"url":"https://www.infobip.com"
}
],
"type":"MEDIA"
}
}
]
}
},
"Text template":{
"summary":"Text template",
"value":{
"templates":[
{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"body":"example {{1}} body",
"type":"TEXT"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Create WhatsApp Template",
"description":"Create a WhatsApp template. Created template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/message-types#guidelines-amp-best-practices) for additional info. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channels/whatsapp/create-whatsapp-template).",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"deprecated-create-whatsapp-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8cb345d2b2e2a0cd5a7383bf2012768938eaa465c6e4f6554958ac7f4a58aa3f.V1TemplatePublicApiRequest"
},
"examples":{
"Template with body":{
"summary":"Template with body",
"value":{
"name":"text_template",
"language":"en",
"category":"ACCOUNT_UPDATE",
"structure":{
"body":"body {{1}} content",
"type":"TEXT"
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Template created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse"
},
"examples":{
"Media Template":{
"summary":"Media Template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"header":{
"format":"IMAGE"
},
"body":"example {{1}} body",
"footer":"exampleFooter",
"type":"MEDIA"
}
}
},
"Media Template with Text header":{
"summary":"Media Template with Text header",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_header",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"header":{
"text":"exampleContent",
"format":"TEXT"
},
"body":"example {{1}} body",
"footer":"exampleFooter",
"type":"MEDIA"
}
}
},
"Media Template with Buttons":{
"summary":"Media Template with Buttons",
"value":{
"id":"111",
"businessAccountId":222,
"name":"media_template_with_buttons",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"header":{
"format":"IMAGE"
},
"body":"example {{1}} body",
"footer":"exampleFooter",
"buttons":[
{
"text":"Dial 911",
"type":"PHONE_NUMBER",
"phoneNumber":"911"
},
{
"text":"Visit our website",
"type":"URL",
"url":"https://www.infobip.com"
}
],
"type":"MEDIA"
}
}
},
"Text template":{
"summary":"Text template",
"value":{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"ACCOUNT_UPDATE",
"structure":{
"body":"example {{1}} body",
"type":"TEXT"
}
}
}
}
}
}
},
"400":{
"description":"Template has invalid category, too long text or a template with a given name already exist.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":200,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/templates":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Get account WhatsApp templates",
"description":"Retrieve all templates associated with your account based on the provided filter criteria.",
"externalDocs":{
"description":"Learn more about the WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-account-whatsapp-templates",
"parameters":[
{
"name":"sender",
"in":"query",
"description":"List of registered WhatsApp senders numbers separated by comma. Must be in international format.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
},
"uniqueItems":true
},
"example":"447796344125"
},
{
"name":"status",
"in":"query",
"description":"List of template statuses, separated by commas.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string",
"enum":[
"APPROVED",
"IN_APPEAL",
"PENDING",
"REJECTED",
"PENDING_DELETION",
"DELETED",
"REINSTATED",
"FLAGGED",
"FIRST_PAUSED",
"SECOND_PAUSED",
"DISABLED"
]
},
"uniqueItems":true
}
},
{
"name":"name",
"in":"query",
"description":"Template name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"language",
"in":"query",
"description":"List of languages for the templates, separated by commas.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string",
"enum":[
"af",
"sq",
"ar",
"ar_EG",
"ar_AE",
"ar_LB",
"ar_MA",
"ar_QA",
"az",
"bn",
"bn_IN",
"bg",
"ca",
"zh_CN",
"zh_HK",
"zh_TW",
"hr",
"cs",
"da",
"nl",
"nl_BE",
"en",
"en_GB",
"en_US",
"en_AE",
"en_AU",
"en_CA",
"en_GH",
"en_IE",
"en_IN",
"en_JM",
"en_MY",
"en_NZ",
"en_QA",
"en_SG",
"en_UG",
"en_ZA",
"et",
"fil",
"fi",
"fr",
"fr_BE",
"fr_CA",
"fr_CH",
"fr_CI",
"fr_MA",
"ka",
"de",
"de_AT",
"de_CH",
"el",
"gu",
"ha",
"he",
"hi",
"hu",
"id",
"ga",
"it",
"ja",
"kn",
"kk",
"rw_RW",
"ko",
"ky_KG",
"lo",
"lv",
"lt",
"mk",
"ms",
"ml",
"mr",
"nb",
"fa",
"pl",
"pt_BR",
"pt_PT",
"pa",
"ro",
"ru",
"sr",
"si_LK",
"sk",
"sl",
"es",
"es_AR",
"es_CL",
"es_CO",
"es_CR",
"es_DO",
"es_EC",
"es_HN",
"es_MX",
"es_PA",
"es_PE",
"es_ES",
"es_UY",
"sw",
"sv",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"uz",
"vi",
"zu",
"unknown"
]
},
"uniqueItems":true
},
"example":"en,en_US"
},
{
"name":"category",
"in":"query",
"description":"List of template categories, separated by commas.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string",
"enum":[
"MARKETING",
"AUTHENTICATION",
"UTILITY"
]
},
"uniqueItems":true
}
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"entityId",
"in":"query",
"description":"Entity ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"page",
"in":"query",
"description":"Current page number.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of items per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":10,
"maximum":100,
"minimum":1
}
},
{
"name":"orderBy",
"in":"query",
"description":"Sorting criteria in the format property,direction. Can be ascending (ASC) or descending (DESC). Available properties: category, language, name, status, templateId",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"default":"templateId,ASC"
},
"example":"name,ASC"
}
],
"responses":{
"200":{
"description":"List of all filtered templates",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatesApiResponsePaginated"
},
"examples":{
"Filtered single template":{
"summary":"Filtered single template",
"value":{
"results":[
{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"HIGH",
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
},
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
],
"paging":{
"page":0,
"size":99,
"totalPages":1,
"totalResults":1
}
}
},
"Filtered templates with pagination":{
"summary":"Filtered templates with pagination",
"value":{
"results":[
{
"id":"111",
"businessAccountId":222,
"name":"text_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"body":{
"text":"example {{1}} body"
},
"type":"TEXT"
},
"quality":"UNKNOWN",
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
},
{
"id":"111",
"businessAccountId":222,
"name":"media_template",
"language":"en",
"status":"APPROVED",
"category":"MARKETING",
"structure":{
"header":{
"format":"IMAGE"
},
"body":{
"text":"example {{1}} body"
},
"footer":{
"text":"exampleFooter"
},
"type":"MEDIA"
},
"quality":"HIGH",
"platform":{
"entityId":"entityId",
"applicationId":"applicationId"
},
"createdAt":"2024-01-01T00:00:00.000+0000",
"lastUpdatedAt":"2024-01-01T00:00:00.000+0000"
}
],
"paging":{
"page":0,
"size":2,
"totalPages":5,
"totalResults":10
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Provided status is invalid":{
"summary":"Provided status is invalid",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"status",
"violation":"Provide one of the valid values."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"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":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Get WhatsApp Flows",
"description":"Get all the flows for a given sender.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-flows",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"List of all flows for a given sender",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetSenderFlowsResponse"
},
"examples":{
"List of all flows for given sender":{
"summary":"List of all flows for given sender",
"value":{
"flows":[
{
"id":"123456",
"name":"My flow",
"businessAccountId":987654,
"categories":[
"SURVEY"
],
"status":"DRAFT"
},
{
"id":"1234567",
"name":"My second flow",
"businessAccountId":987654,
"categories":[
"SIGN_IN"
],
"status":"PUBLISHED",
"initialScreens":[
"form_feedback_one",
"form_feedback_two"
]
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1000,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
},
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Create WhatsApp Flow",
"description":"Create a WhatsApp flow. If successful, flow will be created in DRAFT status with default flow.json. Flow.json contains structure of the flow and other fields given in request can be updated until publication.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"create-whatsapp-flow",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.CreateFlowRequest"
},
"examples":{
"Simple create flow request":{
"summary":"Simple create flow request",
"value":{
"name":"My flow",
"categories":[
"SURVEY"
]
}
},
"Cloning create flow request":{
"summary":"Cloning create flow request",
"value":{
"name":"My flow",
"categories":[
"SIGN_IN"
],
"cloneFlowId":"912079080628183"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Flow Created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse"
},
"examples":{
"Flow created":{
"summary":"Flow created",
"value":{
"id":"123456",
"name":"My flow",
"businessAccountId":987654,
"categories":[
"SURVEY"
],
"status":"DRAFT"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Flow name not unique":{
"summary":"Flow name not unique",
"value":{
"errorCode":"E400",
"description":"Flow creation failed due to validation errors.",
"action":"Please use different flow name.",
"violations":[
{
"property":"name",
"violation":"Flow with given name already exists."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows/{flowId}":{
"delete":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Delete WhatsApp Flow",
"description":"Delete a WhatsApp flow. Only flows in DRAFT status can be deleted.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"delete-whatsapp-flow",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow to be deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"responses":{
"204":{
"description":"Flow deleted"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Flow is already published":{
"summary":"Flow is already published",
"value":{
"errorCode":"E400",
"description":"Deletion attempt failed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"flowId",
"violation":"Cannot delete flow which is not in DRAFT status."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
},
"Flow not found error":{
"summary":"Flow not found error",
"value":{
"errorCode":"WA-FLOW-ID404",
"description":"Flow not found.",
"action":"Please check the flowId and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
},
"patch":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Update WhatsApp Flow",
"description":"Update a WhatsApp flow. Only flows in DRAFT status can be modified.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"update-whatsapp-flow",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow to be modified.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.UpdateFlowRequest"
},
"examples":{
"Update flow request":{
"summary":"Update flow request",
"value":{
"name":"My new name",
"categories":[
"CONTACT_US"
]
}
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"Flow updated"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Flow is in non-updatable state":{
"summary":"Flow is in non-updatable state",
"value":{
"errorCode":"E400",
"description":"Updating attempt failed.",
"action":"Please create new flow.",
"violations":[
{
"property":"flowId",
"violation":"Flow can only be modified in DRAFT status."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows/{flowId}/publish":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Publish WhatsApp Flow",
"description":"Publish a WhatsApp flow. If successful, the flow will change its status to PUBLISHED. From now on the flow cannot be modified.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"publish-whatsapp-flow",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow to be published.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"responses":{
"204":{
"description":"Flow published"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Flow is not in DRAFT status":{
"summary":"Flow is not in DRAFT status",
"value":{
"errorCode":"E400",
"description":"Publishing attempt failed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"flowId",
"violation":"Cannot publish flow which is not in DRAFT status."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows/{flowId}/json":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Get WhatsApp Flow JSON",
"description":"Get the Flow JSON attached to a specified flow.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-flow-json",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow the JSON is attached to.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"responses":{
"200":{
"description":"Attached Flow JSON",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetFlowJsonResponse"
},
"examples":{
"Flow JSON for a specified Flow":{
"summary":"Flow JSON for a specified Flow",
"value":{
"externalDownloadUrl":"https://example.com"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
},
"Flow not found error":{
"summary":"Flow not found error",
"value":{
"errorCode":"WA-FLOW-ID404",
"description":"Flow not found.",
"action":"Please check the flowId and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1000,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
},
"put":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Add WhatsApp Flow JSON",
"description":"Add WhatsApp Flow JSON. File created from provided JSON content is sent and validated, errors found are provided in response. Regardless of whether any validation errors are returned, the Flow JSON is loaded on the Meta side and the request is considered successful. The maximum size of created file is 10MB. More information about JSON structure can be found under Meta documentation: https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"add-whatsapp-flow-json",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow to attach JSON to.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJson"
},
"examples":{
"Exemplary Flow JSON body request":{
"summary":"Exemplary Flow JSON body request",
"value":{
"version":"2.1",
"data_api_version":"3.0",
"routing_model":{
"MY_FIRST_SCREEN":[]
},
"screens":{
"id":"MY_FIRST_SCREEN",
"title":"MY_FIRST_SCREEN",
"terminal":true,
"data":{
"hello_world_text":{
"type":"string",
"__example__":"Hello World"
}
},
"layout":{
"type":"SingleColumnLayout",
"children":[
{
"type":"TextHeading",
"text":"${data.hello_world_text}"
},
{
"type":"Footer",
"label":"Static footer label",
"on-click-action":{
"name":"data_exchange",
"payload":{}
}
}
]
}
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Flow JSON Added",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonResponse"
},
"examples":{
"Validation errors":{
"summary":"Validation errors",
"value":{
"validationErrors":[
{
"error":"INVALID_PROPERTY",
"errorType":"JSON_SCHEMA_ERROR",
"message":"The property \"initial-text\" cannot be specified at \"$root/screens/0/layout/children/2/children/0\".",
"lineStart":46,
"lineEnd":46,
"columnStart":17,
"columnEnd":30
}
]
}
},
"No validation errors":{
"summary":"No validation errors",
"value":{
"validationErrors":[]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Flow is in non-updatable state":{
"summary":"Flow is in non-updatable state",
"value":{
"errorCode":"E400",
"description":"Updating attempt failed.",
"action":"Please create new flow.",
"violations":[
{
"property":"flowId",
"violation":"Flow can only be modified in DRAFT status."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows/{flowId}/deprecate":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Deprecate WhatsApp Flow",
"description":"Deprecate a WhatsApp flow. If successful, flow will change its status to DEPRECATED. From now on flow cannot be sent anymore.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"deprecate-whatsapp-flow",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow to be deprecated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"responses":{
"204":{
"description":"Flow deprecated"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Flow is already deprecated":{
"summary":"Flow is already deprecated",
"value":{
"errorCode":"E400",
"description":"Deprecation attempt failed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"flowId",
"violation":"Cannot deprecate already deprecated flow."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows/{flowId}/preview":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Get WhatsApp Flow's preview",
"description":"Get flow's preview URL. Link does not require login and will expire in 30 days.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-flow-preview",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
},
{
"name":"flowId",
"in":"path",
"description":"ID of the flow for which the preview URL will be generated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"123456"
}
],
"responses":{
"200":{
"description":"Flow's preview URL",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowPreview"
},
"examples":{
"Flow's preview URL":{
"summary":"Flow's preview URL",
"value":{
"previewUrl":"https://example.com",
"expiresAt":"2024-01-01T12:00:00Z"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/flows/generate":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-flow-management"
],
"summary":"Generate WhatsApp Flow",
"description":"Use this endpoint to automatically generate a WhatsApp Flow definition using AI, based on a natural language prompt. Provide a descriptive prompt (e.g., \"Create a Static WhatsApp Flow to collect details like Name, Surname and email for our global event next week.\"). The AI will generate a flow configuration designed to match your intent. If you include a responseId from an earlier request, the prompt will be used to modify or refine the flow that was previously generated, so you can adjust and improve it step by step.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"generate-whatsapp-flow",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowRequestApiData"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Generated whatsapp flow",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowResponseApiData"
},
"examples":{
"Generated flow":{
"summary":"Generated flow",
"value":{
"originalPrompt":"Flow that contains form with name, surname and email of the user.",
"responseId":"12346",
"generatedFlow":{
"version":"7.0",
"screens":[
{
"id":"USER_INFO_FORM",
"title":"User Information",
"terminal":true,
"success":true,
"layout":{
"type":"SingleColumnLayout",
"children":[
{
"type":"Form",
"name":"user_info_form",
"children":[
{
"type":"TextInput",
"label":"Name",
"name":"name",
"required":true
},
{
"type":"TextInput",
"label":"Surname",
"name":"surname",
"required":true
},
{
"type":"TextInput",
"label":"Email",
"name":"email",
"input-type":"email",
"required":true
},
{
"type":"Footer",
"label":"Submit",
"on-click-action":{
"name":"complete",
"payload":{
"name":"${form.name}",
"surname":"${form.surname}",
"email":"${form.email}"
}
}
}
]
}
]
}
}
]
}
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiError400"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found error":{
"summary":"Sender not found error",
"value":{
"errorCode":"WA-FLOW-SENDER404",
"description":"Sender not found.",
"action":"Please check the sender and try again.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"h"
}
]
}
},
"/whatsapp/1/senders/{sender}/media":{
"delete":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-media-management"
],
"summary":"Delete media",
"description":"Delete WhatsApp media. May be outbound or inbound media.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"delete-whatsapp-media",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.UrlDeletionRequest"
}
}
},
"required":true
},
"responses":{
"204":{
"description":"Media successfully deleted"
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Media not found"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":30,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/whatsapp/1/senders/quality":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Get quality information of WhatsApp senders",
"description":"Get WhatsApp sender information, such as quality rating, status, and current limit of given senders. Only senders associated with your account are included in the response.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-senders-quality",
"parameters":[
{
"name":"senders",
"in":"query",
"description":"List of comma-separated WhatsApp sender numbers.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string",
"format":"string",
"description":"WhatsApp sender."
},
"maxItems":100,
"minItems":1
},
"example":"447796344125,447796344126"
}
],
"responses":{
"200":{
"description":"List of WhatsApp senders quality.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"value":{
"results":[
{
"sender":"441134960000",
"qualityRating":"MEDIUM",
"status":"CONNECTED",
"currentLimit":"LIMIT_100K",
"lastUpdated":"2022-02-18T08:12:26.422Z"
},
{
"sender":"441134960001",
"qualityRating":"LOW",
"status":"BANNED",
"currentLimit":"UNLIMITED",
"lastUpdated":"2022-02-18T08:12:26.420Z"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/01b456ee89723218fe6e9044f9e602d2dda7aa7bf5bc0607681dd5bae7f811b9.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"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":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/business-info":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Get business info of WhatsApp sender",
"description":"Get WhatsApp sender business information, such as about, address, description, email, vertical, websites, and display name.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-sender-business-info",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"WhatsApp sender business info.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"value":{
"about":"Infobip Business Account",
"address":"35-38 New Bridge Street, London EC4V 6BW",
"description":"Infobip is a global cloud communications platform.",
"email":"info@example.com",
"vertical":"PROFESSIONAL_SERVICES",
"websites":[
"https://www.infobip.com"
],
"displayName":"Infobip"
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found":{
"summary":"Sender not found",
"value":{
"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":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"patch":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Update business info of WhatsApp sender",
"description":"Update WhatsApp sender business information, such as about, address, description, email, vertical, websites, and logo.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"update-whatsapp-sender-business-info",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoRequest"
},
"examples":{
"Business Info update":{
"summary":"Business Info update",
"value":{
"about":"Infobip Business Account",
"address":"35-38 New Bridge Street, London EC4V 6BW",
"description":"Infobip is a global cloud communications platform.",
"email":"info@example.com",
"vertical":"PROFESSIONAL_SERVICES",
"websites":[
"https://www.infobip.com"
],
"logoUrl":"https://example.com/logo"
}
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"WhatsApp sender business info updated."
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Logo is not supported":{
"summary":"Logo is not supported",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"logoUrl",
"violation":"image/gif is not supported logo type"
}
],
"resources":[]
}
},
"Failed to download logo":{
"summary":"Failed to download logo",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"logoUrl",
"violation":"Failed to download file with status 404 NOT_FOUND"
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found":{
"summary":"Sender not found",
"value":{
"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":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/business-info/logo":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Download business logo of WhatsApp sender",
"description":"Download WhatsApp sender business logo.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-sender-business-logo",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"WhatsApp sender business logo.",
"content":{
"*/*":{
"schema":{
"type":"string",
"format":"binary"
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found":{
"summary":"Sender not found",
"value":{
"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":[]
}
},
"Logo not found":{
"summary":"Logo not found",
"value":{
"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":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/calls/{userNumber}/permissions":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Get calling permission",
"description":"Get calling permission info of WhatsApp sender for specified end user number, including status, allowed actions, and limitations.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-calling-permission",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
},
{
"name":"userNumber",
"in":"path",
"description":"End user phone number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"Sender’s calling permission successfully retrieved",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppCallingPermissionResponse"
},
"examples":{
"Calling permission successfully retrieved":{
"summary":"Calling permission successfully retrieved",
"value":{
"status":"TEMPORARY",
"actions":[
{
"name":"SEND_CALL_PERMISSION_REQUEST",
"canPerformAction":true,
"limits":[
{
"timePeriod":"PT24H",
"maxAllowed":1,
"currentUsage":0
},
{
"timePeriod":"PT168H",
"maxAllowed":2,
"currentUsage":0
}
]
},
{
"name":"START_CALL",
"canPerformAction":true,
"limits":[
{
"timePeriod":"PT24H",
"maxAllowed":5,
"currentUsage":1
}
]
}
],
"expirationTime":"2025-10-07T10:09:08.007Z"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Not found":{
"summary":"Not found",
"value":{
"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":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/senders/{sender}/public-key":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Get WhatsApp sender public key",
"description":"Retrieves the public key for WhatsApp encryption. The public key enables\n end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"get-whatsapp-sender-public-key",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
}
],
"responses":{
"200":{
"description":"Public key retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.SenderPublicKeyResponse"
},
"examples":{
"Public key with VALID status":{
"summary":"Public key with VALID status",
"value":{
"publicKey":"-----BEGIN RSA PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Z3VS5JJcds3xfn+fvhK\nXid8o1nH9GGphKFKKCy3j9R4h4K/1J4XJWzLtXf3oDqj6e5X9U1N+8X0CjQxGjQ0\n-----END RSA PUBLIC KEY-----",
"publicKeySignatureStatus":"VALID"
}
},
"Public key with MISMATCH status (empty key)":{
"summary":"Public key with MISMATCH status (empty key)",
"value":{
"publicKey":" ",
"publicKeySignatureStatus":"MISMATCH"
}
}
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Sender not found":{
"summary":"Sender not found",
"value":{
"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":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-sender-management"
],
"summary":"Upload WhatsApp sender public key",
"description":"Uploads a public key for WhatsApp encryption. The public key enables\n end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows.\n Previous keys are replaced when new ones are uploaded using this endpoint.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"upload-whatsapp-sender-public-key",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maxLength":15,
"minLength":1,
"pattern":"[0-9]+"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.UploadKeyApiDoc"
},
"examples":{
"Curl - Upload PEM formatted public key file":{
"summary":"Curl - Upload PEM formatted public key file",
"description":"Curl - Upload PEM formatted public key file",
"value":"curl --request POST 'https://{base_url}/whatsapp/1/senders/{sender}/public-key' \\\n--header 'Authorization: {authorization}' \\\n--form 'file=\"@public_key.pem\"'"
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"Public key uploaded successfully."
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/embedded-signup/registrations/business-account/{businessAccountId}/senders":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-bulk-sender-registration"
],
"summary":"Add WhatsApp sender",
"description":"Add a WhatsApp sender to your WhatsApp Business Account and initiate the verification process. If the sender is recognized as already verified, it will be automatically submitted for registration.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"add-whatsapp-sender",
"parameters":[
{
"name":"businessAccountId",
"in":"path",
"description":"WhatsApp Business Account Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
},
"example":"12345567897878"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.PhoneNumberRequest"
}
}
},
"required":true
},
"responses":{
"202":{
"description":"Sender accepted for verification, if it is already verified it will be submitted for registration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationResponse"
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException"
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/embedded-signup/registrations/senders/{sender}/verification":{
"put":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-bulk-sender-registration"
],
"summary":"Retry WhatsApp sender verification",
"description":"Retry the WhatsApp sender verification process in the event of a non-delivered verification code.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"retry-whatsapp-sender-verification",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"pattern":"\\d+"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.OtpRequest"
}
}
},
"required":true
},
"responses":{
"202":{
"description":"Sender accepted for verification."
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException"
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-bulk-sender-registration"
],
"summary":"Verify WhatsApp sender",
"description":"Verify your WhatsApp sender and submit it for registration.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"verify-whatsapp-sender",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"pattern":"\\d+"
},
"example":"447796344125"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.VerifyCodeRequest"
}
}
},
"required":true
},
"responses":{
"202":{
"description":"Sender accepted for registration."
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Sender not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException"
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":15,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/{sender}/contacts/{userNumber}/identity":{
"get":{
"tags":[
"channels",
"whatsapp",
"whatsapp-identity-management"
],
"summary":"Get identity",
"description":"Get end user's identity info. Feature is not enabled by default.",
"externalDocs":{
"description":"Learn more.",
"url":"https://www.infobip.com/docs/whatsapp/manage-integration/additional-functionalities#detect-identity-changes"
},
"operationId":"get-whatsapp-identity",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"userNumber",
"in":"path",
"description":"End user's number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":441134960001
}
],
"responses":{
"200":{
"description":"Identity successfully retrieved.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityInfo"
},
"examples":{
"Success response":{
"summary":"Success response",
"value":{
"acknowledged":true,
"hash":"eU2Fdi4EMUw=",
"createdAt":"2022-02-18T08:12:26.422+0000"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Recipient does not exist for a given sender or identity has changed."
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage",
"whatsapp:message:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"put":{
"tags":[
"channels",
"whatsapp",
"whatsapp-identity-management"
],
"summary":"Confirm identity",
"description":"Confirm end user's identity. Feature is not enabled by default.",
"externalDocs":{
"description":"Learn more.",
"url":"https://www.infobip.com/docs/whatsapp/manage-integration/additional-functionalities#detect-identity-changes"
},
"operationId":"confirm-whatsapp-identity",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"userNumber",
"in":"path",
"description":"End user's number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":441134960001
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityConfirmation"
},
"examples":{
"Request":{
"summary":"Request",
"value":{
"hash":"eU2Fdi4EMUw="
}
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"Identity successfully confirmed."
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Identity was not found or recipient does not exist for a given sender."
},
"409":{
"description":"Incorrect identity hash provided."
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage",
"whatsapp:message:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"whatsapp",
"whatsapp-identity-management"
],
"summary":"Delete identity",
"description":"Delete end user's identity. Feature is not enabled by default.",
"externalDocs":{
"description":"Learn more.",
"url":"https://www.infobip.com/docs/whatsapp/manage-integration/additional-functionalities#detect-identity-changes"
},
"operationId":"delete-whatsapp-identity",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Registered WhatsApp sender number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":447796344125
},
{
"name":"userNumber",
"in":"path",
"description":"End user's number. Must be in international format.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":441134960001
}
],
"responses":{
"204":{
"description":"Identity successfully deleted."
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:manage",
"whatsapp:message:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/conversions":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-ad-conversions"
],
"summary":"Submit conversions",
"description":"Submit WhatsApp conversion events. Events are indivisible, either all are submitted or none.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"submit-whatsapp-conversions",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventRequest"
},
"examples":{
"Submit Conversion Event":{
"summary":"Submit Conversion Event",
"value":{
"sourceId":"263258390011723",
"conversions":[
{
"ctwaClickId":"ARAkLkA8rmlFeiCktEJQ-QT",
"type":"PURCHASE",
"details":{
"currency":"USD",
"value":100
},
"conversionTime":"2024-05-14T10:11:45.057+0000"
}
]
}
},
"Submit Conversion Events":{
"summary":"Submit Conversion Events",
"value":{
"sourceId":"263258390011723",
"conversions":[
{
"ctwaClickId":"ARAkLkA8rmlFeiCktEJQ-QT",
"type":"PURCHASE",
"details":{
"currency":"USD",
"value":100
},
"conversionTime":"2024-05-14T10:11:45.057+0000"
},
{
"ctwaClickId":"ALAkRkA0rmzFeoCktEJQ-PT",
"type":"LEAD_SUBMITTED",
"details":{
"currency":"USD",
"value":200
},
"conversionTime":"2024-05-14T12:11:45.057+0000"
}
]
}
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"Conversions were submitted"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Unresolved page ID":{
"summary":"Unresolved page ID",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"sourceId",
"violation":"Can't find appropriate `sourceId` among connected conversion sources."
}
],
"resources":[]
}
},
"Ambiguous page ID":{
"summary":"Ambiguous page ID",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"sourceId",
"violation":"`sourceId` is ambiguous. Exact `sourceId` should be specified."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"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":[
"whatsapp:conversions"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/whatsapp/1/conversions/waba":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-ad-conversions"
],
"summary":"Submit WABA conversions",
"description":"Submit WhatsApp conversion events using your WhatsApp Business Account (WABA) phone number as the source. Each conversion event is linked to an ad click via ctwaClickId — a unique identifier contained within the inbound WhatsApp message originating from the ad. You can optionally include conversion details such as value and currency, and a conversion timestamp (up to 7 days in the past). Events are submitted in batches of up to 1,000 and are indivisible — either all are submitted or none.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"submit-waba-whatsapp-conversions",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.WABAConversionEventRequest"
},
"examples":{
"Submit WABA Conversion Event":{
"summary":"Submit WABA Conversion Event",
"value":{
"conversions":[
{
"conversionTime":"2024-05-14T10:11:45.057Z",
"ctwaClickId":"ARAkLkA8rmlFeiCktEJQ-QT",
"details":{
"currency":"USD",
"value":100
},
"type":"PURCHASE"
}
],
"sourceId":"1234567890"
}
},
"Submit WABA Conversion Events":{
"summary":"Submit WABA Conversion Events",
"value":{
"conversions":[
{
"conversionTime":"2024-05-14T10:11:45.057Z",
"ctwaClickId":"ARAkLkA8rmlFeiCktEJQ-QT",
"details":{
"currency":"USD",
"value":100
},
"type":"PURCHASE"
},
{
"conversionTime":"2024-05-14T12:11:45.057Z",
"ctwaClickId":"ALAkRkA0rmzFeoCktEJQ-PT",
"details":{
"currency":"USD",
"value":200
},
"type":"LEAD_SUBMITTED"
}
],
"sourceId":"1234567890"
}
}
}
}
},
"required":true
},
"responses":{
"204":{
"description":"Conversions were submitted"
},
"400":{
"description":"Bad request or missing required fields",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"WABA phone number not found":{
"summary":"WABA phone number not found",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"sourceId",
"violation":"Can't find appropriate `sourceId` among registered WABA phone numbers."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"WABA not found or no dataset configured",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"WABA not found or no dataset configured":{
"summary":"WABA not found or no dataset configured",
"value":{
"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":[
{
"property":"sourceId",
"violation":"No WABA or dataset found for the provided `sourceId`."
}
],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"whatsapp:conversions"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
}
},
"components":{
"schemas":{
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJson":{
"type":"object",
"additionalProperties":{
"type":"object",
"description":"Flow JSON file content. The size is limited to 10 MB."
},
"title":"AddFlowJson"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonResponse":{
"type":"object",
"properties":{
"validationErrors":{
"type":"array",
"description":"Errors found during validation of the uploaded file.",
"items":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonValidationError"
}
}
},
"required":[
"validationErrors"
],
"title":"AddFlowJsonResponse"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonValidationError":{
"type":"object",
"description":"Errors found during validation of the uploaded file.",
"properties":{
"error":{
"type":"string",
"description":"Error.",
"example":"INVALID_PROPERTY"
},
"errorType":{
"type":"string",
"description":"Error type.",
"example":"JSON_SCHEMA_ERROR"
},
"message":{
"type":"string",
"description":"Message.",
"example":"The property \"initial-text\" cannot be specified at \"$root/screens/0/layout/children/2/children/0\"."
},
"lineStart":{
"type":"integer",
"format":"int32",
"description":"Line that mark beginning of error.",
"example":46
},
"lineEnd":{
"type":"integer",
"format":"int32",
"description":"Line that mark end of error.",
"example":46
},
"columnStart":{
"type":"integer",
"format":"int32",
"description":"Column that mark beginning of error.",
"example":17
},
"columnEnd":{
"type":"integer",
"format":"int32",
"description":"Column that mark end of error.",
"example":30
}
},
"title":"AddFlowJsonValidationError"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.CreateFlowRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Name of the flow.",
"example":"My first flow",
"maxLength":200,
"minLength":1
},
"categories":{
"type":"array",
"description":"Categories of the flow.",
"example":"SIGN_UP",
"items":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory"
}
},
"cloneFlowId":{
"type":"string",
"description":"ID of source Flow to clone. The new flow with DRAFT status will inherit the flow.json from source flow.",
"example":"987654"
}
},
"required":[
"categories",
"name"
],
"title":"CreateFlowRequest"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory":{
"type":"string",
"description":"Categories of the flow.",
"enum":[
"SIGN_UP",
"SIGN_IN",
"APPOINTMENT_BOOKING",
"LEAD_GENERATION",
"CONTACT_US",
"CUSTOMER_SUPPORT",
"SURVEY",
"OTHER",
"SHOPPING",
"UNKNOWN"
],
"example":"SIGN_UP",
"title":"FlowCategory"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse":{
"type":"object",
"description":"List of found flows.",
"properties":{
"id":{
"type":"string",
"description":"ID of the flow.",
"example":"123456"
},
"name":{
"type":"string",
"description":"Name of the flow.",
"example":"My first flow"
},
"businessAccountId":{
"type":"integer",
"format":"int64",
"description":"WhatsApp business account ID.",
"example":987654
},
"categories":{
"type":"array",
"description":"Categories of the flow.",
"example":"SIGN_UP",
"items":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory"
}
},
"status":{
"type":"string",
"description":"Status of the flow.",
"enum":[
"DRAFT",
"PUBLISHED",
"DEPRECATED",
"BLOCKED",
"THROTTLED"
],
"example":"DRAFT"
},
"initialScreens":{
"type":"array",
"description":"IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing.",
"items":{
"type":"string",
"description":"IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing."
},
"uniqueItems":true
}
},
"required":[
"businessAccountId",
"categories",
"id",
"name",
"status"
],
"title":"FlowDataResponse"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowPreview":{
"type":"object",
"properties":{
"previewUrl":{
"type":"string",
"description":"Link for the preview page.",
"example":"https://example.com/"
},
"expiresAt":{
"type":"string",
"format":"date-time",
"description":"Time when the link will expire and the developer needs to call the API again to get a new link. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"example":"2023-05-21T11:18:09Z"
}
},
"required":[
"expiresAt",
"previewUrl"
],
"title":"FlowPreview"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowRequestApiData":{
"type":"object",
"properties":{
"prompt":{
"type":"string",
"description":"Prompt for flow generation.",
"example":"Flow that contains form with name, surname and email of the user."
},
"responseId":{
"type":"string",
"description":"Optional identifier of a previous response. If provided, this request will update or modify the generatedFlow associated with the given responseId. Use this to refine or change an existing flow by referencing an earlier response.",
"example":"12345"
}
},
"required":[
"prompt"
],
"title":"GenerateFlowRequestApiData"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowResponseApiData":{
"type":"object",
"properties":{
"originalPrompt":{
"type":"string",
"description":"The prompt text used to generate this flow.",
"example":"Flow that contains form with name, surname and email of the user."
},
"responseId":{
"type":"string",
"description":"Unique identifier for this response. Use this value in future requests to reference generated flow.",
"example":"12345"
},
"generatedFlow":{
"type":"object",
"description":"The generated output corresponding to the provided prompt."
}
},
"required":[
"generatedFlow",
"originalPrompt",
"responseId"
],
"title":"GenerateFlowResponseApiData"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetFlowJsonResponse":{
"type":"object",
"properties":{
"externalDownloadUrl":{
"type":"string",
"description":"External link to download the Flow JSON file.",
"example":"https://example.com"
}
},
"required":[
"externalDownloadUrl"
],
"title":"GetFlowJsonResponse"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetSenderFlowsResponse":{
"type":"object",
"properties":{
"flows":{
"type":"array",
"description":"List of found flows.",
"items":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse"
}
}
},
"required":[
"flows"
],
"title":"GetSenderFlowsResponse"
},
"0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.UpdateFlowRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Name of the flow.",
"example":"Flow new name",
"maxLength":200,
"minLength":1
},
"categories":{
"type":"array",
"description":"Categories of the flow.",
"items":{
"$ref":"#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory"
}
}
},
"title":"UpdateFlowRequest"
},
"01b456ee89723218fe6e9044f9e602d2dda7aa7bf5bc0607681dd5bae7f811b9.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryReport":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/31df1a57142f86aa8caefaa914e5a897a1c5c119e96ae8d3d5f19b12a525e2b7.Report"
}
],
"title":"DeliveryReport"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryResult":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of reports, one per every message.",
"items":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryReport"
},
"readOnly":false,
"writeOnly":true
}
},
"title":"whatsappDlrReportsResponse"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Display name of the end user.",
"readOnly":false,
"writeOnly":true
},
"phoneNumber":{
"type":"string",
"description":"Sender's phone number. May be absent if the user has enabled the Meta username feature and you have not exchanged messages with them in the last 30 days.",
"readOnly":false,
"writeOnly":true
},
"userId":{
"type":"string",
"description":"Business-scoped user ID (BSUID) assigned by Meta. Stable identifier for the end user, scoped to the receiving business.",
"readOnly":false,
"writeOnly":true
},
"parentUserId":{
"type":"string",
"description":"Business-scoped user ID valid across all phone numbers in a linked business portfolio. Present only for managed businesses with portfolio linking enabled.",
"readOnly":false,
"writeOnly":true
},
"username":{
"type":"string",
"description":"Meta username of the end user. Present only if the user has a Meta username.",
"readOnly":false,
"writeOnly":true
}
},
"title":"DlrContact"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotification":{
"type":"object",
"properties":{
"sender":{
"type":"string",
"description":"Registered WhatsApp sender number.",
"minLength":1
},
"from":{
"type":"string",
"description":"End user's phone number.",
"minLength":1
},
"notificationMessagesStatus":{
"type":"string",
"description":"Status of marketing update notification.",
"minLength":1
},
"description":{
"type":"string",
"description":"Description of marketing update notification.",
"minLength":1
}
},
"title":"whatsappMarketingUpdateNotification"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotificationResponse":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number.",
"minLength":1
},
"content":{
"allOf":[
{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotification"
}
],
"description":"Content of the notification."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the event occurred. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
}
},
"title":"whatsappMarketingUpdateNotificationResponse"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotification":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Number of the payer.",
"minLength":1
},
"type":{
"type":"string",
"description":"Type of the notification. It is always `payment`.",
"minLength":1
},
"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
},
"paymentStatus":{
"type":"string",
"description":"Status of the payment.",
"enum":[
"NEW",
"PENDING",
"CAPTURED",
"CANCELED",
"FAILED",
"UNKNOWN"
]
},
"currency":{
"type":"string",
"description":"Currency of the payment.",
"enum":[
"INR",
"BRL",
"UNKNOWN"
]
},
"totalAmountValue":{
"type":"integer",
"description":"Value of the payment amount multiplied by the offset.",
"minimum":1
},
"totalAmountOffset":{
"type":"integer",
"description":"Offset of the payment amount (100 for INR and BRL).",
"minimum":1
},
"callbackData":{
"type":"array",
"description":"List of custom parameters corresponding to the transaction. Available only for UPI Payments.",
"items":{
"type":"string",
"minLength":0
},
"minItems":0
},
"transactions":{
"type":"array",
"description":"Transactions of the payment.",
"items":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentTransactionNotification"
},
"minItems":0
}
},
"title":"whatsappPaymentNotification"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotificationResponse":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number.",
"minLength":1
},
"content":{
"allOf":[
{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotification"
}
],
"description":"Content of the notification."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the event occurred. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
}
},
"title":"whatsappPaymentNotificationResponse"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentTransactionNotification":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the transaction.",
"minLength":1
},
"type":{
"type":"string",
"description":"Type of the transaction.",
"enum":[
"UPI",
"BR",
"UNKNOWN"
]
},
"status":{
"type":"string",
"description":"Status of the transaction.",
"enum":[
"PENDING",
"FAILED",
"SUCCESS",
"CANCELED",
"UNKNOWN"
]
},
"createdTimestamp":{
"type":"string",
"format":"date-time",
"description":"Creation time of the transaction. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
},
"updatedTimestamp":{
"type":"string",
"format":"date-time",
"description":"Update time of the transaction. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
}
},
"title":"whatsappPaymentTransactionNotification"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenReport":{
"type":"object",
"properties":{
"messageId":{
"type":"string",
"description":"The ID of the sent message.",
"readOnly":false,
"writeOnly":true
},
"from":{
"type":"string",
"description":"Number which sent the message.",
"readOnly":false,
"writeOnly":true
},
"to":{
"type":"string",
"description":"Registered WhatsApp business number.",
"readOnly":false,
"writeOnly":true
},
"sentAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the message was sent.",
"readOnly":false,
"writeOnly":true
},
"seenAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the message was seen.",
"readOnly":false,
"writeOnly":true
},
"applicationId":{
"type":"string",
"description":"Application id that the message is linked to.",
"readOnly":false,
"writeOnly":true
},
"entityId":{
"type":"string",
"description":"Entity id that the message is linked to.",
"readOnly":false,
"writeOnly":true
},
"contact":{
"allOf":[
{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact"
}
],
"description":"End user contact.",
"readOnly":false,
"writeOnly":true
}
},
"title":"SeenReport"
},
"0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenResult":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of reports, one per every message.",
"items":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenReport"
},
"readOnly":false,
"writeOnly":true
}
},
"title":"whatsappDlrSeenReportsResponse"
},
"18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse":{
"type":"object",
"description":"List of all templates for given sender.",
"properties":{
"id":{
"type":"string",
"description":"Template ID.",
"example":"111"
},
"businessAccountId":{
"type":"integer",
"format":"int64",
"description":"Business account ID to which template belongs.",
"example":222
},
"name":{
"type":"string",
"description":"Name of the template.",
"example":"template_name"
},
"language":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language"
},
"status":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status"
},
"category":{
"type":"string",
"description":"Category of the template.",
"enum":[
"ACCOUNT_UPDATE",
"PAYMENT_UPDATE",
"PERSONAL_FINANCE_UPDATE",
"SHIPPING_UPDATE",
"RESERVATION_UPDATE",
"ISSUE_RESOLUTION",
"APPOINTMENT_UPDATE",
"TRANSPORTATION_UPDATE",
"TICKET_UPDATE",
"ALERT_UPDATE",
"AUTO_REPLY",
"TRANSACTIONAL",
"OTP",
"MARKETING",
"AUTHENTICATION",
"UTILITY"
],
"example":"ACCOUNT_UPDATE"
},
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData"
}
},
"title":"TemplateResponse"
},
"18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplatesApiResponse":{
"type":"object",
"properties":{
"templates":{
"type":"array",
"description":"List of all templates for given sender.",
"items":{
"$ref":"#/components/schemas/18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse"
}
}
},
"title":"TemplatesResponse"
},
"2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType":{
"type":"string",
"description":"Type of the phone number. It specifies verification type.",
"enum":[
"EXTERNAL_SMS",
"EXTERNAL_VOICE"
],
"example":"EXTERNAL_SMS",
"title":"NumberType"
},
"30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.OtpRequest":{
"type":"object",
"properties":{
"type":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType"
},
"locale":{
"type":"string",
"default":"en_US",
"description":"Locale which will be used to submit for verification.",
"example":"en_US"
}
},
"required":[
"locale",
"type"
],
"title":"OtpRequest"
},
"30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.PhoneNumberRequest":{
"type":"object",
"properties":{
"countryCode":{
"type":"string",
"description":"Country code of the phone number.",
"example":"44"
},
"phoneNumber":{
"type":"string",
"description":"Phone number to add.",
"example":"7796344125"
},
"displayName":{
"type":"string",
"description":"Display name of the phone number.",
"example":"Infobip"
},
"type":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType"
},
"locale":{
"type":"string",
"default":"en_US",
"description":"Locale which will be used to submit for verification.",
"example":"en_US"
}
},
"required":[
"countryCode",
"displayName",
"locale",
"phoneNumber",
"type"
],
"title":"PhoneNumberRequest"
},
"30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.VerifyCodeRequest":{
"type":"object",
"properties":{
"code":{
"type":"string",
"description":"Verification code.",
"example":"123456"
}
},
"required":[
"code"
],
"title":"VerifyCodeRequest"
},
"30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationResponse":{
"type":"object",
"properties":{
"status":{
"$ref":"#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationStatus"
}
},
"required":[
"status"
],
"title":"WhatsAppSenderRegistrationResponse"
},
"30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationStatus":{
"type":"string",
"description":"Add phone number status.",
"enum":[
"SUBMITTED_FOR_REGISTRATION",
"OTP_REQUESTED"
],
"example":"SUBMITTED_FOR_REGISTRATION",
"title":"WhatsAppSenderRegistrationStatus"
},
"31df1a57142f86aa8caefaa914e5a897a1c5c119e96ae8d3d5f19b12a525e2b7.Report":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the request.",
"readOnly":false,
"writeOnly":true
},
"price":{
"allOf":[
{
"$ref":"#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price"
}
],
"description":"Sent message price.",
"readOnly":false,
"writeOnly":true
},
"status":{
"allOf":[
{
"$ref":"#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Status"
}
],
"description":"Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.",
"readOnly":false,
"writeOnly":true
},
"error":{
"allOf":[
{
"$ref":"#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Error"
}
],
"description":"Indicates whether the error occurred during the query execution.",
"readOnly":false,
"writeOnly":true
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"readOnly":false,
"writeOnly":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":false,
"writeOnly":true
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"The number of sent message segments.",
"readOnly":false,
"writeOnly":true
},
"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`.",
"readOnly":false,
"writeOnly":true
},
"to":{
"type":"string",
"description":"The message destination address.",
"readOnly":false,
"writeOnly":true
},
"contact":{
"allOf":[
{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact"
}
],
"description":"End user contact.",
"readOnly":false,
"writeOnly":true
}
},
"title":"Report"
},
"3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Error":{
"type":"object",
"properties":{
"description":{
"type":"string",
"description":"Human-readable description of the error.",
"readOnly":false,
"writeOnly":true
},
"permanent":{
"type":"boolean",
"description":"Indicates whether the error is permanent.",
"readOnly":false,
"writeOnly":true
},
"name":{
"type":"string",
"description":"Error name.",
"readOnly":false,
"writeOnly":true
},
"id":{
"type":"integer",
"format":"int32",
"description":"Error ID.",
"readOnly":false,
"writeOnly":true
},
"groupName":{
"type":"string",
"description":"Error group name.",
"readOnly":false,
"writeOnly":true
},
"groupId":{
"type":"integer",
"format":"int32",
"description":"Error group ID.",
"readOnly":false,
"writeOnly":true
}
},
"title":"Error"
},
"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"
},
"3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Status":{
"type":"object",
"properties":{
"groupName":{
"type":"string",
"description":"Group name for the status.",
"readOnly":false,
"writeOnly":true
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status ID.",
"readOnly":false,
"writeOnly":true
},
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID.",
"readOnly":false,
"writeOnly":true
},
"name":{
"type":"string",
"description":"Status name.",
"readOnly":false,
"writeOnly":true
},
"action":{
"type":"string",
"description":"Action that should be taken to fix the error.",
"readOnly":false,
"writeOnly":true
},
"description":{
"type":"string",
"description":"Human-readable description of the status.",
"readOnly":false,
"writeOnly":true
}
},
"title":"Status"
},
"3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment":{
"type":"object",
"properties":{
"referenceId":{
"type":"string",
"description":"Unique identifier generated by the payment service provider.",
"example":"72123248136"
},
"paymentId":{
"type":"string",
"description":"Unique identifier of the payment.",
"example":"16085194825"
},
"paymentStatus":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentStatus"
},
"currency":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentCurrency"
},
"totalAmountValue":{
"type":"integer",
"format":"int32",
"description":"Value of the payment amount.",
"example":21000
},
"totalAmountOffset":{
"type":"integer",
"format":"int32",
"description":"Offset of the payment amount.",
"example":100
},
"transactions":{
"type":"array",
"description":"Transactions of the payment.",
"items":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransaction"
}
},
"callbackData":{
"type":"object",
"description":"Custom parameters corresponding to the transaction. Available only for PayU UPI Payments and Razorpay."
}
},
"required":[
"currency",
"paymentStatus",
"referenceId",
"totalAmountOffset",
"totalAmountValue",
"transactions"
],
"title":"Payment"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.MarkAsReadErrorResponse":{
"type":"object",
"properties":{
"error":{
"type":"string",
"description":"Error details"
}
},
"title":"MarkAsReadErrorResponse"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentCurrency":{
"type":"string",
"description":"Currency of the payment.",
"enum":[
"INR",
"BRL",
"UNKNOWN"
],
"example":"INR",
"title":"PaymentCurrency"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentStatus":{
"type":"string",
"description":"Status of the payment.",
"enum":[
"NEW",
"PENDING",
"CAPTURED",
"CANCELED",
"FAILED",
"UNKNOWN"
],
"example":"PENDING",
"title":"PaymentStatus"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransaction":{
"type":"object",
"description":"Transactions of the payment.",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the transaction.",
"example":"27194245144"
},
"type":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionType"
},
"status":{
"$ref":"#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionStatus"
},
"createdTimestamp":{
"type":"string",
"format":"date-time",
"description":"Creation time of the transaction."
},
"updatedTimestamp":{
"type":"string",
"format":"date-time",
"description":"Update time of the transaction."
}
},
"required":[
"createdTimestamp",
"id",
"status",
"type",
"updatedTimestamp"
],
"title":"PaymentTransaction"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionStatus":{
"type":"string",
"description":"Status of the transaction.",
"enum":[
"PENDING",
"FAILED",
"SUCCESS",
"CANCELED",
"UNKNOWN"
],
"example":"SUCCESS",
"title":"PaymentTransactionStatus"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionType":{
"type":"string",
"description":"Type of the transaction.",
"enum":[
"UPI",
"BR",
"UNKNOWN"
],
"example":"UPI",
"title":"PaymentTransactionType"
},
"43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.UrlDeletionRequest":{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the WhatsApp media to be deleted.",
"example":"https://www.infobip.com/infobip-logo.png"
}
},
"required":[
"url"
],
"title":"UrlDeletionRequest"
},
"52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.ConversionDetails":{
"type":"object",
"description":"Details should contain value and currency information indicating exact value of the conversion that happened. ",
"properties":{
"currency":{
"type":"string",
"description":"Currency of the conversion. Has to be the same as it is set on ad account.",
"example":"USD"
},
"value":{
"type":"number",
"description":"Value of the conversion. Can be 0.",
"example":100
}
},
"required":[
"currency",
"value"
],
"title":"ConversionDetails"
},
"52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionModel":{
"type":"object",
"description":"Conversions collection.",
"properties":{
"ctwaClickId":{
"type":"string",
"description":"ctwaClickId is unique identifier of each click on the ad that clicks to WhatsApp. ctwaClickId is contained within the inbound message originating from the ad within the referral object. Check payload [here](https://www.infobip.com/docs/api/channels/whatsapp/whatsapp-inbound-messages/receive-whatsapp-inbound-messages).",
"example":"ARAkLkA8rmlFeiCktEJQ-QT"
},
"type":{
"$ref":"#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionType"
},
"details":{
"$ref":"#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.ConversionDetails"
},
"conversionTime":{
"type":"string",
"format":"date-time",
"description":"Time when the conversion happened. Must be in the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Date must not be older than 7 days. If omitted then current time of submission is used.",
"example":"2024-05-14T10:11:45.057Z"
}
},
"required":[
"ctwaClickId",
"type"
],
"title":"MetaConversionModel"
},
"52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionType":{
"type":"string",
"description":"Type of the conversion. Can be `PURCHASE` or `LEAD_SUBMITTED`.",
"enum":[
"PURCHASE",
"LEAD_SUBMITTED",
"INITIATE_CHECKOUT",
"ADD_TO_CART",
"VIEW_CONTENT",
"ORDER_CREATED",
"ORDER_SHIPPED",
"ORDER_DELIVERED",
"ORDER_CANCELED",
"ORDER_RETURNED",
"CART_ABANDONED",
"QUALIFIED_LEAD",
"RATING_PROVIDED",
"REVIEW_PROVIDED"
],
"example":"PURCHASE",
"title":"MetaConversionType"
},
"52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.WABAConversionEventRequest":{
"type":"object",
"properties":{
"sourceId":{
"type":"string",
"description":"Sender as source identifier. This is the phone number registered via the embedded signup flow available in Exchange app.",
"example":"1234567890"
},
"conversions":{
"type":"array",
"description":"Conversion events collection.",
"items":{
"$ref":"#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionModel"
},
"maxItems":1000,
"minItems":1
}
},
"required":[
"conversions",
"sourceId"
],
"title":"WABAConversionEventRequest"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoRequest":{
"type":"object",
"properties":{
"about":{
"type":"string",
"description":"Manages the content of the sender\\'s **About** section.",
"example":"Infobip Business Account",
"maxLength":130,
"minLength":0
},
"address":{
"type":"string",
"description":"Street address of the business.",
"example":"35-38 New Bridge Street, London EC4V 6BW",
"maxLength":256,
"minLength":0
},
"description":{
"type":"string",
"description":"Description of the business.",
"example":"Infobip is a global cloud communications platform.",
"maxLength":512,
"minLength":0
},
"email":{
"type":"string",
"description":"Email of the business.",
"example":"info@example.com",
"maxLength":128,
"minLength":0
},
"vertical":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical"
},
"websites":{
"type":"array",
"description":"Websites of the business.",
"example":"https://www.infobip.com",
"items":{
"type":"string",
"description":"Websites of the business.",
"example":"https://www.infobip.com",
"maxLength":256,
"minLength":0
},
"maxItems":2,
"minItems":0
},
"logoUrl":{
"type":"string",
"description":"URL of the business' logo. Must be a valid URL starting with `https://` or `http://`. Supported logo types are `JPEG`, `PNG`. Log file should be at least 192x192 pixels and at most 640x640 pixels.",
"example":"https://example.com/logo",
"maxLength":2048,
"minLength":0
}
},
"title":"BusinessInfoRequest"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoResponse":{
"type":"object",
"properties":{
"about":{
"type":"string",
"description":"Manages the content of the sender\\'s **About** section.",
"example":"Infobip Business Account"
},
"address":{
"type":"string",
"description":"Street address of the business.",
"example":"35-38 New Bridge Street, London EC4V 6BW"
},
"description":{
"type":"string",
"description":"Description of the business.",
"example":"Infobip is a global cloud communications platform."
},
"email":{
"type":"string",
"description":"Email of the business.",
"example":"info@example.com"
},
"vertical":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical"
},
"websites":{
"type":"array",
"description":"Websites of the business.",
"example":"https://www.infobip.com",
"items":{
"type":"string",
"description":"Websites of the business.",
"example":"https://www.infobip.com"
}
},
"displayName":{
"type":"string",
"description":"Display name of the phone number.",
"example":"Infobip"
}
},
"required":[
"about",
"address",
"description",
"displayName",
"email",
"vertical",
"websites"
],
"title":"BusinessInfoResponse"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical":{
"type":"string",
"description":"Business vertical.",
"enum":[
"AUTOMOTIVE",
"BEAUTY_AND_SPA_AND_SALON",
"CLOTHING_AND_APPAREL",
"EDUCATION",
"ENTERTAINMENT",
"EVENT_PLANNING_AND_SERVICE",
"FINANCE_AND_BANKING",
"FOOD_AND_GROCERY",
"PUBLIC_SERVICE",
"HOTEL_AND_LODGING",
"MEDICAL_AND_HEALTH",
"NON_PROFIT",
"PROFESSIONAL_SERVICES",
"SHOPPING_AND_RETAIL",
"TRAVEL_AND_TRANSPORTATION",
"RESTAURANT",
"OTHER",
"UNKNOWN"
],
"example":"PROFESSIONAL_SERVICES",
"title":"BusinessVertical"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionAction":{
"type":"object",
"description":"A list of actions a sender may undertake to facilitate a call permission or a business initiated call.",
"properties":{
"name":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionName"
},
"canPerformAction":{
"type":"boolean",
"description":"Whether the action can be performed now, taking into account all limits."
},
"limits":{
"type":"array",
"description":"A list of time-bound restrictions for the given action.",
"items":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionLimit"
}
}
},
"required":[
"canPerformAction",
"limits",
"name"
],
"title":"CallingPermissionAction"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionLimit":{
"type":"object",
"description":"A list of time-bound restrictions for the given action.",
"properties":{
"timePeriod":{
"type":"string",
"format":"duration",
"description":"Duration for which the limitation is applied in ISO 8601 format.",
"example":"P7DT1H30M"
},
"maxAllowed":{
"type":"integer",
"format":"int32",
"description":"The maximum number of actions allowed within the specified time period.",
"example":5
},
"currentUsage":{
"type":"integer",
"format":"int32",
"description":"The current number of actions the business has taken within the specified time period.",
"example":1
},
"limitExpirationTime":{
"type":"string",
"format":"date-time",
"description":"Time at which the limit will expire.",
"example":"2025-10-06T08:12:26.422Z"
}
},
"required":[
"currentUsage",
"maxAllowed",
"timePeriod"
],
"title":"CallingPermissionActionLimit"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionName":{
"type":"string",
"description":"Name of calling permission related action.
`START_CALL` - The action of establishing a new call with the end user.
`SEND_CALL_PERMISSION_REQUEST` - The action of sending new call permissions request messages to end user.",
"enum":[
"START_CALL",
"SEND_CALL_PERMISSION_REQUEST"
],
"example":"SEND_CALL_PERMISSION_REQUEST",
"title":"CallingPermissionActionName"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionStatus":{
"type":"string",
"description":"The current status of sender's calling permission.
`NO_PERMISSION` - The end user has not granted calling permission to the sender.
`TEMPORARY` - The end user has granted a temporary calling permission to the sender.
`PERMANENT` - The end user has granted permanent calling permission to the sender.",
"enum":[
"NO_PERMISSION",
"TEMPORARY",
"PERMANENT"
],
"example":"NO_PERMISSION",
"title":"CallingPermissionStatus"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.SenderPublicKeyResponse":{
"type":"object",
"description":"WhatsApp sender public key information",
"properties":{
"publicKey":{
"type":"string",
"description":"PEM-formatted customer public key",
"example":"-----BEGIN RSA PUBLIC KEY-----\nMIIBIjANBgkqhkiG...\n-----END RSA PUBLIC KEY-----"
},
"publicKeySignatureStatus":{
"type":"string",
"description":"Status of the customer public key signature",
"example":"VALID"
}
},
"required":[
"publicKey",
"publicKeySignatureStatus"
],
"title":"SenderPublicKeyResponse"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.UploadKeyApiDoc":{
"type":"object",
"properties":{
"file":{
"type":"string",
"format":"binary",
"description":"Multipart form data containing the public key file. \n The file must be in PEM format with a 2048-bit RSA key\n and include the appropriate header and footer lines.\n Example file content: `----BEGIN PUBLIC KEY-----\\n MIIBIjAN... \\n ----END PUBLIC"
}
},
"required":[
"file"
],
"title":"UploadKeyApiDoc"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppCallingPermissionResponse":{
"type":"object",
"properties":{
"status":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionStatus"
},
"actions":{
"type":"array",
"description":"A list of actions a sender may undertake to facilitate a call permission or a business initiated call.",
"items":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionAction"
}
},
"expirationTime":{
"type":"string",
"format":"date-time",
"description":"Time at which the calling permission will expire. Present only when `TEMPORARY` permission is granted.",
"example":"2025-10-06T08:12:26.422Z"
}
},
"required":[
"actions",
"status"
],
"title":"WhatsAppCallingPermissionResponse"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderLimit":{
"type":"string",
"description":"Current limit of the Business Portfolio.",
"enum":[
"LIMIT_NA",
"LIMIT_250",
"LIMIT_2K",
"LIMIT_10K",
"LIMIT_100K",
"UNLIMITED"
],
"example":"LIMIT_10K",
"title":"WhatsAppSenderLimit"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQuality":{
"type":"object",
"description":"List of the quality information related to specific senders.",
"properties":{
"sender":{
"type":"string",
"description":"Sender to whom the information refers.",
"example":"447796344125"
},
"qualityRating":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityRating"
},
"status":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderStatus"
},
"currentLimit":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderLimit"
},
"lastUpdated":{
"type":"string",
"format":"date-time",
"description":"Last modification date.",
"example":"2023-02-18T08:12:26.422Z"
}
},
"required":[
"currentLimit",
"qualityRating",
"sender",
"status"
],
"title":"WhatsAppSenderQuality"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityRating":{
"type":"string",
"description":"Quality of the sender.",
"enum":[
"HIGH",
"LOW",
"MEDIUM",
"UNKNOWN"
],
"example":"HIGH",
"title":"WhatsAppSenderQualityRating"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"List of the quality information related to specific senders.",
"items":{
"$ref":"#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQuality"
}
}
},
"required":[
"results"
],
"title":"WhatsAppSenderQualityResponse"
},
"6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderStatus":{
"type":"string",
"description":"Status of the sender.",
"enum":[
"BANNED",
"CONNECTED",
"DELETED",
"DISCONNECTED",
"FLAGGED",
"MIGRATED",
"PENDING",
"RATE_LIMITED",
"RESTRICTED",
"UNKNOWN",
"UNVERIFIED"
],
"example":"CONNECTED",
"title":"WhatsAppSenderStatus"
},
"790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"8cb345d2b2e2a0cd5a7383bf2012768938eaa465c6e4f6554958ac7f4a58aa3f.V1TemplatePublicApiRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Template name. Must only contain lowercase alphanumeric characters and underscores."
},
"language":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language"
},
"category":{
"type":"string",
"description":"All listed categories will be available until May 1, 2023.",
"enum":[
"ACCOUNT_UPDATE",
"PAYMENT_UPDATE",
"PERSONAL_FINANCE_UPDATE",
"SHIPPING_UPDATE",
"RESERVATION_UPDATE",
"ISSUE_RESOLUTION",
"APPOINTMENT_UPDATE",
"TRANSPORTATION_UPDATE",
"TICKET_UPDATE",
"ALERT_UPDATE",
"AUTO_REPLY"
],
"example":"ACCOUNT_UPDATE"
},
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData"
}
},
"required":[
"category",
"language",
"name",
"structure"
],
"title":"TemplateRequest"
},
"8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"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"
},
"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"
},
"a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityConfirmation":{
"type":"object",
"properties":{
"hash":{
"type":"string",
"description":"Identity hash",
"example":"eU2Fdi4EMUw="
}
},
"required":[
"hash"
],
"title":"IdentityConfirmation"
},
"ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityInfo":{
"type":"object",
"properties":{
"acknowledged":{
"type":"boolean",
"description":"Identity acknowledge status",
"example":true
},
"hash":{
"type":"string",
"description":"Identity hash",
"example":"eU2Fdi4EMUw="
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Identity event creation date"
}
},
"required":[
"acknowledged",
"createdAt",
"hash"
],
"title":"IdentityInfo"
},
"d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEvent":{
"type":"object",
"properties":{
"description":{
"type":"string",
"description":"Description of the event.",
"readOnly":false,
"writeOnly":true
},
"hash":{
"type":"string",
"description":"Identity hash.",
"readOnly":false,
"writeOnly":true
},
"type":{
"type":"string",
"description":"Indicates type of system event forwarded.",
"enum":[
"user_identity_changed"
],
"readOnly":false,
"writeOnly":true
},
"userNumber":{
"type":"string",
"description":"End user's number. Must be in international format.",
"readOnly":false,
"writeOnly":true
},
"userId":{
"type":"string",
"description":"Business-scoped user ID (BSUID) assigned by Meta. Stable identifier for the end user, scoped to the receiving business.",
"readOnly":false,
"writeOnly":true
}
},
"title":"whatsappSystemReportsSystemEvent"
},
"d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEventResponse":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number."
},
"content":{
"allOf":[
{
"$ref":"#/components/schemas/d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEvent"
}
],
"description":"Content of the event."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the event occurred. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
}
},
"title":"whatsappSystemReportsSystemEventResponse"
},
"d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventModel":{
"type":"object",
"description":"Conversion events collection.",
"properties":{
"ctwaClickId":{
"type":"string",
"description":"ctwaClickId is unique identifier of each click on the ad that clicks to WhatsApp. ctwaClickId is contained within the inbound message originating from the ad within the referral object. Check payload [here](https://www.infobip.com/docs/api/channels/whatsapp/whatsapp-inbound-messages/receive-whatsapp-inbound-messages).",
"example":"ARAkLkA8rmlFeiCktEJQ-QT",
"minLength":1
},
"type":{
"$ref":"#/components/schemas/d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionType"
},
"details":{
"type":"object",
"additionalProperties":{
"type":"object",
"example":{
"currency":"USD",
"value":123
},
"required":[
"currency",
"value"
]
},
"description":"Details should contain value and currency information indicating exact value of the conversion that happened. Value can be 0. Currency has to be the same as it is set on ad account.",
"example":{
"currency":"USD",
"value":123
},
"required":[
"currency",
"value"
]
},
"conversionTime":{
"type":"string",
"format":"date-time",
"description":"Time when the conversion happened. Must be in the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Date must not be older than 7 days. If omitted then current time of submission is used.",
"example":"2024-05-14T10:11:45.057Z"
}
},
"required":[
"ctwaClickId",
"type"
],
"title":"ConversionEventModel"
},
"d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventRequest":{
"type":"object",
"properties":{
"sourceId":{
"type":"string",
"description":"Conversion events source identifier. In case of ads that click to WhatsApp, it should be the Facebook Page selected through Ads manager and through Exchange app. Could be omitted if only one page is connected through Exchange app."
},
"conversions":{
"type":"array",
"description":"Conversion events collection.",
"items":{
"$ref":"#/components/schemas/d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventModel"
},
"maxItems":1000,
"minItems":1
}
},
"required":[
"conversions"
],
"title":"ConversionEventRequest"
},
"d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionType":{
"type":"string",
"description":"Type of the conversion. Can be `PURCHASE` or `LEAD_SUBMITTED`.",
"enum":[
"PURCHASE",
"LEAD_SUBMITTED"
],
"example":"PURCHASE",
"title":"ConversionType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressContent":{
"type":"object",
"description":"Array of addresses information.",
"properties":{
"street":{
"type":"string",
"description":"Street name."
},
"city":{
"type":"string",
"description":"City name."
},
"state":{
"type":"string",
"description":"State name."
},
"zip":{
"type":"string",
"description":"Zip code value."
},
"country":{
"type":"string",
"description":"Country name."
},
"countryCode":{
"type":"string",
"description":"Country code value."
},
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressType"
}
},
"title":"AddressContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressType":{
"type":"string",
"description":"Type of the address. Can be `HOME` or `WORK`.",
"enum":[
"HOME",
"WORK"
],
"title":"AddressType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of an audio sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported audio types are `AAC`, `AMR`, `MP3`, `MP4`, `OPUS`. Maximum audio size is 16MB.",
"maxLength":2048,
"minLength":1
},
"voice":{
"type":"boolean",
"description":"When set to true, the audio message is displayed as a voice note. Voice notes require OGG format with OPUS codec. Maximum size is 16MB."
}
},
"required":[
"mediaUrl"
],
"title":"AudioContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"AudioMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Beneficiary":{
"type":"object",
"description":"Beneficiary of the payment.",
"properties":{
"name":{
"type":"string",
"description":"Beneficiary's name.",
"maxLength":200,
"minLength":0
},
"firstAddressLine":{
"type":"string",
"description":"First address.",
"maxLength":100,
"minLength":0
},
"secondAddressLine":{
"type":"string",
"description":"Second address.",
"maxLength":100,
"minLength":0
},
"city":{
"type":"string",
"description":"City name."
},
"state":{
"type":"string",
"description":"State name."
},
"country":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BeneficiaryCountry"
},
"postalCode":{
"type":"string",
"description":"Zip code value.",
"pattern":"^[0-9]{6}$"
}
},
"required":[
"country",
"firstAddressLine",
"name"
],
"title":"Beneficiary"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BeneficiaryCountry":{
"type":"string",
"description":"Country name.",
"enum":[
"INDIA"
],
"title":"BeneficiaryCountry"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessage":{
"type":"object",
"properties":{
"messages":{
"type":"array",
"description":"An array of messages being sent.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.FailoverMessage"
}
},
"bulkId":{
"type":"string",
"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.",
"maxLength":100,
"minLength":0
}
},
"required":[
"messages"
],
"title":"BulkMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessageInfo":{
"type":"object",
"properties":{
"messages":{
"type":"array",
"description":"Array of sent message objects, one object per every message.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo"
}
},
"bulkId":{
"type":"string",
"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.",
"example":"2034072219640523073"
}
},
"title":"BulkMessageInfo"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CallPermissionReply":{
"type":"object",
"description":"Structure that contains the details of the user response for the call permissions request message.",
"properties":{
"response":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Response"
},
"expirationTimestamp":{
"type":"string",
"format":"date-time",
"description":"Timestamp of when the call permission expires if user accepted the call."
}
},
"required":[
"response"
],
"title":"CallPermissionReply"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent":{
"type":"object",
"description":"Card buttons. Define buttons only for `quick reply` or `dynamic URL` buttons (in the required order). For static URL button, omit the buttons section.",
"discriminator":{
"propertyName":"type",
"mapping":{
"QUICK_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateQuickReplyButtonContent",
"URL":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateUrlButtonContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"CardAllowedTemplateButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactContent":{
"type":"object",
"description":"An array of contacts sent in a WhatsApp message.",
"properties":{
"addresses":{
"type":"array",
"description":"Array of addresses information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressContent"
}
},
"birthday":{
"type":"string",
"description":"Date of birth in `YYYY-MM-DD` format."
},
"emails":{
"type":"array",
"description":"Array of emails information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailContent"
}
},
"name":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.NameContent"
},
"org":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrganizationContent"
},
"phones":{
"type":"array",
"description":"Array of phones information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneContent"
}
},
"urls":{
"type":"array",
"description":"Array of urls information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlContent"
}
}
},
"required":[
"name"
],
"title":"ContactContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"contacts":{
"type":"array",
"description":"An array of contacts sent in a WhatsApp message.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactContent"
}
}
},
"required":[
"contacts"
],
"title":"ContactsContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"ContactsMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context":{
"type":"object",
"description":"Information about the message to which the end user responded.",
"properties":{
"from":{
"type":"string",
"description":"Phone number or Business Scoped User ID (BSUID) of the end user."
},
"id":{
"type":"string",
"description":"MessageId of the message to which the end user responded."
},
"groupId":{
"type":"string",
"description":"GroupId of the message to which the end user responded."
},
"referredProduct":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferredProduct"
}
},
"title":"Context"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DefaultEventRequestOptions":{
"type":"object",
"description":"Options applicable to all events in the request.",
"properties":{
"schedule":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.RequestSchedulingSettings"
}
},
"title":"DefaultEventRequestOptions"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a document sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Maximum document size is 100MB.",
"maxLength":2048,
"minLength":1
},
"caption":{
"type":"string",
"description":"Caption of the document.",
"maxLength":3000,
"minLength":0
},
"filename":{
"type":"string",
"description":"File name of the document.",
"maxLength":240,
"minLength":0
}
},
"required":[
"mediaUrl"
],
"title":"DocumentContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"DocumentMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Email":{
"type":"object",
"description":"Array of emails information.",
"properties":{
"email":{
"type":"string",
"description":"Contact's email."
},
"type":{
"type":"string",
"description":"Type of the email. Can be `HOME` or `WORK`."
}
},
"title":"Email"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailContent":{
"type":"object",
"description":"Array of emails information.",
"properties":{
"email":{
"type":"string",
"description":"Contact's email."
},
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailType"
}
},
"title":"EmailContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailType":{
"type":"string",
"description":"Type of the email. Can be `HOME` or `WORK`.",
"enum":[
"HOME",
"WORK"
],
"title":"EmailType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Failover":{
"type":"object",
"description":"SMS message to be sent if the WhatsApp template message could not be delivered.",
"properties":{
"from":{
"type":"string",
"description":"SMS sender number. Must be in international format.",
"maxLength":24,
"minLength":1
},
"text":{
"type":"string",
"description":"Content of the SMS that will be sent.",
"maxLength":4096,
"minLength":1
}
},
"required":[
"from",
"text"
],
"title":"Failover"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.FailoverMessage":{
"type":"object",
"description":"An array of messages being sent.",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"smsFailover":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Failover"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"FailoverMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Identity":{
"type":"object",
"properties":{
"acknowledged":{
"type":"boolean"
},
"hash":{
"type":"string"
},
"createdAt":{
"type":"string",
"format":"date-time"
}
},
"required":[
"acknowledged",
"createdAt",
"hash"
],
"title":"Identity"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of an image sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.",
"maxLength":2048,
"minLength":1
},
"caption":{
"type":"string",
"description":"Caption of the image.",
"maxLength":3000,
"minLength":0
}
},
"required":[
"mediaUrl"
],
"title":"ImageContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMediaCarouselCardHeader":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeader"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of an image sent in the header. It is expected to be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.",
"maxLength":2048,
"minLength":0
}
}
}
],
"required":[
"type",
"url"
],
"title":"ImageMediaCarouselCardHeader"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"ImageMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InThreadAuthenticationReply":{
"type":"object",
"description":"Structure that contains the details of the in-thread authentication reply.",
"properties":{
"status":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InThreadAuthenticationStatus"
},
"businessScopedPasskeyHash":{
"type":"string",
"description":"Business-scoped passkey hash, present only when status is verified."
}
},
"required":[
"status"
],
"title":"InThreadAuthenticationReply"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InThreadAuthenticationStatus":{
"type":"string",
"description":"Status of the authentication attempt.",
"enum":[
"UNSUPPORTED",
"VERIFIED",
"INTERACTION_CANCELED",
"VERIFICATION_FAILED",
"UNKNOWN"
],
"title":"InThreadAuthenticationStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundAddress":{
"type":"object",
"description":"Array of addresses information.",
"properties":{
"street":{
"type":"string",
"description":"Street name."
},
"city":{
"type":"string",
"description":"City name."
},
"state":{
"type":"string",
"description":"State name."
},
"zip":{
"type":"string",
"description":"Zip code value."
},
"country":{
"type":"string",
"description":"Country name."
},
"countryCode":{
"type":"string",
"description":"Country code value."
},
"type":{
"type":"string",
"description":"Type of the address. Can be `HOME` or `WORK`."
}
},
"title":"InboundAddress"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundContact":{
"type":"object",
"description":"An array of contacts sent in a WhatsApp message.",
"properties":{
"addresses":{
"type":"array",
"description":"Array of addresses information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundAddress"
}
},
"birthday":{
"type":"string",
"format":"date",
"description":"Date of birth in `YYYY-MM-DD` format."
},
"emails":{
"type":"array",
"description":"Array of emails information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Email"
}
},
"name":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundName"
},
"org":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Organization"
},
"phones":{
"type":"array",
"description":"Array of phones information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundPhone"
}
},
"urls":{
"type":"array",
"description":"Array of urls information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Url"
}
}
},
"title":"InboundContact"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundMessagePushko":{
"type":"object",
"description":"Collection of mobile originated messages.",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"from":{
"type":"string",
"description":"Number which sent the message."
},
"to":{
"type":"string",
"description":"Sender provided during the activation process."
},
"integrationType":{
"type":"string",
"description":"Integration type."
},
"receivedAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"keyword":{
"type":"string",
"description":"Keyword extracted from the message text."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the received message."
},
"pairedMessageId":{
"type":"string",
"description":"Message ID of paired outgoing message if matched by Infobip platform."
},
"callbackData":{
"type":"string",
"description":"Callback data sent through ‛callbackData‛ field when sending message."
},
"message":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
"price":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessagePrice"
},
"contact":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactProfile"
},
"identity":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Identity"
}
},
"required":[
"contact",
"from",
"integrationType",
"message",
"messageId",
"price",
"receivedAt",
"to"
],
"title":"InboundMessagePushko"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundName":{
"type":"object",
"description":"Contains information about contact's name.",
"properties":{
"firstName":{
"type":"string",
"description":"Contact's first name."
},
"lastName":{
"type":"string",
"description":"Contact's last name."
},
"middleName":{
"type":"string",
"description":"Contact's middle name."
},
"nameSuffix":{
"type":"string",
"description":"Contact's name suffix."
},
"namePrefix":{
"type":"string",
"description":"Contact's name prefix."
},
"formattedName":{
"type":"string",
"description":"Contact's full name as it normally appears."
}
},
"title":"InboundName"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundPhone":{
"type":"object",
"description":"Array of phones information.",
"properties":{
"phone":{
"type":"string",
"description":"Contact's phone number."
},
"type":{
"type":"string",
"description":"Type of the phone number. Can be `CELL`, `MAIN`, `IPHONE`, `HOME` or `WORK`.",
"enum":[
"CELL",
"MAIN",
"IPHONE",
"HOME",
"WORK"
]
},
"waId":{
"type":"string",
"description":"Contact's WhatsApp ID."
}
},
"title":"InboundPhone"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderBrazilPaymentsDetails":{
"type":"object",
"description":"List of payments. Each payment must have same ID. Maximum 2 payments allowed.",
"discriminator":{
"propertyName":"type",
"mapping":{
"BRAZIL_PIX_DC":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentDetails",
"BRAZIL_BOLETO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentDetails",
"BRAZIL_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentDetails"
}
},
"properties":{
"id":{
"type":"string"
},
"type":{
"type":"string"
}
},
"required":[
"id",
"type"
],
"title":"InteractiveAllowedOrderBrazilPaymentsDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails":{
"type":"object",
"description":"Payment of the order.",
"discriminator":{
"propertyName":"type",
"mapping":{
"UPI_PAYU":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPayUPaymentDetails",
"BRAZIL":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentDetails",
"BRAZIL_PIX_DC":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentDetails",
"BRAZIL_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentDetails",
"BRAZIL_BOLETO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentDetails",
"BRAZIL_PAYMENTS":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentsDetails",
"PG_PAYU":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentDetails",
"PG_RAZORPAY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentDetails",
"UPI_INTENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentDetails",
"UPI_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentDetails"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"InteractiveAllowedOrderPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent":{
"type":"object",
"description":"Body of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"properties":{
"text":{
"type":"string",
"description":"Content of the message body.",
"maxLength":1024,
"minLength":1
}
},
"required":[
"text"
],
"title":"InteractiveBodyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent":{
"type":"object",
"description":"Body of a message containing text only.",
"properties":{
"text":{
"type":"string",
"description":"Content of the message body.",
"maxLength":1024,
"minLength":0
}
},
"required":[
"text"
],
"title":"InteractiveBodyWhatsAppContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonContent":{
"type":"object",
"description":"An array of buttons sent in a message. It can have up to three buttons.",
"discriminator":{
"propertyName":"type",
"mapping":{
"REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveReplyButtonContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"InteractiveButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsActionContent":{
"type":"object",
"description":"Allows you to specify buttons sent in the message.",
"properties":{
"buttons":{
"type":"array",
"description":"An array of buttons sent in a message. It can have up to three buttons.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonContent"
},
"maxItems":3,
"minItems":1
}
},
"required":[
"buttons"
],
"title":"InteractiveButtonsActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsActionContent"
},
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action",
"body"
],
"title":"InteractiveButtonsContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsDocumentHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a document sent in the header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats). Must be a valid URL starting with `https://` or `http://`. Supported document types are `PDF`, `TXT`, `XLS`, `XLSX`, `DOC`, `DOCX`, `PPT`, `PPTX`. Maximum document size is 100MB.",
"maxLength":2048,
"minLength":1
},
"filename":{
"type":"string",
"description":"Filename of the document.",
"maxLength":240,
"minLength":0
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveButtonsDocumentHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent":{
"type":"object",
"description":"Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsTextHeaderContent",
"VIDEO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsVideoHeaderContent",
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsImageHeaderContent",
"DOCUMENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsDocumentHeaderContent"
}
},
"properties":{
"type":{
"type":"string",
"description":"Type of the header content. Select the type from the dropdown to view its parameters."
}
},
"required":[
"type"
],
"title":"InteractiveButtonsHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsImageHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of an image sent in the header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats). Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveButtonsImageHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveButtonsMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsTextHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text sent in the header of message containing one or more [interactive buttons](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#interactive-buttons-interactive-messages).",
"maxLength":60,
"minLength":1
}
}
}
],
"required":[
"text"
],
"title":"InteractiveButtonsTextHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsVideoHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a video sent in the header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats). Must be a valid URL starting with `https://` or `http://`. Supported video types are `MP4`, `3GPP`. Maximum video size is 16MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveButtonsVideoHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveCallPermissionRequestMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"from",
"to"
],
"title":"InteractiveCallPermissionRequestMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowAction":{
"type":"string",
"default":"NAVIGATE",
"description":"Action of the flow, can be either 'NAVIGATE' or 'DATA_EXCHANGE'.",
"enum":[
"NAVIGATE",
"DATA_EXCHANGE"
],
"title":"InteractiveFlowAction"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionContent":{
"type":"object",
"description":"Allows you to specify flow message details.",
"properties":{
"mode":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionMode"
},
"flowMessageVersion":{
"type":"integer",
"format":"int32",
"description":"Version of the flow message."
},
"flowToken":{
"type":"string",
"description":"Flow token that should serve as an identifier."
},
"flowId":{
"type":"string",
"description":"ID of the registered flow."
},
"callToActionButton":{
"type":"string",
"description":"Call to action button text.",
"maxLength":20,
"minLength":1
},
"flowAction":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowAction"
},
"flowActionPayload":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionPayload"
}
},
"required":[
"callToActionButton",
"flowId",
"flowToken"
],
"title":"InteractiveFlowActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionMode":{
"type":"string",
"default":"PUBLISHED",
"description":"Mode of the flow, can be either 'DRAFT' or 'PUBLISHED'. If mode is 'DRAFT' header, body, footer and callToActionButton data will be not shown for end user.",
"enum":[
"DRAFT",
"PUBLISHED"
],
"title":"InteractiveFlowActionMode"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionPayload":{
"type":"object",
"description":"Required when flowAction is set to 'NAVIGATE. Should be omitted otherwise.",
"properties":{
"screen":{
"type":"string",
"description":"ID of the first screen of the flow."
},
"data":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Input data for first screen of the flow. Must be a non-empty object."
}
},
"required":[
"screen"
],
"title":"InteractiveFlowActionPayload"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionContent"
},
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowHeaderContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action",
"body"
],
"title":"InteractiveFlowContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowHeaderContent":{
"type":"object",
"description":"Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowTextHeaderContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"InteractiveFlowHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveFlowMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowTextHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowHeaderContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Content of the header used when creating interactive flow.",
"maxLength":60,
"minLength":1
}
}
}
],
"required":[
"text"
],
"title":"InteractiveFlowTextHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent":{
"type":"object",
"description":"Footer of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"properties":{
"text":{
"type":"string",
"description":"Content of the message footer.",
"maxLength":60,
"minLength":1
}
},
"required":[
"text"
],
"title":"InteractiveFooterContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveInThreadAuthenticationRequestMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"from",
"to"
],
"title":"InteractiveInThreadAuthenticationRequestMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListActionContent":{
"type":"object",
"description":"Allows you to specify the title of the list and its sections. Each section can have a title and multiple rows to select.",
"properties":{
"title":{
"type":"string",
"description":"Title of the list. Does not allow emojis or markdown.",
"maxLength":20,
"minLength":1
},
"sections":{
"type":"array",
"description":"Array of sections in the list.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListSectionContent"
},
"maxItems":10,
"minItems":1
}
},
"required":[
"sections",
"title"
],
"title":"InteractiveListActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListActionContent"
},
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListHeaderContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action",
"body"
],
"title":"InteractiveListContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListHeaderContent":{
"type":"object",
"description":"Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListTextHeaderContent"
}
},
"properties":{
"type":{
"type":"string",
"description":"Type of the header content. Select the type from the dropdown to view its parameters."
}
},
"required":[
"type"
],
"title":"InteractiveListHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveListMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListSectionContent":{
"type":"object",
"description":"Array of sections in the list.",
"properties":{
"title":{
"type":"string",
"description":"Title of the section. Required, if the message has more than one section.",
"maxLength":24,
"minLength":0
},
"rows":{
"type":"array",
"description":"An array of rows sent within a section. Section must contain at least one row. Message can have up to ten rows.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRowContent"
}
}
},
"required":[
"rows"
],
"title":"InteractiveListSectionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListTextHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListHeaderContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Content of the header used when creating an [interactive list](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#interactive-lists-interactive-messages).",
"maxLength":60,
"minLength":1
}
}
}
],
"required":[
"text"
],
"title":"InteractiveListTextHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
}
},
"required":[
"body"
],
"title":"InteractiveLocationRequestContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveLocationRequestMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction":{
"type":"object",
"description":"Allows you to specify cards of the carousel.",
"discriminator":{
"propertyName":"type",
"mapping":{
"QUICK_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyMediaCarouselAction",
"URL":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlMediaCarouselAction"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselActionType"
}
},
"required":[
"type"
],
"title":"InteractiveMediaCarouselAction"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction"
}
},
"required":[
"action",
"body"
],
"title":"InteractiveMediaCarouselContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveMediaCarouselMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductActionContent":{
"type":"object",
"description":"Allows you to specify catalog and product details sent in the multi-product message.",
"properties":{
"catalogId":{
"type":"string",
"description":"The ID that uniquely identifies the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to."
},
"sections":{
"type":"array",
"description":"An array of multi product sections.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductSectionContent"
},
"maxItems":10,
"minItems":1
}
},
"required":[
"catalogId",
"sections"
],
"title":"InteractiveMultiProductActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductHeaderContent"
},
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductActionContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action",
"body",
"header"
],
"title":"InteractiveMultiProductContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductHeaderContent":{
"type":"object",
"description":"Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductTextHeaderContent"
}
},
"properties":{
"type":{
"type":"string",
"description":"Type of the header content. Select the type from the dropdown to view its parameters."
}
},
"required":[
"type"
],
"title":"InteractiveMultiProductHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveMultiProductMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductSectionContent":{
"type":"object",
"description":"An array of multi product sections.",
"properties":{
"title":{
"type":"string",
"description":"Title of the section. Required, if the message has more than one section.",
"maxLength":24,
"minLength":0
},
"productRetailerIds":{
"type":"array",
"description":"An array of product-unique identifiers as defined in the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging). If product retailer ID doesn't exist in your catalog, the product won't be displayed.",
"items":{
"type":"string",
"description":"An array of product-unique identifiers as defined in the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging). If product retailer ID doesn't exist in your catalog, the product won't be displayed."
}
}
},
"required":[
"productRetailerIds"
],
"title":"InteractiveMultiProductSectionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductTextHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductHeaderContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Content of the multi-product message header.",
"maxLength":60,
"minLength":1
}
}
}
],
"required":[
"text"
],
"title":"InteractiveMultiProductTextHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"code":{
"type":"string",
"description":"Boleto code."
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderBrazilPaymentsDetails"
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"code",
"id"
],
"title":"InteractiveOrderBrazilBoletoPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderBrazilBoletoPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"paymentLink":{
"type":"string",
"description":"Payment link."
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderBrazilPaymentsDetails"
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"id",
"paymentLink"
],
"title":"InteractiveOrderBrazilLinkPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderBrazilLinkPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderBrazilPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderBrazilPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentsDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"payments":{
"type":"array",
"description":"List of payments. Each payment must have same ID. Maximum 2 payments allowed.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderBrazilPaymentsDetails"
},
"maxItems":2,
"minItems":1
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"payments"
],
"title":"InteractiveOrderBrazilPaymentsDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderBrazilPaymentsDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"code":{
"type":"string",
"description":"Dynamic Pix code which will be copied by the buyer."
},
"merchantName":{
"type":"string",
"description":"Pix account holder name."
},
"keyType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PixKeyType"
},
"key":{
"type":"string",
"description":"Key to identify the pix user’s account."
},
"flowType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PixFlowType"
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"code",
"id",
"key",
"keyType",
"merchantName"
],
"title":"InteractiveOrderBrazilPixDcPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderBrazilPixDcPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsActionContent":{
"type":"object",
"description":"Allows you to specify order details.",
"properties":{
"payment":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
},
"paymentConfiguration":{
"type":"string",
"description":"Name of the WhatsApp payment configuration to be used for this order. Can be omitted for Brazil PIX, UPI Link and must be omitted for Brazil link, Brazil Boleto, Brazil Payments and UPI Intent payment.",
"maxLength":60,
"minLength":1
},
"orderCurrency":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderCurrency"
},
"orderType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderType"
},
"totalAmount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount"
},
"order":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrder"
}
},
"required":[
"order",
"orderCurrency",
"orderType",
"payment",
"totalAmount"
],
"title":"InteractiveOrderDetailsActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount":{
"type":"object",
"properties":{
"value":{
"type":"integer",
"format":"int32",
"description":"Value multiplied by the offset (100 for INR and BRL)."
}
},
"required":[
"value"
],
"title":"InteractiveOrderDetailsAmount"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsActionContent"
},
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsHeaderContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action",
"body"
],
"title":"InteractiveOrderDetailsContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount":{
"type":"object",
"properties":{
"value":{
"type":"integer",
"format":"int32",
"description":"Value multiplied by the offset (100 for INR and BRL)."
},
"description":{
"type":"string",
"description":"Description of the value.",
"maxLength":60,
"minLength":0
}
},
"required":[
"value"
],
"title":"InteractiveOrderDetailsDescriptiveAmount"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDiscount":{
"type":"object",
"description":"Discount of the order.",
"properties":{
"amount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount"
},
"programName":{
"type":"string",
"description":"Discount program name.",
"maxLength":60,
"minLength":0
}
},
"required":[
"amount"
],
"title":"InteractiveOrderDetailsDiscount"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsHeaderContent":{
"type":"object",
"description":"Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"discriminator":{
"propertyName":"type",
"mapping":{
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImageHeaderContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"InteractiveOrderDetailsHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImageHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of an image sent in the header of an Order Detail message. Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveOrderDetailsImageHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImporterAddress":{
"type":"object",
"description":"Importer address. Required when catalogId is not provided. It's supported only for UPI PayU payments.",
"properties":{
"firstAddressLine":{
"type":"string",
"description":"First line of the address."
},
"secondAddressLine":{
"type":"string",
"description":"Second line of the address."
},
"city":{
"type":"string",
"description":"City."
},
"zoneCode":{
"type":"string",
"description":"Zone code."
},
"postalCode":{
"type":"string",
"description":"Postal code."
},
"countryCode":{
"type":"string",
"description":"Country code."
}
},
"title":"InteractiveOrderDetailsImporterAddress"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveOrderDetailsMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrder":{
"type":"object",
"description":"The order details.",
"properties":{
"catalogId":{
"type":"string",
"description":"The ID that uniquely identifies the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to."
},
"items":{
"type":"array",
"description":"An array of items in the order.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderItem"
}
},
"subtotal":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount"
},
"tax":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount"
},
"shipping":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount"
},
"discount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDiscount"
},
"orderExpiration":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderExpiration"
},
"orderDetailsType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderDetailsType"
}
},
"required":[
"items",
"subtotal",
"tax"
],
"title":"InteractiveOrderDetailsOrder"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderExpiration":{
"type":"object",
"description":"Expiration of the order.",
"properties":{
"expirationSeconds":{
"type":"integer",
"format":"int64",
"description":"Order expiration time in seconds, at least 360.",
"minimum":360
},
"description":{
"type":"string",
"description":"Text explanation of expiration.",
"maxLength":120,
"minLength":0
}
},
"required":[
"description",
"expirationSeconds"
],
"title":"InteractiveOrderDetailsOrderExpiration"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderItem":{
"type":"object",
"description":"An array of items in the order.",
"properties":{
"retailerId":{
"type":"string",
"description":"Product-unique identifier, as defined in catalog."
},
"name":{
"type":"string",
"description":"Name of the item.",
"maxLength":60,
"minLength":1
},
"amount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount"
},
"saleAmount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount"
},
"quantity":{
"type":"integer",
"format":"int32",
"description":"The number of items."
},
"originCountry":{
"type":"string",
"description":"Country of origin. Required when catalogId is not provided. It's supported only for UPI PayU payments."
},
"importerName":{
"type":"string",
"description":"Importer name. Required when catalogId is not provided. It's supported only for UPI PayU payments."
},
"importerAddress":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImporterAddress"
}
},
"required":[
"amount",
"name",
"quantity",
"retailerId"
],
"title":"InteractiveOrderDetailsOrderItem"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus":{
"type":"object",
"description":"Payment of the order.",
"discriminator":{
"propertyName":"type",
"mapping":{
"UPI_PAYU":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPayUPaymentStatus",
"BRAZIL":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentStatus",
"BRAZIL_PIX_DC":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentStatus",
"PG_PAYU":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentStatus",
"PG_RAZORPAY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentStatus",
"BRAZIL_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentStatus",
"BRAZIL_BOLETO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentStatus",
"UPI_INTENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentStatus",
"UPI_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentStatus"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"InteractiveOrderPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusActionContent":{
"type":"object",
"description":"Allows you to specify order status.",
"properties":{
"payment":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
"status":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatus"
},
"description":{
"type":"string",
"description":"Description of the order status.",
"maxLength":120,
"minLength":0
}
},
"required":[
"payment",
"status"
],
"title":"InteractiveOrderStatusActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusActionContent"
},
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action"
],
"title":"InteractiveOrderStatusContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveOrderStatusMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"beneficiary":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Beneficiary"
},
"format":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentFormat"
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"format",
"id"
],
"title":"InteractiveOrderUPIIntentPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPIIntentPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"beneficiary":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Beneficiary"
},
"paymentLink":{
"type":"string",
"description":"Payment link."
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"id",
"paymentLink"
],
"title":"InteractiveOrderUPILinkPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPILinkPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"beneficiary":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Beneficiary"
},
"callbackData":{
"type":"array",
"description":"List of custom parameters corresponding to the transaction.",
"items":{
"type":"string",
"description":"List of custom parameters corresponding to the transaction.",
"maxLength":255,
"minLength":1
},
"maxItems":4,
"minItems":0
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPIPGPayUPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPIPGPayUPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
},
"beneficiary":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Beneficiary"
},
"callbackData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Object with key value pairs containing custom parameters corresponding to the transaction."
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPIPGRazorpayPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"pattern":"[A-Za-z0-9\\-_.]{1,35}"
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPIPGRazorpayPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPayUPaymentDetails":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"maxLength":25,
"minLength":1
},
"productDescription":{
"type":"string",
"description":"Brief description of products in this order.",
"maxLength":100,
"minLength":1
},
"customerFirstName":{
"type":"string",
"description":"Customer's first name.",
"maxLength":60,
"minLength":1
},
"customerLastName":{
"type":"string",
"description":"Customer's last name.",
"maxLength":20,
"minLength":0
},
"customerEmail":{
"type":"string",
"description":"Customer's email.",
"maxLength":50,
"minLength":1
},
"callbackData":{
"type":"array",
"description":"List of custom parameters corresponding to the transaction.",
"items":{
"type":"string",
"description":"List of custom parameters corresponding to the transaction.",
"maxLength":255,
"minLength":0
},
"maxItems":5,
"minItems":0
}
}
}
],
"required":[
"customerEmail",
"customerFirstName",
"id",
"productDescription"
],
"title":"InteractiveOrderUPIPayUPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPayUPaymentStatus":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the payment.",
"maxLength":25,
"minLength":1
}
}
}
],
"required":[
"id"
],
"title":"InteractiveOrderUPIPayUPaymentStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductActionContent":{
"type":"object",
"description":"Allows you to specify catalog and product details sent in the product message.",
"properties":{
"catalogId":{
"type":"string",
"description":"The ID that uniquely identifies the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to."
},
"productRetailerId":{
"type":"string",
"description":"Product-unique identifier, as defined in catalog."
}
},
"required":[
"catalogId",
"productRetailerId"
],
"title":"InteractiveProductActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductActionContent"
},
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action"
],
"title":"InteractiveProductContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveProductMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveReplyButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonContent"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of the button containing no leading nor trailing whitespaces.",
"maxLength":256,
"minLength":1
},
"title":{
"type":"string",
"description":"Unique title of the button. Doesn't allow emojis or markdown.",
"maxLength":20,
"minLength":1
}
}
}
],
"required":[
"id",
"title"
],
"title":"InteractiveReplyButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
}
},
"required":[
"body"
],
"title":"InteractiveRequestContactInfoContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveRequestContactInfoMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRowContent":{
"type":"object",
"description":"An array of rows sent within a section. Section must contain at least one row. Message can have up to ten rows.",
"properties":{
"id":{
"type":"string",
"description":"Identifier of the row. It must be unique across all sections.",
"maxLength":200,
"minLength":1
},
"title":{
"type":"string",
"description":"Title of the row.",
"maxLength":24,
"minLength":1
},
"description":{
"type":"string",
"description":"Description of the row.",
"maxLength":72,
"minLength":0
}
},
"required":[
"id",
"title"
],
"title":"InteractiveRowContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonActionContent":{
"type":"object",
"description":"Allows you to specify the content of the button and its URL.",
"properties":{
"displayText":{
"type":"string",
"description":"Content of the button.",
"maxLength":20,
"minLength":1
},
"url":{
"type":"string",
"description":"URL to load in the device's default web browser when tapped by the WhatsApp user.",
"maxLength":2048,
"minLength":1
}
},
"required":[
"displayText",
"url"
],
"title":"InteractiveUrlButtonActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonActionContent"
},
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent"
},
"footer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent"
}
},
"required":[
"action",
"body"
],
"title":"InteractiveUrlButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonDocumentHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a document sent in the header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats). Must be a valid URL starting with `https://` or `http://`. Supported document types are `PDF`, `TXT`, `XLS`, `XLSX`, `DOC`, `DOCX`, `PPT`, `PPTX`. Maximum document size is 100MB.",
"maxLength":2048,
"minLength":1
},
"filename":{
"type":"string",
"description":"Filename of the document.",
"maxLength":240,
"minLength":0
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveUrlButtonDocumentHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent":{
"type":"object",
"description":"Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonTextHeaderContent",
"VIDEO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonVideoHeaderContent",
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonImageHeaderContent",
"DOCUMENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonDocumentHeaderContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"InteractiveUrlButtonHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonImageHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of an image sent in the header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats). Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveUrlButtonImageHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveUrlButtonMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonTextHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text sent in the header of message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).",
"maxLength":60,
"minLength":1
}
}
}
],
"required":[
"text"
],
"title":"InteractiveUrlButtonTextHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonVideoHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a video sent in the header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats). Must be a valid URL starting with `https://` or `http://`. Supported video types are `MP4`, `3GPP`. Maximum video size is 16MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"InteractiveUrlButtonVideoHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent"
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessageActionWhatsAppContent"
}
},
"required":[
"body"
],
"title":"InteractiveVoiceButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
}
},
"required":[
"content",
"from",
"to"
],
"title":"InteractiveVoiceButtonMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessageActionWhatsAppContent":{
"type":"object",
"description":"Allows you to specify message details.",
"properties":{
"buttonDisplayText":{
"type":"string",
"description":"Text to be displayed on the button.",
"maxLength":20,
"minLength":0
},
"callValidityPeriod":{
"type":"integer",
"format":"int32",
"description":"Time to live for the voice call button in minutes. Must be between 1 and 43200 (30 days). Default value is 10080 (7 days).",
"maximum":43200,
"minimum":1
},
"callContextPayload":{
"type":"string",
"description":"Payload data sent with the button. Can be retrieved from the call webhook.",
"maxLength":512,
"minLength":1
}
},
"title":"InteractiveVoiceButtonMessageActionWhatsAppContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"latitude":{
"type":"number",
"format":"double",
"description":"Latitude of a location sent in the WhatsApp message.",
"maximum":90,
"minimum":-90
},
"longitude":{
"type":"number",
"format":"double",
"description":"Longitude of a location sent in the WhatsApp message.",
"maximum":180,
"minimum":-180
},
"name":{
"type":"string",
"description":"Location name.",
"maxLength":1000,
"minLength":0
},
"address":{
"type":"string",
"description":"Location address.",
"maxLength":1000,
"minLength":0
}
},
"required":[
"latitude",
"longitude"
],
"title":"LocationContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"LocationMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselActionType":{
"type":"string",
"enum":[
"QUICK_REPLY",
"URL"
],
"title":"MediaCarouselActionType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardBody":{
"type":"object",
"description":"Card body.",
"properties":{
"text":{
"type":"string",
"description":"Card body text.",
"maxLength":160,
"minLength":0
}
},
"required":[
"text"
],
"title":"MediaCarouselCardBody"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeader":{
"type":"object",
"description":"Card header. Should be IMAGE or VIDEO type.",
"discriminator":{
"propertyName":"type",
"mapping":{
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMediaCarouselCardHeader",
"VIDEO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMediaCarouselCardHeader"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeaderType"
}
},
"required":[
"type"
],
"title":"MediaCarouselCardHeader"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeaderType":{
"type":"string",
"enum":[
"IMAGE",
"VIDEO"
],
"title":"MediaCarouselCardHeaderType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext":{
"type":"object",
"description":"Context object to define WhatsApp-specific metadata about a message.",
"properties":{
"replyToMessageId":{
"type":"string",
"description":"Inbound message ID used for a reply. Contextual bubble will not appear for template messages."
}
},
"required":[
"replyToMessageId"
],
"title":"MessageContext"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageGeneralStatus":{
"type":"string",
"description":"Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).",
"enum":[
"ACCEPTED",
"PENDING",
"UNDELIVERABLE",
"DELIVERED",
"EXPIRED",
"REJECTED"
],
"title":"MessageGeneralStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessagePrice":{
"type":"object",
"description":"Sent message price.",
"properties":{
"pricePerMessage":{
"type":"number",
"description":"Price per one message."
},
"currency":{
"type":"string",
"description":"The currency in which the price is expressed."
}
},
"title":"MessagePrice"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseDetails":{
"type":"object",
"description":"Other details of the message.",
"title":"MessageResponseDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseMessageResponseDetails":{
"type":"object",
"description":"An array of message objects of a single message or multiple messages sent under one bulk ID.",
"properties":{
"messageId":{
"type":"string",
"description":"Unique message ID. If not provided, it will be auto-generated and returned in the API response."
},
"status":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageStatus"
},
"destination":{
"type":"string",
"description":"The destination address of the message, i.e., its recipient."
},
"details":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseDetails"
}
},
"title":"MessageResponseMessageResponseDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageStatus":{
"type":"object",
"description":"Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID."
},
"groupName":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageGeneralStatus"
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status code ID."
},
"name":{
"type":"string",
"description":"[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name."
},
"description":{
"type":"string",
"description":"Human-readable description of the status."
},
"action":{
"type":"string",
"description":"Action to take to recover from the error."
}
},
"title":"MessageStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MultiProductSectionContent":{
"type":"object",
"description":"An array of multi product sections.",
"properties":{
"title":{
"type":"string",
"description":"Title of the section.",
"maxLength":24,
"minLength":0
},
"productRetailerIds":{
"type":"array",
"description":"An array of product-unique identifiers as defined in the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging). If product retailer ID doesn't exist in your catalog, the product won't be displayed.",
"items":{
"type":"string",
"description":"An array of product-unique identifiers as defined in the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging). If product retailer ID doesn't exist in your catalog, the product won't be displayed.",
"maxLength":3000,
"minLength":0
}
}
},
"required":[
"productRetailerIds",
"title"
],
"title":"MultiProductSectionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.NameContent":{
"type":"object",
"description":"Contains information about contact's name.",
"properties":{
"firstName":{
"type":"string",
"description":"Contact's first name."
},
"lastName":{
"type":"string",
"description":"Contact's last name."
},
"middleName":{
"type":"string",
"description":"Contact's middle name."
},
"nameSuffix":{
"type":"string",
"description":"Contact's name suffix."
},
"namePrefix":{
"type":"string",
"description":"Contact's name prefix."
},
"formattedName":{
"type":"string",
"description":"Contact's full name as it normally appears."
}
},
"required":[
"firstName",
"formattedName"
],
"title":"NameContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderCurrency":{
"type":"string",
"description":"Order currency.",
"enum":[
"INR",
"BRL"
],
"title":"OrderCurrency"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderDetailsType":{
"type":"string",
"description":"A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.",
"enum":[
"QUICK_PAY"
],
"title":"OrderDetailsType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatus":{
"type":"string",
"description":"Status of the order.",
"enum":[
"PENDING",
"PROCESSING",
"PARTIALLY_SHIPPED",
"SHIPPED",
"COMPLETED",
"CANCELED"
],
"title":"OrderStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatusContent":{
"type":"object",
"description":"Array of order statuses information.",
"discriminator":{
"propertyName":"type",
"mapping":{
"ORDER_STATUS":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusActionContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"OrderStatusContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderType":{
"type":"string",
"description":"Type of the goods offered in the order.",
"enum":[
"PHYSICAL_GOODS",
"DIGITAL_GOODS"
],
"title":"OrderType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Organization":{
"type":"object",
"description":"Contains information about contact's company.",
"properties":{
"company":{
"type":"string",
"description":"Company name."
},
"department":{
"type":"string",
"description":"Department name."
},
"title":{
"type":"string",
"description":"Title value."
}
},
"title":"Organization"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrganizationContent":{
"type":"object",
"description":"Contains information about contact's company.",
"properties":{
"company":{
"type":"string",
"description":"Company name."
},
"department":{
"type":"string",
"description":"Department name."
},
"title":{
"type":"string",
"description":"Title value."
}
},
"title":"OrganizationContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentAmount":{
"type":"object",
"description":"Total amount of the payment.",
"properties":{
"value":{
"type":"integer",
"format":"int32",
"description":"Value of the payment amount multiplied by the offset."
},
"offset":{
"type":"integer",
"format":"int32",
"description":"Offset of the payment amount (100 for INR and BRL)."
}
},
"required":[
"offset",
"value"
],
"title":"PaymentAmount"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentCurrency":{
"type":"string",
"description":"Currency of the payment.",
"enum":[
"INR",
"BRL",
"UNKNOWN"
],
"title":"PaymentCurrency"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentTransactionStatus":{
"type":"string",
"description":"Status of the transaction.",
"enum":[
"PENDING",
"FAILED",
"SUCCESS",
"CANCELED",
"UNKNOWN"
],
"title":"PaymentTransactionStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentTransactionType":{
"type":"string",
"description":"Type of the transaction.",
"enum":[
"UPI",
"BR",
"UNKNOWN"
],
"title":"PaymentTransactionType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneContent":{
"type":"object",
"description":"Array of phones information.",
"properties":{
"phone":{
"type":"string",
"description":"Contact's phone number."
},
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneType"
},
"waId":{
"type":"string",
"description":"Contact's WhatsApp ID."
}
},
"title":"PhoneContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneType":{
"type":"string",
"description":"Type of the phone number. Can be `CELL`, `MAIN`, `IPHONE`, `HOME` or `WORK`.",
"enum":[
"CELL",
"MAIN",
"IPHONE",
"HOME",
"WORK"
],
"title":"PhoneType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PixFlowType":{
"type":"string",
"description":"Pix payment flow type.",
"enum":[
"REDIRECT",
"COPYPASTE",
"APPSWITCH"
],
"title":"PixFlowType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PixKeyType":{
"type":"string",
"description":"Key type to identify the pix user’s account.",
"enum":[
"CPF",
"CNPJ",
"EMAIL",
"PHONE",
"EVP"
],
"title":"PixKeyType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Platform":{
"type":"object",
"description":"Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
}
},
"title":"Platform"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ProductItem":{
"type":"object",
"description":"An array of selected products.",
"properties":{
"currency":{
"type":"string",
"description":"Currency of the product."
},
"itemPrice":{
"type":"number",
"description":"Price of the product."
},
"productRetailerId":{
"type":"string",
"description":"Product's unique identifier as defined in the catalog."
},
"quantity":{
"type":"integer",
"format":"int32",
"description":"Quantity of the ordered product.",
"minimum":1
}
},
"required":[
"currency",
"itemPrice",
"productRetailerId",
"quantity"
],
"title":"ProductItem"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyCardActionButton":{
"type":"object",
"description":"Array of card action buttons.",
"properties":{
"id":{
"type":"string",
"description":"Id of the quick reply button.",
"maxLength":20,
"minLength":0
},
"title":{
"type":"string",
"description":"Display text of the quick reply button.",
"maxLength":20,
"minLength":0
}
},
"required":[
"id",
"title"
],
"title":"QuickReplyCardActionButton"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyMediaCarouselAction":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction"
},
{
"type":"object",
"properties":{
"cards":{
"type":"array",
"description":"Carousel cards. Should be defined in the correct order.It can have between two and ten cards.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyMediaCarouselCard"
},
"maxItems":10,
"minItems":2
}
}
}
],
"required":[
"cards",
"type"
],
"title":"QuickReplyMediaCarouselAction"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyMediaCarouselCard":{
"type":"object",
"description":"Carousel cards. Should be defined in the correct order.It can have between two and ten cards.",
"properties":{
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeader"
},
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardBody"
},
"buttons":{
"type":"array",
"description":"Array of card action buttons.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyCardActionButton"
}
}
},
"required":[
"body",
"buttons",
"header"
],
"title":"QuickReplyMediaCarouselCard"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReactionAction":{
"type":"string",
"description":"Action.",
"enum":[
"ADDED",
"REMOVED"
],
"title":"ReactionAction"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral":{
"type":"object",
"description":"Information about the referral which is either a Facebook ad or a post that triggered the message.",
"properties":{
"sourceType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralSourceType"
},
"sourceId":{
"type":"string",
"description":"Facebook ID of an ad or a post."
},
"sourceUrl":{
"type":"string",
"description":"The URL that leads to a Facebook ad or a post."
},
"headline":{
"type":"string",
"description":"Headline used in the ad that generated the message."
},
"body":{
"type":"string",
"description":"Body from the ad that generated the message."
},
"referralMedia":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMedia"
},
"ctwaClickId":{
"type":"string",
"description":"Unique per click identifier exposed when the end user entering the conversation originated from a Click to WhatsApp (CTWA) ad."
}
},
"required":[
"sourceType",
"sourceUrl"
],
"title":"Referral"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMedia":{
"type":"object",
"description":"Media information of included referral.",
"discriminator":{
"propertyName":"type",
"mapping":{
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMediaImage",
"VIDEO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMediaVideo"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMediaType"
}
},
"required":[
"type"
],
"title":"ReferralMedia"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMediaImage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMedia"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL that leads to the image that end user saw and clicked."
}
}
}
],
"required":[
"type",
"url"
],
"title":"ReferralMediaImage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMediaType":{
"type":"string",
"enum":[
"IMAGE",
"VIDEO"
],
"title":"ReferralMediaType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMediaVideo":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralMedia"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL that leads to the video that end user saw and clicked."
}
}
}
],
"required":[
"type",
"url"
],
"title":"ReferralMediaVideo"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReferralSourceType":{
"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"
],
"title":"ReferralSourceType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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."
},
"productRetailerId":{
"type":"string",
"description":"Product unique identifier, as defined in catalog."
}
},
"required":[
"catalogId",
"productRetailerId"
],
"title":"ReferredProduct"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.RequestSchedulingSettings":{
"type":"object",
"description":"Options for scheduling a message.",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.",
"maxLength":100,
"minLength":0
},
"sendAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance."
},
"sendingSpeedLimit":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SendingSpeedLimit"
}
},
"title":"RequestSchedulingSettings"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Response":{
"type":"string",
"description":"Indicates if the end user accepted or declined the call.",
"enum":[
"ACCEPT",
"REJECT"
],
"title":"Response"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ResponseEnvelopeMessageResponseMessageResponseDetails":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs."
},
"messages":{
"type":"array",
"description":"An array of message objects of a single message or multiple messages sent under one bulk ID.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseMessageResponseDetails"
}
}
},
"required":[
"messages"
],
"title":"ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SendingSpeedLimit":{
"type":"object",
"description":"Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.",
"properties":{
"amount":{
"type":"integer",
"format":"int32",
"description":"The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches."
},
"timeUnit":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SpeedLimitTimeUnit"
}
},
"required":[
"amount"
],
"title":"SendingSpeedLimit"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo":{
"type":"object",
"properties":{
"to":{
"type":"string",
"description":"The destination address of the message.",
"example":"385977666618"
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"Number of messages required to deliver.",
"example":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.",
"example":"06df139a-7eb5-4a6e-902e-40e892210455"
},
"status":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageStatus"
}
},
"title":"SingleMessageInfo"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageStatus":{
"type":"object",
"description":"Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID.",
"example":1
},
"groupName":{
"type":"string",
"description":"Status group name.",
"example":"PENDING"
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status ID.",
"example":7
},
"name":{
"type":"string",
"description":"Status name.",
"example":"PENDING_ENROUTE"
},
"description":{
"type":"string",
"description":"Human-readable description of the status.",
"example":"Message sent to next instance"
},
"action":{
"type":"string",
"description":"Action that should be taken to eliminate the error."
}
},
"title":"SingleMessageStatus"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SpeedLimitTimeUnit":{
"type":"string",
"default":"MINUTE",
"description":"The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.",
"enum":[
"MINUTE",
"HOUR",
"DAY"
],
"title":"SpeedLimitTimeUnit"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a sticker sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported sticker type is `WebP`. Sticker file should be 512x512 pixels. Maximum size is 100KB for static sticker and 500KB for animated sticker.",
"maxLength":2048,
"minLength":1
}
},
"required":[
"mediaUrl"
],
"title":"StickerContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"StickerMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails":{
"type":"object",
"description":"Payment of the order.",
"discriminator":{
"propertyName":"type",
"mapping":{
"BRAZIL_PIX_DC":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentDetails",
"BRAZIL_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentDetails",
"BRAZIL_BOLETO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentDetails",
"BRAZIL_PAYMENTS":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentsDetails",
"PG_PAYU":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentDetails",
"PG_RAZORPAY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentDetails",
"UPI_INTENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentDetails",
"UPI_LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentDetails"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"TemplateAllowedOrderPaymentDetails"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent":{
"type":"object",
"description":"Template body.",
"properties":{
"placeholders":{
"type":"array",
"description":"Template's parameter values submitted in the same order as in the registered template. The value must not be null, but it can be an empty array, if the template was registered without placeholders. Values within the array must not be null or empty.",
"items":{
"type":"string",
"description":"Template's parameter values submitted in the same order as in the registered template. The value must not be null, but it can be an empty array, if the template was registered without placeholders. Values within the array must not be null or empty."
}
}
},
"required":[
"placeholders"
],
"title":"TemplateBodyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent":{
"type":"object",
"description":"Template buttons. Should be defined in the correct order, only if `quick reply` or `dynamic URL` buttons have been registered. It can have up to ten buttons including a maximum of two `dynamic URL` buttons.",
"discriminator":{
"propertyName":"type",
"mapping":{
"QUICK_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateQuickReplyButtonContent",
"URL":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateUrlButtonContent",
"COPY_CODE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCopyCodeButtonContent",
"FLOW":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateFlowButtonContent",
"CATALOG":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCatalogButtonContent",
"MULTI_PRODUCT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateMultiProductButtonContent",
"ORDER_DETAILS":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderDetailsButtonContent",
"VOICE_CALL":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateVoiceCallButtonContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"TemplateButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCardContent":{
"type":"object",
"description":"Carousel cards. Should be defined in the correct order. It can have between one and ten cards.",
"properties":{
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent"
},
"buttons":{
"type":"array",
"description":"Card buttons. Define buttons only for `quick reply` or `dynamic URL` buttons (in the required order). For static URL button, omit the buttons section.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent"
},
"maxItems":2,
"minItems":1
}
},
"required":[
"header"
],
"title":"TemplateCardContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCarouselContent":{
"type":"object",
"description":"Template carousel. Should be defined only when template contains carousel.",
"properties":{
"cards":{
"type":"array",
"description":"Carousel cards. Should be defined in the correct order. It can have between one and ten cards.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCardContent"
},
"maxItems":10,
"minItems":1
}
},
"required":[
"cards"
],
"title":"TemplateCarouselContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCatalogButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"thumbnailProductRetailerId":{
"type":"string",
"description":"Product-unique identifier, as defined in catalog. If omitted, the image of the first item in your catalog will be used.",
"maxLength":3000,
"minLength":0
}
}
}
],
"title":"TemplateCatalogButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"templateName":{
"type":"string",
"description":"Template name. Should only contain lowercase alphanumeric characters and underscores.",
"maxLength":512,
"minLength":1
},
"templateData":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDataContent"
},
"language":{
"type":"string",
"description":"The code of language or locale to use. Must be the same code used when registering the template."
}
},
"required":[
"language",
"templateData",
"templateName"
],
"title":"TemplateContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCopyCodeButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"parameter":{
"type":"string",
"description":"Code.",
"maxLength":15,
"minLength":1
}
}
}
],
"required":[
"parameter"
],
"title":"TemplateCopyCodeButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDataContent":{
"type":"object",
"description":"Template data. Values have to be set as registered in the template.",
"properties":{
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent"
},
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
"buttons":{
"type":"array",
"description":"Template buttons. Should be defined in the correct order, only if `quick reply`, `dynamic URL`, `copy code` or `flow` buttons have been registered. It can have up to ten buttons including a maximum of two `dynamic URL` buttons, one `copy code` button and one `flow` button. When `catalog`, `multi product` or `order details` button is used it needs to be the only button.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
}
},
"carousel":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCarouselContent"
},
"limitedTimeOffer":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLimitedTimeOfferContent"
},
"orderStatus":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusContent"
}
},
"required":[
"body"
],
"title":"TemplateDataContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDocumentHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a document sent in the header. It is expected to be a valid URL starting with `https://` or `http://`. Supported document type is `PDF`. Maximum document size is 100MB.",
"maxLength":2048,
"minLength":1
},
"filename":{
"type":"string",
"description":"Filename of the document.",
"maxLength":240,
"minLength":1
}
}
}
],
"required":[
"filename",
"mediaUrl"
],
"title":"TemplateDocumentHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateFlowButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"flowToken":{
"type":"string",
"description":"Flow token.",
"maxLength":3000,
"minLength":0
},
"data":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Message action payload data. JSON object with the data payload for the first screen."
}
}
}
],
"title":"TemplateFlowButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateGifHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a GIF sent in the header. Must be an MP4 file. It is expected to be a valid URL starting with `https://` or `http://`. Maximum GIF size is 3.5MB. Files larger than 3.5MB are delivered as video messages. Only available for MM API (Marketing Messages).",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"TemplateGifHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent":{
"type":"object",
"description":"Template header. Should be defined, only if placeholders or media have been registered in the template's header.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateTextHeaderContent",
"DOCUMENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDocumentHeaderContent",
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateImageHeaderContent",
"VIDEO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateVideoHeaderContent",
"GIF":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateGifHeaderContent",
"LOCATION":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLocationHeaderContent"
}
},
"properties":{
"type":{
"type":"string"
}
},
"required":[
"type"
],
"title":"TemplateHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateImageHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of an image sent in the header. It is expected to be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"TemplateImageHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLimitedTimeOfferContent":{
"type":"object",
"description":"Template limited-time offer. Should be defined, only if template contains limited-time offer.",
"properties":{
"expirationTime":{
"type":"string",
"format":"date-time",
"description":"Offer code expiration time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"example":"2030-01-01T10:00:00Z"
}
},
"required":[
"expirationTime"
],
"title":"TemplateLimitedTimeOfferContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLocationHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
{
"type":"object",
"properties":{
"latitude":{
"type":"number",
"format":"double",
"description":"Latitude of a location sent in the header.",
"maximum":90,
"minimum":-90
},
"longitude":{
"type":"number",
"format":"double",
"description":"Longitude of a location sent in the header.",
"maximum":180,
"minimum":-180
}
}
}
],
"required":[
"latitude",
"longitude"
],
"title":"TemplateLocationHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateMultiProductButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"thumbnailProductRetailerId":{
"type":"string",
"description":"Product-unique identifier, as defined in catalog. If omitted, the image of the first item in your catalog will be used.",
"maxLength":3000,
"minLength":0
},
"sections":{
"type":"array",
"description":"An array of multi product sections.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MultiProductSectionContent"
},
"maxItems":10,
"minItems":1
}
}
}
],
"required":[
"sections"
],
"title":"TemplateMultiProductButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderDetailsActionContent":{
"type":"object",
"description":"Allows you to specify order details.",
"properties":{
"payment":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateAllowedOrderPaymentDetails"
},
"paymentConfiguration":{
"type":"string",
"description":"Name of the WhatsApp payment configuration to be used for this order. Can be omitted for Brazil PIX, UPI Link and must be omitted for Brazil link, Brazil Boleto, Brazil Payments and UPI Intent payment.",
"maxLength":60,
"minLength":1
},
"orderCurrency":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderCurrency"
},
"orderType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderType"
},
"totalAmount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount"
},
"order":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrder"
}
},
"required":[
"order",
"orderCurrency",
"orderType",
"payment",
"totalAmount"
],
"title":"TemplateOrderDetailsActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderDetailsButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderDetailsActionContent"
}
}
}
],
"required":[
"action"
],
"title":"TemplateOrderDetailsButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusActionContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatusContent"
},
{
"type":"object",
"properties":{
"payment":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus"
},
"status":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatus"
},
"description":{
"type":"string",
"description":"Description of the order status.",
"maxLength":120,
"minLength":0
}
}
}
],
"required":[
"payment",
"status"
],
"title":"TemplateOrderStatusActionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusContent":{
"type":"object",
"description":"Template order status. Should be defined, only if template contains order status.",
"properties":{
"orderStatuses":{
"type":"array",
"description":"Array of order statuses information.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatusContent"
}
}
},
"required":[
"orderStatuses"
],
"title":"TemplateOrderStatusContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateQuickReplyButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"parameter":{
"type":"string",
"description":"Payload of a `quick reply` button.",
"maxLength":128,
"minLength":1
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent"
}
],
"required":[
"parameter"
],
"title":"TemplateQuickReplyButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateTextHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
{
"type":"object",
"properties":{
"placeholder":{
"type":"string",
"description":"Value of a placeholder in the text header."
}
}
}
],
"required":[
"placeholder"
],
"title":"TemplateTextHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateUrlButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"parameter":{
"type":"string",
"description":"URL extension of a `dynamic URL` defined in the registered template. Learn more about [URL buttons](https://www.infobip.com/docs/whatsapp/whatsapp-over-api#dynamic-template-button-urls-with-shortening-and-tracking)."
}
}
},
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent"
}
],
"required":[
"parameter"
],
"title":"TemplateUrlButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateVideoHeaderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent"
},
{
"type":"object",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a video sent in the header. It is expected to be a valid URL starting with `https://` or `http://`. Supported video types are `MP4`, `3GPP`. Maximum video size is 16MB.",
"maxLength":2048,
"minLength":1
}
}
}
],
"required":[
"mediaUrl"
],
"title":"TemplateVideoHeaderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateVoiceCallButtonContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent"
},
{
"type":"object",
"properties":{
"callValidityPeriod":{
"type":"integer",
"format":"int32",
"description":"Time to live for the voice call button in minutes. Must be between 1 and 43200 (30 days). Default value is 10080 (7 days).",
"maximum":43200,
"minimum":1
},
"callContextPayload":{
"type":"string",
"description":"Payload data sent with the button. Can be retrieved from the call webhook.",
"maxLength":512,
"minLength":1
}
}
}
],
"title":"TemplateVoiceCallButtonContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"text":{
"type":"string",
"description":"Content of the message being sent.",
"maxLength":4096,
"minLength":1
},
"previewUrl":{
"type":"boolean",
"default":false,
"description":"Allows for URL preview from within the message. If set to `true`, the message content must contain a URL starting with `https://` or `http://` and the flag removeProtocol must be set to `false`."
}
},
"required":[
"text"
],
"title":"TextContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"TextMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ToDestination":{
"type":"object",
"description":"An array of destination objects for where messages are being sent. A valid destination is required.",
"properties":{
"to":{
"type":"string",
"description":"The destination address of the message."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
}
},
"required":[
"to"
],
"title":"Destination"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentFormat":{
"type":"object",
"description":"Format of the payment.",
"discriminator":{
"propertyName":"type",
"mapping":{
"LINK":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentLinkFormat"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentFormatType"
}
},
"title":"UPIIntentPaymentFormat"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentFormatType":{
"type":"string",
"enum":[
"LINK"
],
"title":"UPIIntentPaymentFormatType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentLinkFormat":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UPIIntentPaymentFormat"
},
{
"type":"object",
"properties":{
"paymentLink":{
"type":"string",
"description":"Payment link."
}
}
}
],
"required":[
"paymentLink"
],
"title":"UPIIntentPaymentLinkFormat"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Url":{
"type":"object",
"description":"Array of urls information.",
"properties":{
"url":{
"type":"string",
"description":"Contact's url."
},
"type":{
"type":"string",
"description":"Type of the url. Can be `HOME` or `WORK`."
}
},
"title":"Url"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlCardActionButton":{
"type":"object",
"description":"Url button.",
"properties":{
"displayText":{
"type":"string",
"description":"Display text of the URL button.",
"maxLength":20,
"minLength":0
},
"url":{
"type":"string",
"description":"URL text of the URL button.",
"maxLength":2048,
"minLength":0
}
},
"required":[
"displayText",
"url"
],
"title":"UrlCardActionButton"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlContent":{
"type":"object",
"description":"Array of urls information.",
"properties":{
"url":{
"type":"string",
"description":"Contact's url."
},
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlType"
}
},
"title":"UrlContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlMediaCarouselAction":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction"
},
{
"type":"object",
"properties":{
"cards":{
"type":"array",
"description":"Carousel cards. Should be defined in the correct order.It can have between two and ten cards.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlMediaCarouselCard"
},
"maxItems":10,
"minItems":2
}
}
}
],
"required":[
"cards",
"type"
],
"title":"UrlMediaCarouselAction"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlMediaCarouselCard":{
"type":"object",
"description":"Carousel cards. Should be defined in the correct order.It can have between two and ten cards.",
"properties":{
"header":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeader"
},
"body":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardBody"
},
"button":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlCardActionButton"
}
},
"required":[
"body",
"button",
"header"
],
"title":"UrlMediaCarouselCard"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions":{
"type":"object",
"description":"Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.",
"properties":{
"shortenUrl":{
"type":"boolean",
"default":true,
"description":"Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options."
},
"trackClicks":{
"type":"boolean",
"default":true,
"description":"Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom."
},
"trackingUrl":{
"type":"string",
"description":"The URL of your callback server on to which the Click report will be sent."
},
"removeProtocol":{
"type":"boolean",
"default":false,
"description":"Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL."
},
"customDomain":{
"type":"string",
"description":"Select a predefined custom domain to use when generating a short URL."
}
},
"title":"UrlOptions"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlType":{
"type":"string",
"description":"Type of the url. Can be `HOME` or `WORK`.",
"enum":[
"HOME",
"WORK"
],
"title":"UrlType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriod":{
"type":"object",
"description":"Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.",
"properties":{
"amount":{
"type":"integer",
"format":"int32",
"description":"Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`."
},
"timeUnit":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriodTimeUnit"
}
},
"required":[
"amount"
],
"title":"ValidityPeriod"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriodTimeUnit":{
"type":"string",
"default":"MINUTES",
"description":"Message validity period time unit.",
"enum":[
"SECONDS",
"MINUTES",
"HOURS"
],
"title":"ValidityPeriodTimeUnit"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"mediaUrl":{
"type":"string",
"description":"URL of a video sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported video types are `MP4`, `3GPP`. Maximum video size is 16MB.",
"maxLength":2048,
"minLength":1
},
"caption":{
"type":"string",
"description":"Caption of the video.",
"maxLength":3000,
"minLength":0
}
},
"required":[
"mediaUrl"
],
"title":"VideoContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMediaCarouselCardHeader":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselCardHeader"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of a video sent in the header. It is expected to be a valid URL starting with `https://` or `http://`. Supported video types are `MP4`, `3GPP`. Maximum video size is 16MB.",
"maxLength":2048,
"minLength":0
}
}
}
],
"required":[
"type",
"url"
],
"title":"VideoMediaCarouselCardHeader"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).",
"maxLength":24,
"minLength":1
},
"to":{
"type":"string",
"description":"Message recipient number in international format or WhatsApp business-scoped user ID.",
"maxLength":150,
"minLength":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoContent"
},
"callbackData":{
"type":"string",
"description":"Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).",
"maxLength":4000,
"minLength":0
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext"
}
},
"required":[
"content",
"from",
"to"
],
"title":"VideoMessage"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEvent":{
"type":"object",
"description":"An array of event objects of the events to be sent.",
"properties":{
"sender":{
"type":"string",
"description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)."
},
"destinations":{
"type":"array",
"description":"An array of destination objects for where the event is being sent. A valid destination is required.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ToDestination"
},
"maxItems":1,
"minItems":1
},
"content":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContent"
},
"options":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventOptions"
}
},
"required":[
"content",
"destinations",
"sender"
],
"title":"WhatsAppEvent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventOptions":{
"type":"object",
"description":"Event options.",
"properties":{
"platform":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Platform"
},
"validityPeriod":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriod"
}
},
"title":"WhatsAppEventOptions"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventRequest":{
"type":"object",
"properties":{
"events":{
"type":"array",
"description":"An array of event objects of the events to be sent.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEvent"
}
},
"options":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DefaultEventRequestOptions"
}
},
"required":[
"events"
],
"title":"WhatsAppEventRequest"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundAudioContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL for media download."
},
"caption":{
"type":"string",
"description":"Media Caption."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppInboundAudioContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundButtonReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"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
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"id",
"title",
"type"
],
"title":"WhatsAppInboundButtonReplyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundCallPermissionReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"callPermissionReply":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CallPermissionReply"
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"callPermissionReply",
"type"
],
"title":"WhatsAppInboundCallPermissionReplyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactProfile":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Display name of the end user."
},
"phoneNumber":{
"type":"string",
"description":"Sender's phone number. May be absent if the user has enabled the Meta username feature and you have not exchanged messages with them in the last 30 days."
},
"userId":{
"type":"string",
"description":"Business-scoped user ID (BSUID) assigned by Meta. Stable identifier for the end user, scoped to the receiving business."
},
"parentUserId":{
"type":"string",
"description":"Business-scoped user ID valid across all phone numbers in a linked business portfolio. Present only for managed businesses with portfolio linking enabled."
},
"username":{
"type":"string",
"description":"Meta username of the end user. Present only if the user has a Meta username."
}
},
"title":"WhatsAppInboundContactProfile"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactsContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"contacts":{
"type":"array",
"description":"An array of contacts sent in a WhatsApp message.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundContact"
}
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"contacts",
"type"
],
"title":"WhatsAppInboundContactsContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundTextContent",
"LOCATION":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundLocationContent",
"IMAGE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundImageContent",
"DOCUMENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundDocumentContent",
"AUDIO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundAudioContent",
"VIDEO":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundVideoContent",
"VOICE":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundVoiceContent",
"CONTACT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactsContent",
"INFECTED_CONTENT":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundInfectedContent",
"BUTTON":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundQuickReplyContent",
"STICKER":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundStickerContent",
"INTERACTIVE_BUTTON_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundButtonReplyContent",
"INTERACTIVE_LIST_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundListReplyContent",
"INTERACTIVE_FLOW_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundFlowReplyContent",
"INTERACTIVE_PAYMENT_CONFIRMATION":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundPaymentConfirmationContent",
"INTERACTIVE_CALL_PERMISSION_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundCallPermissionReplyContent",
"INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundInThreadAuthenticationReplyContent",
"ORDER":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundOrderContent",
"REACTION":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundReactionContent",
"UNSUPPORTED":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundUnsupportedContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContentType"
}
},
"required":[
"type"
],
"title":"WhatsAppInboundContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContentType":{
"type":"string",
"enum":[
"TEXT",
"LOCATION",
"IMAGE",
"DOCUMENT",
"AUDIO",
"VIDEO",
"VOICE",
"CONTACT",
"INFECTED_CONTENT",
"BUTTON",
"STICKER",
"INTERACTIVE_BUTTON_REPLY",
"INTERACTIVE_LIST_REPLY",
"INTERACTIVE_FLOW_REPLY",
"INTERACTIVE_PAYMENT_CONFIRMATION",
"INTERACTIVE_CALL_PERMISSION_REPLY",
"INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY",
"ORDER",
"REACTION",
"UNSUPPORTED"
],
"title":"WhatsAppInboundContentType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundDocumentContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL for media download."
},
"caption":{
"type":"string",
"description":"Media Caption."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppInboundDocumentContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundFlowReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text of the reply."
},
"response":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Response payload of the reply."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"text",
"type"
],
"title":"WhatsAppInboundFlowReplyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundImageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL for media download."
},
"caption":{
"type":"string",
"description":"Media Caption."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppInboundImageContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundInThreadAuthenticationReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"inThreadAuthenticationReply":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InThreadAuthenticationReply"
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"inThreadAuthenticationReply",
"type"
],
"title":"WhatsAppInboundInThreadAuthenticationReplyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundInfectedContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"malware":{
"type":"string",
"description":"Information about the malware."
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"type"
],
"title":"WhatsAppInboundInfectedContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundListReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Identifier 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
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"id",
"title",
"type"
],
"title":"WhatsAppInboundListReplyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundLocationContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"latitude":{
"type":"number",
"format":"double",
"description":"Latitude. The value must be between -180 and 180.",
"maximum":90,
"minimum":-90
},
"longitude":{
"type":"number",
"format":"double",
"description":"Longitude. The value must be between -90 and 90.",
"maximum":180,
"minimum":-180
},
"address":{
"type":"string",
"description":"Location address."
},
"name":{
"type":"string",
"description":"Location name."
},
"url":{
"type":"string",
"description":"Location URL."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"latitude",
"longitude",
"type"
],
"title":"WhatsAppInboundLocationContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundMessages":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of mobile originated messages.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundMessagePushko"
}
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"The number of messages returned in the results array."
},
"pendingMessageCount":{
"type":"integer",
"format":"int32",
"description":"The number of messages that have not been pulled in."
}
},
"title":"WhatsAppInboundMessages"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundOrderContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"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."
},
"productItems":{
"type":"array",
"description":"An array of selected products.",
"items":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ProductItem"
}
},
"text":{
"type":"string",
"description":"Text sent with order."
}
}
}
],
"required":[
"catalogId",
"productItems",
"type"
],
"title":"WhatsAppInboundOrderContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundPaymentConfirmationContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"referenceId":{
"type":"string",
"description":"Unique identifier generated by the payment service provider."
},
"paymentId":{
"type":"string",
"description":"Unique identifier of the payment."
},
"status":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentTransactionStatus"
},
"currency":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentCurrency"
},
"totalAmount":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentAmount"
},
"transactionId":{
"type":"string",
"description":"Unique identifier of the transaction."
},
"transactionType":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PaymentTransactionType"
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"currency",
"referenceId",
"status",
"totalAmount",
"transactionId",
"transactionType",
"type"
],
"title":"WhatsAppInboundPaymentConfirmationContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundQuickReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text of the selected button.",
"maxLength":128,
"minLength":0
},
"payload":{
"type":"string",
"description":"Payload of the selected button.",
"maxLength":128,
"minLength":0
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"payload",
"text",
"type"
],
"title":"WhatsAppInboundQuickReplyContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundReactionContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"emoji":{
"type":"string",
"description":"Emoji reaction."
},
"action":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ReactionAction"
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"type"
],
"title":"WhatsAppInboundReactionContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundStickerContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL for media download."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppInboundStickerContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundTextContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Content of the end user's message."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"text",
"type"
],
"title":"WhatsAppInboundTextContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundUnsupportedContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
}
}
}
],
"required":[
"type"
],
"title":"WhatsAppInboundUnsupportedContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundVideoContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL for media download."
},
"caption":{
"type":"string",
"description":"Media Caption."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppInboundVideoContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundVoiceContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL for media download."
},
"caption":{
"type":"string",
"description":"Media Caption."
},
"context":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Context"
},
"referral":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Referral"
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppInboundVoiceContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContent":{
"type":"object",
"description":"Event content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TYPING_INDICATOR":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventTypingIndicatorContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContentType"
}
},
"title":"WhatsAppOutboundEventContent"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContentType":{
"type":"string",
"enum":[
"TYPING_INDICATOR"
],
"title":"WhatsAppOutboundEventContentType"
},
"f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventTypingIndicatorContent":{
"type":"object",
"properties":{
"messageId":{
"type":"string",
"deprecated":true,
"description":"ID of the message to be marked as read. This field is deprecated and will be autofilled by the system. Any values supplied by the user will be ignored."
},
"type":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContentType"
}
},
"title":"WhatsAppOutboundEventTypingIndicatorContent"
},
"f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse":{
"type":"object",
"description":"The list of the results for this page.",
"discriminator":{
"propertyName":"category",
"mapping":{
"MARKETING":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultMarketingTemplateApiResponse",
"UTILITY":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateApiResponse",
"AUTHENTICATION":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplateApiResponse"
}
},
"properties":{
"id":{
"type":"string",
"description":"Template ID.",
"example":"111"
},
"businessAccountId":{
"type":"integer",
"format":"int64",
"description":"Business account ID to which template belongs.",
"example":222
},
"name":{
"type":"string",
"description":"Name of the template.",
"example":"template_name"
},
"language":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language"
},
"status":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status"
},
"category":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.WhatsAppCategory"
},
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData"
},
"quality":{
"type":"string",
"description":"Quality of the template.",
"enum":[
"HIGH",
"MEDIUM",
"LOW",
"UNKNOWN"
],
"example":"HIGH"
},
"platform":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform"
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Creation date of the template."
},
"lastUpdatedAt":{
"type":"string",
"format":"date-time",
"description":"Last update date of the template."
},
"libraryTemplateName":{
"type":"string",
"description":"Name of the library template from which this template was created. If not present, the template was not created using the template library."
}
},
"required":[
"structure"
],
"title":"TemplateResponse"
},
"f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateEditPublicApiRequest":{
"type":"object",
"properties":{
"category":{
"type":"string",
"description":"Category of the template. Approved template category cannot be edited.",
"enum":[
"MARKETING",
"AUTHENTICATION",
"UTILITY"
],
"example":"MARKETING"
},
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editStructure"
},
"validityPeriod":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editValidityPeriod"
},
"platform":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform"
},
"subCategory":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editSubCategory"
}
},
"title":"TemplateEditRequest"
},
"f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest":{
"type":"object",
"discriminator":{
"propertyName":"category",
"mapping":{
"MARKETING":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultMarketingTemplatePublicApiRequest",
"UTILITY":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplatePublicApiRequest",
"AUTHENTICATION":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplatePublicApiRequest"
}
},
"properties":{
"name":{
"type":"string",
"description":"Template name. Must only contain lowercase alphanumeric characters and underscores."
},
"language":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language"
},
"category":{
"type":"string",
"description":"Category of the template. Mind that each category has different fields available for the endpoint. If you're sending traffic in India, for `AUTHENTICATION`, use fields available for `UTILITY` with `AUTHENTICATION` as category. Note that category of the template can be automatically changed by Meta.",
"enum":[
"MARKETING",
"AUTHENTICATION",
"UTILITY"
],
"example":"MARKETING"
},
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStructureApiData"
},
"platform":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform"
}
},
"required":[
"category",
"language",
"name",
"structure"
],
"title":"TemplateRequest"
},
"f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatesApiResponse":{
"type":"object",
"properties":{
"templates":{
"type":"array",
"description":"List of all templates for given sender.",
"items":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
}
}
},
"title":"TemplatesResponse"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationBodyApiData":{
"type":"object",
"description":"Template body.",
"properties":{
"addSecurityRecommendation":{
"type":"boolean",
"description":"Set to true if you want the template to include the string, \"For your security, do not share this code.\" Set to false to exclude the string."
}
},
"title":"AuthenticationBodyApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationButtonApiData":{
"type":"object",
"description":"Authentication template buttons. Has to be either a 'copy code' button or 'one-tap' button.",
"discriminator":{
"propertyName":"otpType",
"mapping":{
"COPY_CODE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CopyCodeButtonApiData",
"ONE_TAP":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.OneTapButtonApiData"
}
},
"properties":{
"otpType":{
"type":"string",
"description":"Type of OTP button.",
"enum":[
"COPY_CODE",
"ONE_TAP"
]
}
},
"required":[
"otpType"
],
"title":"AuthenticationButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationFooterApiData":{
"type":"object",
"description":"Template footer.",
"properties":{
"codeExpirationMinutes":{
"type":"integer",
"format":"int32",
"description":"Indicates number of minutes the password or code is valid. If omitted, the code expiration warning will not be displayed in the delivered message.",
"maximum":90,
"minimum":1
}
},
"title":"AuthenticationFooterApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplateApiResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
},
{
"type":"object",
"properties":{
"validityPeriod":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodApiData"
}
}
}
],
"required":[
"structure"
],
"title":"AuthenticationTemplateApiResponse"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplatePublicApiRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest"
},
{
"type":"object",
"properties":{
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplateStructureApiData"
},
"validityPeriod":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodApiData"
}
}
}
],
"required":[
"category",
"language",
"name",
"structure"
],
"title":"AuthenticationTemplatePublicApiRequest"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplateStructureApiData":{
"type":"object",
"description":"Structure of the created authentication template. Must consist of body, footer and button.",
"properties":{
"body":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationBodyApiData"
},
"footer":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationFooterApiData"
},
"buttons":{
"type":"array",
"description":"Authentication template buttons. Has to be either a 'copy code' button or 'one-tap' button.",
"items":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationButtonApiData"
},
"maxItems":1,
"minItems":1
}
},
"required":[
"body",
"buttons",
"footer"
],
"title":"AuthenticationTemplateStructureApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData":{
"type":"object",
"description":"Template body.",
"properties":{
"text":{
"type":"string",
"description":"Plain text or text with placeholders. Placeholders have to be correctly formatted and in the correct order, regardless of other sections. Example: {{1}}, {{2}}, {{3}}..."
},
"examples":{
"type":"array",
"description":"Placeholders examples. The number of examples has to be the same as the number of placeholders. Examples cannot contain placeholders.",
"items":{
"type":"string",
"description":"Placeholders examples. The number of examples has to be the same as the number of placeholders. Examples cannot contain placeholders.",
"writeOnly":true
},
"writeOnly":true
}
},
"required":[
"text"
],
"title":"BodyApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData":{
"type":"object",
"description":"Template buttons. Can contain 1 to 10 buttons which include up to 2 URL buttons, one phone number button, one `copy code` button and one `flow` button. `quick reply` and non `quick reply` buttons have to be grouped together.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE_NUMBER":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PhoneNumberButtonApiData",
"URL":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.UrlButtonApiData",
"QUICK_REPLY":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.QuickReplyButtonApiData",
"COPY_CODE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CopyCodeDefaultButtonApiData",
"FLOW":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FlowButtonApiData",
"CATALOG":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CatalogButtonApiData",
"MULTI_PRODUCT":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.MultiProductButtonApiData",
"ORDER_DETAILS":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.OrderDetailsButtonApiData",
"VOICE_CALL":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.VoiceCallButtonApiData",
"REQUEST_CONTACT_INFO":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.RequestContactInfoButtonApiData"
}
},
"properties":{
"type":{
"type":"string",
"enum":[
"PHONE_NUMBER",
"URL",
"QUICK_REPLY",
"COPY_CODE",
"FLOW",
"CATALOG",
"MULTI_PRODUCT",
"ORDER_DETAILS",
"VOICE_CALL",
"REQUEST_CONTACT_INFO"
]
}
},
"title":"ButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CallPermissionRequestApiData":{
"type":"object",
"description":"Call permission request. Presence of this object enables a call permission request feature, no fields are required. When header is media type call permission request will not be displayed on end-user's device.",
"title":"CallPermissionRequestApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CardApiData":{
"type":"object",
"description":"List of cards.",
"properties":{
"header":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
"body":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData"
},
"buttons":{
"type":"array",
"description":"Card buttons. Can contain 1 to 2 buttons.",
"items":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
"maxItems":2,
"minItems":1
}
},
"required":[
"body",
"buttons",
"header"
],
"title":"CardApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CarouselApiData":{
"type":"object",
"description":"Template carousel. Applicable only for MARKETING category.",
"properties":{
"cards":{
"type":"array",
"description":"List of cards.",
"items":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CardApiData"
},
"maxItems":10,
"minItems":1
}
},
"required":[
"cards"
],
"title":"CarouselApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CatalogButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0,
"readOnly":true
}
}
}
],
"title":"CatalogButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CopyCodeButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text. WhatsApp will use default value if not provided.",
"maxLength":25,
"minLength":0
}
}
}
],
"required":[
"otpType"
],
"title":"CopyCodeButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CopyCodeDefaultButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0,
"readOnly":true
},
"example":{
"type":"string",
"description":"An example of a copy code.",
"maxLength":15,
"minLength":1,
"writeOnly":true
}
}
}
],
"title":"CopyCodeDefaultButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultMarketingTemplateApiResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
}
],
"required":[
"structure"
],
"title":"DefaultMarketingTemplateApiResponse"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultMarketingTemplatePublicApiRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest"
},
{
"type":"object",
"properties":{
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData"
}
}
}
],
"required":[
"category",
"language",
"name",
"structure"
],
"title":"DefaultMarketingTemplatePublicApiRequest"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateApiResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
},
{
"type":"object",
"properties":{
"subCategory":{
"type":"string",
"description":"Subcategory of the template. Subcategories are used to further classify templates. Currently used only to distinguish ORDER_STATUS template which can be used only with UTILITY category.",
"enum":[
"ORDER_STATUS"
]
}
}
}
],
"required":[
"structure"
],
"title":"DefaultTemplateApiResponse"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplatePublicApiRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest"
},
{
"type":"object",
"properties":{
"structure":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData"
},
"subCategory":{
"type":"string",
"description":"Subcategory of the template. Subcategories are used to further classify templates. Currently used only to distinguish ORDER_STATUS template which can be used only with UTILITY category.",
"enum":[
"ORDER_STATUS"
]
}
}
}
],
"required":[
"category",
"language",
"name",
"structure"
],
"title":"DefaultTemplatePublicApiRequest"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData":{
"type":"object",
"description":"Structure of the created template. Can consist of body (mandatory), header, footer, buttons, carousel, limited time offer, call permission request and shortening options.",
"properties":{
"header":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
"body":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData"
},
"footer":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FooterApiData"
},
"buttons":{
"type":"array",
"description":"Template buttons. Can contain 1 to 10 buttons which include up to 2 URL buttons, one phone number button, one `copy code` button and one `flow` button. `quick reply` and non `quick reply` buttons have to be grouped together.",
"items":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
}
},
"carousel":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CarouselApiData"
},
"limitedTimeOffer":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LimitedTimeOfferApiData"
},
"callPermissionRequest":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CallPermissionRequestApiData"
},
"shorteningOptions":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ShorteningOptionsApiData"
},
"type":{
"type":"string",
"description":"Template structure type.",
"enum":[
"TEXT",
"MEDIA",
"UNSUPPORTED"
],
"readOnly":true
}
},
"required":[
"body"
],
"title":"DefaultTemplateStructureApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DocumentHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
{
"type":"object",
"properties":{
"example":{
"type":"string",
"description":"An example of a template header document a user could create. Should be a valid URL that starts with `http` or `https`. Supported document type is `PDF`. Maximum document size is 16MB. Cannot contain placeholders.",
"writeOnly":true
}
}
}
],
"title":"DocumentHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FlowButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0
},
"flowId":{
"type":"integer",
"format":"int64",
"description":"Flow Id."
},
"flowAction":{
"type":"string",
"description":"Type of action after pressing the button.",
"enum":[
"NAVIGATE",
"DATA_EXCHANGE"
]
},
"navigateScreen":{
"type":"string",
"description":"Name of screen to navigate, required if flow action is 'navigate'."
}
}
}
],
"required":[
"flowAction",
"flowId",
"text"
],
"title":"FlowButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FooterApiData":{
"type":"object",
"description":"Template footer.",
"properties":{
"text":{
"type":"string",
"description":"Plain text, up to 60 characters.",
"maxLength":60,
"minLength":0
}
},
"required":[
"text"
],
"title":"FooterApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.GifHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
{
"type":"object",
"properties":{
"example":{
"type":"string",
"description":"An example of a template header GIF a user could use. Should be a valid URL that starts with `http` or `https`. Supported type is `MP4`. Maximum size is 3.5MB. Cannot contain placeholders. Only available for MM API (Marketing Messages).",
"writeOnly":true
}
}
}
],
"title":"GifHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData":{
"type":"object",
"description":"Template header. Can be `image`, `document`, `video`, `location` or `text`.",
"discriminator":{
"propertyName":"format",
"mapping":{
"TEXT":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TextHeaderApiData",
"IMAGE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ImageHeaderApiData",
"VIDEO":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.VideoHeaderApiData",
"GIF":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.GifHeaderApiData",
"DOCUMENT":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DocumentHeaderApiData",
"LOCATION":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LocationHeaderApiData"
}
},
"properties":{
"format":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"GIF",
"DOCUMENT",
"LOCATION"
]
}
},
"title":"HeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ImageHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
{
"type":"object",
"properties":{
"example":{
"type":"string",
"description":"An example of a template header image a user could create. Should be a valid URL that starts with `http` or `https`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 16MB. Cannot contain placeholders.",
"writeOnly":true
}
}
}
],
"title":"ImageHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language":{
"type":"string",
"description":"Template language, one template with same name can have multiple transliterations.",
"enum":[
"af",
"sq",
"ar",
"ar_EG",
"ar_AE",
"ar_LB",
"ar_MA",
"ar_QA",
"az",
"bn",
"bn_IN",
"bg",
"ca",
"zh_CN",
"zh_HK",
"zh_TW",
"hr",
"cs",
"da",
"nl",
"nl_BE",
"en",
"en_GB",
"en_US",
"en_AE",
"en_AU",
"en_CA",
"en_GH",
"en_IE",
"en_IN",
"en_JM",
"en_MY",
"en_NZ",
"en_QA",
"en_SG",
"en_UG",
"en_ZA",
"et",
"fil",
"fi",
"fr",
"fr_BE",
"fr_CA",
"fr_CH",
"fr_CI",
"fr_MA",
"ka",
"de",
"de_AT",
"de_CH",
"el",
"gu",
"ha",
"he",
"hi",
"hu",
"id",
"ga",
"it",
"ja",
"kn",
"kk",
"rw_RW",
"ko",
"ky_KG",
"lo",
"lv",
"lt",
"mk",
"ms",
"ml",
"mr",
"nb",
"fa",
"pl",
"pt_BR",
"pt_PT",
"pa",
"ro",
"ru",
"sr",
"si_LK",
"sk",
"sl",
"es",
"es_AR",
"es_CL",
"es_CO",
"es_CR",
"es_DO",
"es_EC",
"es_HN",
"es_MX",
"es_PA",
"es_PE",
"es_ES",
"es_UY",
"sw",
"sv",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"uz",
"vi",
"zu",
"unknown"
],
"example":"en",
"title":"Language"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LimitedTimeOfferApiData":{
"type":"object",
"description":"Limited time offer.",
"properties":{
"hasExpiration":{
"type":"boolean",
"default":false,
"description":"Indicates whether offer expiration details will appear in the delivered message. If set to true, copy code button must be included in the buttons array, and must appear first in the array."
},
"text":{
"type":"string",
"description":"Offer details text. Up to 16 characters.",
"maxLength":16,
"minLength":1
}
},
"required":[
"text"
],
"title":"LimitedTimeOfferApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LocationHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
}
],
"title":"LocationHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.MultiProductButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0,
"readOnly":true
}
}
}
],
"title":"MultiProductButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.NewTemplateCategory":{
"type":"string",
"description":"New category of the template.",
"enum":[
"AUTHENTICATION",
"MARKETING",
"UTILITY"
],
"example":"UTILITY",
"title":"NewTemplateCategory"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.NewTemplateQuality":{
"type":"string",
"description":"New quality of the template.",
"enum":[
"HIGH",
"MEDIUM",
"LOW",
"UNKNOWN"
],
"example":"HIGH",
"title":"NewTemplateQuality"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.OneTapButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"When unable to validate a handshake the authentication template message will display a copy code button with this text instead. WhatsApp will use default value if not provided.",
"maxLength":25,
"minLength":0
},
"autofillText":{
"type":"string",
"description":"One-tap button text. WhatsApp will use default value if not provided.",
"maxLength":25,
"minLength":0
},
"packageName":{
"type":"string",
"description":"Android app's package name."
},
"signatureHash":{
"type":"string",
"description":"App signing key hash.",
"maxLength":11,
"minLength":11
}
}
}
],
"required":[
"otpType",
"packageName",
"signatureHash"
],
"title":"OneTapButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.OrderDetailsButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"variant":{
"type":"string",
"description":"Order details variant.",
"enum":[
"BRAZIL",
"INDIA"
]
}
}
}
],
"required":[
"type",
"variant"
],
"title":"OrderDetailsButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PageInfo":{
"type":"object",
"description":"Contains information about the page.",
"properties":{
"page":{
"type":"integer",
"format":"int32",
"description":"Requested page number.",
"minimum":0
},
"size":{
"type":"integer",
"format":"int32",
"description":"Requested page size.",
"minimum":1
},
"totalPages":{
"type":"integer",
"format":"int32",
"description":"The total number of pages of the results matching the requested parameters.",
"minimum":0
},
"totalResults":{
"type":"integer",
"format":"int64",
"description":"The total number of the results matching the requested parameters.",
"minimum":0
}
},
"required":[
"page",
"size",
"totalPages",
"totalResults"
],
"title":"PageInfo"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PhoneNumberButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0
},
"phoneNumber":{
"type":"string",
"description":"Phone number to which a phone call would be placed by end-user when hitting the button."
}
}
}
],
"required":[
"phoneNumber",
"text"
],
"title":"PhoneNumberButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform":{
"type":"object",
"description":"Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
}
},
"title":"Platform"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PreviousTemplateCategory":{
"type":"string",
"description":"Previous category of the template.",
"enum":[
"AUTHENTICATION",
"MARKETING",
"UTILITY"
],
"example":"MARKETING",
"title":"PreviousTemplateCategory"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PreviousTemplateQuality":{
"type":"string",
"description":"Previous quality of the template.",
"enum":[
"HIGH",
"MEDIUM",
"LOW",
"UNKNOWN"
],
"example":"LOW",
"title":"PreviousTemplateQuality"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.QuickReplyButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0
}
}
}
],
"required":[
"text"
],
"title":"QuickReplyButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Reason":{
"type":"string",
"description":"Template rejection reason.",
"enum":[
"ABUSIVE_CONTENT",
"INCORRECT_CATEGORY",
"INVALID_FORMAT",
"NONE",
"SCAM",
"UNKNOWN"
],
"example":"ABUSIVE_CONTENT",
"title":"Reason"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.RequestContactInfoButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"readOnly":true
}
}
}
],
"title":"RequestContactInfoButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ShorteningOptionsApiData":{
"type":"object",
"description":"URL shortening options. Applicable only if at least one dynamic URL button is present. Modifying this provided URL outside of our company's services may lead to unexpected results.",
"properties":{
"customDomain":{
"type":"string",
"description":"Custom domain to be used for URL shortening."
}
},
"required":[
"customDomain"
],
"title":"ShorteningOptionsApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status":{
"type":"string",
"description":"Status of the template.",
"enum":[
"APPROVED",
"IN_APPEAL",
"PENDING",
"REJECTED",
"PENDING_DELETION",
"DELETED",
"REINSTATED",
"FLAGGED",
"FIRST_PAUSED",
"SECOND_PAUSED",
"DISABLED"
],
"example":"APPROVED",
"title":"Status"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateCategoryPushEventChange":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange"
},
{
"type":"object",
"properties":{
"previousCategory":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PreviousTemplateCategory"
},
"newCategory":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.NewTemplateCategory"
}
}
}
],
"required":[
"newCategory",
"previousCategory",
"type"
],
"title":"TemplateCategoryPushEventChange"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange":{
"type":"object",
"description":"Change that has been applied to template.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEMPLATE_STATUS_UPDATE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStatusPushEventChange",
"TEMPLATE_CATEGORY_UPDATE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateCategoryPushEventChange",
"TEMPLATE_QUALITY_UPDATE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateQualityPushEventChange"
}
},
"properties":{
"type":{
"type":"string",
"description":"Type of change that has been applied to template.",
"enum":[
"TEMPLATE_STATUS_UPDATE",
"TEMPLATE_CATEGORY_UPDATE",
"TEMPLATE_QUALITY_UPDATE"
]
}
},
"required":[
"type"
],
"title":"TemplatePushEventChange"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateQualityPushEventChange":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange"
},
{
"type":"object",
"properties":{
"previousQualityScore":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PreviousTemplateQuality"
},
"newQualityScore":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.NewTemplateQuality"
}
}
}
],
"required":[
"newQualityScore",
"previousQualityScore",
"type"
],
"title":"TemplateQualityPushEventChange"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStatusPushEventChange":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange"
},
{
"type":"object",
"properties":{
"newStatus":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status"
},
"reason":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Reason"
}
}
}
],
"required":[
"newStatus",
"type"
],
"title":"TemplateStatusPushEventChange"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStructureApiData":{
"type":"object",
"title":"TemplateStructureApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateUpdatePushEvent":{
"type":"object",
"properties":{
"messageTemplateId":{
"type":"string",
"description":"Template ID.",
"example":"111"
},
"messageTemplateName":{
"type":"string",
"description":"Name of the template.",
"example":"template_name"
},
"messageTemplateLanguage":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language"
},
"timestamp":{
"type":"string",
"format":"date-time",
"description":"Date and time when event occurred. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
},
"change":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange"
},
"entityId":{
"type":"integer",
"format":"int64",
"description":"Entity ID.",
"example":123456
},
"applicationId":{
"type":"integer",
"format":"int64",
"description":"Application ID.",
"example":1234567
}
},
"required":[
"change",
"messageTemplateId",
"messageTemplateLanguage",
"messageTemplateName",
"timestamp"
],
"title":"TemplateUpdatePushEvent"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatesApiResponsePaginated":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse"
}
},
"paging":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PageInfo"
}
},
"required":[
"paging",
"results"
],
"title":"TemplatesApiResponsePaginated"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TextHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Template header text. Can contain up to 60 characters, with one placeholder {{1}}."
},
"example":{
"type":"string",
"description":"An example of the content for the template header a user could use. Cannot contain placeholders.",
"writeOnly":true
}
}
}
],
"required":[
"text"
],
"title":"TextHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.UrlButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0
},
"url":{
"type":"string",
"description":"URL to which the end-user will be directed when hitting the button. URL is expected to start with `https://` or `http://`. Can be static or dynamic. For dynamic URL registration, add a placeholder {{1}} at the end of the link. Example: `https://www.infobip.com/{{1}}`."
},
"example":{
"type":"string",
"description":"An example of a URL a user could use. Should be a valid URL that starts with `https://` or `http://`. Cannot contain placeholders.",
"writeOnly":true
},
"destinationUrl":{
"type":"string",
"description":"Url of button's destination. Available only if custom domain is present.",
"readOnly":true
}
}
}
],
"required":[
"text",
"url"
],
"title":"UrlButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData":{
"type":"object",
"description":"Template buttons. Can be either up to 3 `quick reply` buttons or up to 2 `call to action` buttons. Call to action buttons must be unique in type.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE_NUMBER":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1PhoneNumberButtonApiData",
"URL":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1UrlButtonApiData",
"QUICK_REPLY":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1QuickReplyButtonApiData"
}
},
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0
},
"type":{
"type":"string",
"enum":[
"PHONE_NUMBER",
"URL",
"QUICK_REPLY"
]
}
},
"required":[
"text"
],
"title":"V1ButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1DocumentHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData"
}
],
"title":"V1DocumentHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData":{
"type":"object",
"description":"Template header. Can be `image`, `document`, `video`, `location` or `text`.",
"discriminator":{
"propertyName":"format",
"mapping":{
"TEXT":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TextHeaderApiData",
"IMAGE":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ImageHeaderApiData",
"VIDEO":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1VideoHeaderApiData",
"DOCUMENT":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1DocumentHeaderApiData",
"LOCATION":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1LocationHeaderApiData"
}
},
"properties":{
"format":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"DOCUMENT",
"LOCATION"
]
}
},
"title":"V1HeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ImageHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData"
}
],
"title":"V1ImageHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1LocationHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData"
}
],
"title":"V1LocationHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1PhoneNumberButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number to which a phone call would be placed by end-user when hitting the button."
}
}
}
],
"required":[
"phoneNumber",
"text"
],
"title":"V1PhoneNumberButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1QuickReplyButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData"
}
],
"required":[
"text"
],
"title":"V1QuickReplyButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData":{
"type":"object",
"description":"Template structure.",
"properties":{
"header":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData"
},
"body":{
"type":"string",
"description":"Template body. Can be registered as plain text or text with placeholders. Placeholders have to be correctly formatted and in the correct order, regardless of other sections. Example: {{1}}, {{2}}, {{3}}...",
"example":"body {{1}} content"
},
"footer":{
"type":"string",
"description":"Template footer. Plain text, up to 60 characters.",
"example":"footer",
"maxLength":60,
"minLength":0
},
"buttons":{
"type":"array",
"description":"Template buttons. Can be either up to 3 `quick reply` buttons or up to 2 `call to action` buttons. Call to action buttons must be unique in type.",
"items":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData"
},
"maxItems":3,
"minItems":1
},
"type":{
"type":"string",
"enum":[
"TEXT",
"MEDIA",
"UNSUPPORTED"
],
"readOnly":true
}
},
"required":[
"body"
],
"title":"V1TemplateStructureApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TextHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Template header text. Can contain up to 60 characters, with one placeholder {{1}}."
}
}
}
],
"required":[
"text"
],
"title":"V1TextHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1UrlButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL to which the end-user will be directed when hitting the button. URL is expected to start with `https://` or `http://`. Can be static or dynamic. For dynamic URL registration, add a placeholder {{1}} at the end of the link. Example: `https://www.infobip.com/{{1}}`"
}
}
}
],
"required":[
"text",
"url"
],
"title":"V1UrlButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1VideoHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData"
}
],
"title":"V1VideoHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodApiData":{
"type":"object",
"description":"Template validity period in which WhatsApp will try to deliver template message to end user. Validity period can be customized between 30 seconds and 15 minutes. -1 can be used to use Meta's default message validity period. This is 24 hours for the Cloud senders and 30 days for the On-Premises.",
"properties":{
"amount":{
"type":"integer",
"format":"int32",
"description":"Template validity period amount."
},
"timeUnit":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodTimeUnit"
}
},
"required":[
"amount"
],
"title":"ValidityPeriodApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodTimeUnit":{
"type":"string",
"default":"MINUTES",
"description":"Message template validity period time unit.",
"enum":[
"SECONDS",
"MINUTES"
],
"title":"ValidityPeriodTimeUnit"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.VideoHeaderApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData"
},
{
"type":"object",
"properties":{
"example":{
"type":"string",
"description":"An example of a template header video a user could use. Should be a valid URL that starts with `http` or `https`. Supported video type is `MP4`. Maximum video size is 16MB. Cannot contain placeholders.",
"writeOnly":true
}
}
}
],
"title":"VideoHeaderApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.VoiceCallButtonApiData":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Button text.",
"maxLength":25,
"minLength":0
},
"callValidityPeriod":{
"type":"integer",
"format":"int32",
"description":"Time to live for the call button in minutes. Must be between 1440 (1 day) and 43200 (30 days).",
"maximum":43200,
"minimum":1440
}
}
}
],
"required":[
"text"
],
"title":"VoiceCallButtonApiData"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.WhatsAppCategory":{
"type":"string",
"description":"Category of the template.",
"enum":[
"MARKETING",
"AUTHENTICATION",
"UTILITY"
],
"example":"MARKETING",
"title":"WhatsAppCategory"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editStructure":{
"type":"object",
"description":"Template structure. Format depends on the template category.",
"title":"editStructure"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editSubCategory":{
"type":"string",
"description":"Sub category of template. It is required only if edited template has already sub category.",
"enum":[
"ORDER_STATUS"
],
"title":"editSubCategory"
},
"f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editValidityPeriod":{
"type":"object",
"description":"Template validity period in which WhatsApp will try to deliver template message to end user. Validity period can be customized between 30 seconds and 15 minutes. -1 can be used to use Meta's default message validity period. This is 24 hours for the Cloud senders and 30 days for the On-Premises. Works only for templates with `AUTHENTICATION` category. It can be only edited alongside with category or structure in the request.",
"properties":{
"amount":{
"type":"integer",
"format":"int32",
"description":"Template validity period amount."
},
"timeUnit":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodTimeUnit"
}
},
"required":[
"amount"
],
"title":"editValidityPeriod"
}
},
"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"
}
}
},
"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"
}
}
},
"ApiException400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
},
"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"
}
}
},
"ApiException404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n NOT_FOUND\n Not found\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-inbound-whatsapp-messages":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-inbound-messages",
"whatsapp-receive-inbound-message"
],
"summary":"Receive WhatsApp inbound message",
"description":"Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number by specifying your endpoint and we will send inbound WhatsApp messages to you as soon as they are delivered to us.
Name of the default format or renderer for the inbound WhatsApp messages is `MO_OTT_CONTACT`, and is documented in this section.",
"externalDocs":{
"description":"Learn more about WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"receive-whatsapp-inbound-messages",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundMessages"
},
"examples":{
"Received WhatsApp TEXT message":{
"summary":"Received WhatsApp TEXT message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"text":"Hello, World!",
"type":"TEXT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"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":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"text":"Hello, World!",
"type":"TEXT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
},
"identity":{
"acknowledged":true,
"hash":"eU2Fdi4EMUw=",
"createdAt":"2025-01-01T00:00:00.000+0000"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp TEXT message with ad referral":{
"summary":"Received WhatsApp TEXT message with ad referral",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"text":"Hello, World!",
"referral":{
"sourceType":"AD",
"sourceId":"ad-source-id",
"sourceUrl":"https://www.example.com/ad",
"headline":"Ad headline",
"body":"Ad body",
"ctwaClickId":"ctwa-click-id"
},
"type":"TEXT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp LOCATION message":{
"summary":"Received WhatsApp LOCATION message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"latitude":40.748433333333,
"longitude":-73.985655555556,
"address":"350 5th Ave, New York, NY",
"name":"Empire State Building",
"url":"https://www.facebook.com/113272675352744",
"type":"LOCATION"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp IMAGE message":{
"summary":"Received WhatsApp IMAGE message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe",
"caption":"Image Caption",
"type":"IMAGE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp DOCUMENT message":{
"summary":"Received WhatsApp DOCUMENT message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe",
"caption":"Document Title",
"type":"DOCUMENT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp AUDIO message":{
"summary":"Received WhatsApp AUDIO message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe",
"type":"AUDIO"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp VIDEO message":{
"summary":"Received WhatsApp VIDEO message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe",
"caption":"Look at this!",
"type":"VIDEO"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp VOICE message":{
"summary":"Received WhatsApp VOICE message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe",
"caption":"Voice Note",
"type":"VOICE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp CONTACT message":{
"summary":"Received WhatsApp CONTACT message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"contacts":[
{
"addresses":[
{
"street":"Street",
"city":"New York",
"state":"NY",
"zip":"10001",
"country":"USA",
"countryCode":"US",
"type":"HOME"
}
],
"birthday":"1980-01-01",
"emails":[
{
"email":"frank@example.com",
"type":"HOME"
}
],
"name":{
"firstName":"Frank",
"lastName":"Bipper",
"middleName":"John",
"namePrefix":"Mr.",
"formattedName":"Frank Bipper"
},
"org":{
"company":"Infobip",
"department":"Support",
"title":"eng."
},
"phones":[
{
"phone":"385918889999",
"type":"CELL",
"waId":"385918889999"
}
],
"urls":[
{
"url":"https://www.infobip.com",
"type":"HOME"
}
]
}
],
"type":"CONTACT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INFECTED_CONTENT message":{
"summary":"Received WhatsApp INFECTED_CONTENT message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"malware":"Infected content detected",
"type":"INFECTED_CONTENT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp BUTTON message":{
"summary":"Received WhatsApp BUTTON message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"text":"Button text",
"payload":"Payload",
"type":"BUTTON"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp STICKER message":{
"summary":"Received WhatsApp STICKER message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"url":"https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe",
"type":"STICKER"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_BUTTON_REPLY message":{
"summary":"Received WhatsApp INTERACTIVE_BUTTON_REPLY message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"id":"button-reply-id",
"title":"Button reply title",
"type":"INTERACTIVE_BUTTON_REPLY"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_LIST_REPLY message":{
"summary":"Received WhatsApp INTERACTIVE_LIST_REPLY message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"id":"list-reply-id",
"title":"List reply title",
"description":"List reply description",
"type":"INTERACTIVE_LIST_REPLY"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_FLOW_REPLY message":{
"summary":"Received WhatsApp INTERACTIVE_FLOW_REPLY message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"text":"flow-reply-id",
"response":{
"flow-data":"flow-input-response"
},
"type":"INTERACTIVE_FLOW_REPLY"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_PAYMENT_CONFIRMATION message":{
"summary":"Received WhatsApp INTERACTIVE_PAYMENT_CONFIRMATION message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"referenceId":"payment-confirmation-id",
"paymentId":"payment-confirmation-id",
"status":"SUCCESS",
"currency":"INR",
"totalAmount":{
"value":299,
"offset":100
},
"transactionId":"transaction-id",
"transactionType":"UPI",
"type":"INTERACTIVE_PAYMENT_CONFIRMATION"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_PAYMENT_ACKNOWLEDGEMENT message":{
"summary":"Received WhatsApp INTERACTIVE_PAYMENT_ACKNOWLEDGEMENT message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"paymentAcknowledgementType":"PIX",
"timestamp":"2025-01-01T00:00:00.000+0000",
"paymentId":"payment-id",
"referenceId":"transaction-id",
"type":"INTERACTIVE_PAYMENT_ACKNOWLEDGEMENT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_CALL_PERMISSION_REPLY message":{
"summary":"Received WhatsApp INTERACTIVE_CALL_PERMISSION_REPLY message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"callPermissionReply":{
"response":"ACCEPT",
"expirationTimestamp":"2025-01-01T00:00:00.000+0000"
},
"type":"INTERACTIVE_CALL_PERMISSION_REPLY"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY message":{
"summary":"Received WhatsApp INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"inThreadAuthenticationReply":{
"status":"VERIFIED",
"businessScopedPasskeyHash":"d4KXmNqYpeR-rU62bHLA9sivkZWjtxgcf8P1nyDraolMV5C7uEs93kQwF24mGcTybnnJ6h1zzr-v7-QWupXJmdrA"
},
"type":"INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp ORDER message":{
"summary":"Received WhatsApp ORDER message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"catalogId":"order-id",
"productItems":[
{
"currency":"EUR",
"itemPrice":1.99,
"productRetailerId":"product-retailer-id",
"quantity":1
}
],
"text":"I like you store!",
"type":"ORDER"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Received WhatsApp REACTION message":{
"summary":"Received WhatsApp REACTION message",
"value":{
"results":[
{
"from":"385919998888",
"to":"41793026731",
"integrationType":"WHATSAPP",
"receivedAt":"2025-01-01T10:10:00.000+0000",
"messageId":"wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=",
"callbackData":"callbackData",
"message":{
"emoji":"🤓",
"action":"ADDED",
"context":{
"id":"abcdef_ghij124567890klmnopr"
},
"type":"REACTION"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
},
"contact":{
"name":"Frank",
"phoneNumber":"385919998888",
"userId":"HR.123123123",
"parentUserId":"HR.ENT.456456456",
"username":"Frank"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-whatsapp-delivery-reports":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-status-reports"
],
"summary":"Receive delivery reports",
"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 Customer Support 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.",
"externalDocs":{
"description":"Learn more about the WhatsApp channel and its use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"receive-whatsapp-delivery-reports",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryResult"
},
"examples":{
"Delivery reports":{
"summary":"Delivery reports",
"value":{
"results":[
{
"bulkId":"",
"price":{
"pricePerMessage":0.21,
"currency":"BRL"
},
"status":{
"id":5,
"groupId":3,
"groupName":"DELIVERED",
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"id":0,
"name":"NO_ERROR",
"description":"No Error",
"groupId":0,
"groupName":"OK",
"permanent":false
},
"messageId":"fb469d73-d362-463f-b30f-1e959b53badc",
"doneAt":"2019-04-09T16:01:56.494-0300",
"messageCount":1,
"sentAt":"2019-04-09T16:00:58.647-0300",
"to":"41793026731",
"contact":{
"name":"name",
"phoneNumber":"41793026731",
"userId":"US.1349120865530274191",
"parentUserId":"US.ENT.118157495734",
"username":"username"
}
}
]
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback"
}
}
}
},
"receive-whatsapp-seen-reports":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-status-reports"
],
"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 Customer Support 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.",
"externalDocs":{
"description":"Learn more about the WhatsApp channel and its use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"receive-whatsapp-seen-reports",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenResult"
},
"examples":{
"Seen reports":{
"summary":"Seen reports",
"value":{
"results":[
{
"messageId":"1215f543ab19-345f-adbd-12ad31451ed25f35",
"from":"385919998888",
"to":"41793026731",
"sentAt":"2018-12-12T11:21:57.793+0000",
"seenAt":"2018-12-12T11:21:58.251+0000",
"applicationId":"example-application-id",
"entityId":"example-entity-id",
"contact":{
"name":"name",
"phoneNumber":"41793026731",
"userId":"US.1349120865530274191",
"parentUserId":"US.ENT.118157495734",
"username":"username"
}
}
]
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback"
}
}
}
},
"receive-whatsapp-payment-notification":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-payments"
],
"summary":"Receive WhatsApp Payment Notification",
"description":"Receive notification about payment transaction updates.",
"externalDocs":{
"description":"Learn more about the WhatsApp channel and its use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"receive-whatsapp-payment-notification",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotificationResponse"
},
"examples":{
"Payment notification":{
"summary":"Payment notification",
"value":{
"from":"41793026731",
"content":{
"from":"447860064555",
"type":"payment",
"referenceId":"72123248136",
"paymentId":"fd3e847h2",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T01:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
]
},
"createdAt":"2023-01-01T01:00:00.000+0000"
}
},
"Payment PayU notification":{
"summary":"Payment PayU notification",
"value":{
"from":"41793026731",
"content":{
"from":"447860064555",
"type":"payment",
"referenceId":"72123248136",
"paymentId":"fd3e847h2",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"callbackData":[
"customData1"
],
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T01:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
]
},
"createdAt":"2023-01-01T01:00:00.000+0000"
}
},
"Payment Razorpay notification":{
"summary":"Payment Razorpay notification",
"value":{
"from":"41793026731",
"content":{
"from":"447860064555",
"type":"payment",
"referenceId":"72123248136",
"paymentId":"fd3e847h2",
"paymentStatus":"CAPTURED",
"currency":"INR",
"totalAmountValue":21000,
"totalAmountOffset":100,
"callbackData":{
"customKey1":"customValue1",
"customKey2":"customValue2"
},
"transactions":[
{
"id":"27194245144",
"type":"UPI",
"status":"SUCCESS",
"createdTimestamp":"2023-01-01T01:00:00.000+0000",
"updatedTimestamp":"2023-01-01T01:00:00.000+0000"
}
]
},
"createdAt":"2023-01-01T01:00:00.000+0000"
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code, if it accepts the callback."
}
}
}
},
"receive-whatsapp-marketing-update-notification":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-message-status-reports",
"whatsapp-marketing-update"
],
"summary":"Receive WhatsApp Marketing Update Notification",
"description":"Receive notification about user preferences for marketing template messages.",
"externalDocs":{
"description":"Learn more about the WhatsApp channel and its use cases.",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"receive-whatsapp-marketing-update-notification",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotificationResponse"
},
"examples":{
"Stop notification":{
"summary":"Stop notification",
"value":{
"from":"41793026731",
"content":{
"sender":"41793026731",
"from":"385919998888",
"notificationMessagesStatus":"stop",
"description":"User requested to stop marketing messages"
},
"createdAt":"2024-01-01T01:00:00.000+0000"
}
},
"Resume notification":{
"summary":"Resume notification",
"value":{
"from":"41793026731",
"content":{
"sender":"41793026731",
"from":"385919998888",
"notificationMessagesStatus":"resume",
"description":"User requested to resume marketing messages"
},
"createdAt":"2024-01-01T01:00:00.000+0000"
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code, if it accepts the callback."
}
}
}
},
"receive-whatsapp-message-template-update-events":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-service-management",
"whatsapp-template-management"
],
"summary":"Receive WhatsApp template update",
"description":"For each message template you create, we can send you updates. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.",
"externalDocs":{
"description":"Learn more about the WhatsApp channel and use cases",
"url":"https://www.infobip.com/docs/whatsapp"
},
"operationId":"receive-whatsapp-message-template-update-events",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateUpdatePushEvent"
},
"examples":{
"Template APPROVED event":{
"summary":"Template APPROVED event",
"value":{
"messageTemplateId":"111",
"messageTemplateName":"template_name",
"messageTemplateLanguage":"en",
"timestamp":"2019-11-09T16:00:00.000+0000",
"change":{
"type":"TEMPLATE_STATUS_UPDATE",
"newStatus":"APPROVED",
"reason":"NONE"
},
"entityId":123456,
"applicationId":1234567
}
},
"Template REJECTED event":{
"summary":"Template REJECTED event",
"value":{
"messageTemplateId":"111",
"messageTemplateName":"template_name",
"messageTemplateLanguage":"en",
"timestamp":"2019-11-09T16:00:00.000+0000",
"change":{
"type":"TEMPLATE_STATUS_UPDATE",
"newStatus":"REJECTED",
"reason":"SCAM"
},
"entityId":123456,
"applicationId":1234567
}
},
"Template FLAGGED event":{
"summary":"Template FLAGGED event",
"value":{
"messageTemplateId":"111",
"messageTemplateName":"template_name",
"messageTemplateLanguage":"en",
"timestamp":"2019-11-09T16:00:00.000+0000",
"change":{
"type":"TEMPLATE_STATUS_UPDATE",
"newStatus":"FLAGGED"
},
"entityId":123456,
"applicationId":1234567
}
},
"Template category change event":{
"summary":"Template category change event",
"value":{
"messageTemplateId":"111",
"messageTemplateName":"template_name",
"messageTemplateLanguage":"en",
"timestamp":"2019-11-09T16:00:00.000+0000",
"change":{
"type":"TEMPLATE_CATEGORY_UPDATE",
"previousCategory":"MARKETING",
"newCategory":"UTILITY"
},
"entityId":123456,
"applicationId":1234567
}
},
"Template quality change event":{
"summary":"Template quality change event",
"value":{
"messageTemplateId":"111",
"messageTemplateName":"template_name",
"messageTemplateLanguage":"en",
"timestamp":"2019-11-09T16:00:00.000+0000",
"change":{
"type":"TEMPLATE_QUALITY_UPDATE",
"previousQualityScore":"LOW",
"newQualityScore":"HIGH"
},
"entityId":123456,
"applicationId":1234567
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-whatsapp-identity-change-notification":{
"post":{
"tags":[
"channels",
"whatsapp",
"whatsapp-identity-management"
],
"summary":"Receive WhatsApp Identity Change Notification",
"description":"Receive notification about end user's identity change. Feature is not enabled by default.",
"externalDocs":{
"description":"Learn more.",
"url":"https://www.infobip.com/docs/whatsapp/additional-functionality#identity-change"
},
"operationId":"receive-whatsapp-identity-change-notification",
"requestBody":{
"content":{
"application/json":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEventResponse"
}
]
},
"examples":{
"Identity change reports":{
"summary":"Identity change reports",
"value":{
"from":"41793026731",
"content":{
"description":"Security code changed.",
"hash":"eU2Fdi4EMUw=",
"type":"user_identity_changed",
"userNumber":"385919998888",
"userId":"HR.123123123"
},
"createdAt":"2022-01-18T23:23:09.206+0000"
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code, if it accepts the callback."
}
}
}
}
}
}