Sign in

v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
Outgoing Messages

Send Whatsapp Interactive Media Carousel Message

Send a WhatsApp interactive media carousel message — 2-10 cards, each with an image or video header, optional body text, and either a single URL button (cta_url) or one or more quick-reply buttons. All cards must use the same button type and same number of buttons.

post/whatsapp/message/interactive/media-carousel

Request body

fromstring phone required

The phone number from which the message is sent, with the country code

tostring phone required

The phone number to which the message is sent, with the country code

messageIdstring

Message ID (UUID v4) to be used for the message. If not provided, a random UUID v4 will be generated

Example request

{
  "from": "+919999999999",
  "to": "+919999999999",
  "messageId": "uuid-v4",
  "content": {
    "body": {
      "text": "Of course! Here are three of our latest arrivals, each under $25:"
    },
    "cards": [
      {
        "header": {
          "type": "image",
          "image": {
            "link": "https://www.example.com/assets/blue-echeveria.jpeg"
          },
          "video": {
            "link": "https://www.example.com/assets/blue-echeveria.jpeg"
          }
        },
        "body": {
          "text": "*Blue Echeveria*\\n\\nA rosette-shaped succulent."
        },
        "action": {
          "type": "cta_url",
          "parameters": {
            "display_text": "Buy now",
            "url": "https://shop.example.com/latest/blue-echeveria"
          },
          "buttons": [
            {
              "id": "learn-blue-echeveria",
              "title": "Learn more"
            }
          ]
        }
      }
    ]
  }
}