Send WhatsApp interactive list message

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 should be used. <br/> The API response will not contain the final delivery status, use Delivery Reports instead.

post/whatsapp/1/message/interactive/list

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Request body

fromstring required

Registered WhatsApp sender number. Must be in international format and comply with WhatsApp's requirements.

tostring required

Message recipient number in international format or WhatsApp business-scoped user ID.

messageIdstring

The ID that uniquely identifies the message sent.

callbackDatastring

Custom client data that will be included in a Delivery Report.

notifyUrlstring

The URL on your callback server to which delivery and seen reports will be sent. Delivery report format, Seen report format.

entityIdstring

Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our documentation.

applicationIdstring

Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our documentation.

Response

Message accepted for delivery

tostring

The destination address of the message.

messageCountinteger

Number of messages required to deliver.

messageIdstring

The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.

Example response

{
  "to": "385977666618",
  "messageCount": 1,
  "messageId": "06df139a-7eb5-4a6e-902e-40e892210455",
  "status": {
    "groupId": 1,
    "groupName": "PENDING",
    "id": 7,
    "name": "PENDING_ENROUTE",
    "description": "Message sent to next instance"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.