Interactive messages
Last update: 6 hours ago by Irais Aguirre
Interactive messages give users buttons, lists and other controls so they can respond to a business more easily.
Integration summary
- Endpoint:
POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging- Token: messaging token, in the
Authorization: Bearer {{wa-msg-api-token}}header (how to generate it)- Common fields:
from,to(phone number or BSUID) andtype(details)- Response: the same for every message (see response)
Interactive messages let you:
- Help your users easily find and select what they're looking for from a business on WhatsApp.
- Offer a simpler, more consistent format for people to find and choose what they want from a business.
The available interactive messages are:
- Flows: Messages that open a WhatsApp Flow. To create and manage Flows, see the Flows section.
- List messages: Messages that include a menu of up to 10 options. This message type gives users a simpler, more consistent way to make a selection when interacting with a business.
- Reply buttons: Messages that include up to 3 options, each shown as a button. This message type gives users a faster way to pick from a menu when interacting with a business. They can also include up to 2 buttons that open a URL.
- Call to action (URL): Messages with a button that opens a URL. They let you send users to a website without showing the full URL in the message text.
- Contact information request: Messages with a button that lets users share their contact information with the business.
- Location request: Messages with a button that asks the user to share their location.
- Call button (voice call): Messages with a button that lets the user start a WhatsApp call to the business.
- Multi-product messages: See the C-Commerce section.
- Single-product messages: See the C-Commerce section.
You can combine interactive messages within the same flow.
All are sent with POST /v1/messaging; headers, common fields and the response are in HTTP connection.
General structure
All interactive messages use the type field with the value "interactive" and one of the following objects:
| Name | Description | Type | Requirements |
|---|---|---|---|
| listMessages | Object with the list message. Send only one: listMessages, replyButtons or flow (or another interactive message type). | Object | Conditional |
| replyButtons | Object with the reply buttons. Send only one: listMessages, replyButtons or flow (or another interactive message type). | Object | Conditional |
| flow | Object with the WhatsApp Flow. Send only one: listMessages, replyButtons or flow (or another interactive message type). | Object | Conditional |
| call_to_action_url | Object for sending a message with a button that opens a URL. | Object | Required if you're sending a call to action (URL) message. |
| request_contact_info | Object for asking the user to share their contact information. | Object | Required if you're sending a contact information request. |
| singleProductMessage | Single product message. | Object | Conditional |
| multiProductMessage | Multi-product message. | Object | Conditional |
| send_location_request | Location request from the user. | Object | Conditional |
| call_permission_request | Call permission request. See Call permissions. | Object | Conditional |
| voice_call | Call button (voice call) message. | Object | Conditional |
| order_details | Order details message (Payments Brazil). | Object | Conditional |
| order_status | Order status message (Payments Brazil). | Object | Conditional |