Media carousel

This page describes interactive media carousel messages

Interactive media carousel messages display a set of horizontally scrollable media cards. Each card can display an image or video header, body text, and either quick-reply buttons or a URL button.

This is the same message, but using quick-reply buttons instead of URL buttons:

Components

• Messages must include between 2 and 10 cards.

• Main message body text is required.

• Main message headers, footers, and interactive components are not supported.

• Cards must include either an image or a video header. Other header types are not supported.

• Card body text is optional.

• Cards must include either one URL button or one or more quick-reply buttons. Button types and numbers must match across all cards (for example, if you define a card with 2 quick-reply buttons, all cards must define exactly 2 quick-reply buttons).

Example

POST https://waba-v2.360dialog.io/messages

To send a message, use the request URL and the following parameters.

Parameters

Name	Type	Description
card_body_text	string	Card body text. Max 160 characters, and up to 2 line breaks.
card_index*	integer	0 Zero-index card index. Cards will appear left to right in a scrollable view, starting from 0.
header_type*	string	Value can be image or video Supported media types.
media_asset_url*	string	Publicly available media asset URL.
message_body_text*	string	Main message body text. Maximum 1024 characters.
quick_reply_button_id	string	Maximum 20 characters.
quick_reply_button_label	string	Maximum 20 characters.
url_button_label	string	Maximum 20 characters.
url_button_url	string	URL to load in the device’s default web browser when tapped by the user. Maximum 20 characters.
user_phone_numers*	string	WhatsApp user phone number.

Example with URL buttons

Request

curl --location 'https://https://waba-v2.360dialog.io/messages' \
--header 'Content-Type: application/json' \
--header 'D360-API-KEY: <token>' \
--data '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<<RECIPIENT_PHONE_NUMBER>>",
  "type": "interactive",
  "interactive": {
    "type": "carousel",
    "body": {
      "text": "<BODY_TEXT>"
    },
    "action": {
      "cards": [
        {
          "card_index": 0,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": {
              "link": "https://www.yourimage.jpeg"
            }
          },
          "body": {
            "text": "<BODY_TEXT>"
          },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "<TEXT>",
              "url": "https://www.website.com/url-example"
            }
          }
        },
        {
          "card_index": 1,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": {
              "link": "https://www.yourimage.jpeg"
            }
          },
          "body": {
            "text": "<BODY_TEXT>"
          },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "<TEXT>",
              "url": "https://www.website.com/url-example"
            }
          }
        },
        {
          "card_index": 2,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": {
              "link": "https://www.yourimage.jpeg"
            }
          },
          "body": {
            "text": "<BODY_TEXT>"
          },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "<TEXT>",
              "url": "https://www.website.com/url-example"
            }
          }
        }
      ]
    }
  }
}'

Response

200

{
  "messaging_product": "whatsapp",
  "contacts": [{
    "input": "PHONE_NUMBER",
    "wa_id": "WHATSAPP_ID",
  }]
  "messages": [{
    "id": "wamid.ID",
  }]
}