Skip to main content

Interactive Media Carousel

POST 
/nusasms_api/1.0/wa_business/interactive/carousel
Syarat Penggunaan

Supaya dapat mengirim tipe pesan ini (seperti tipe reply / balasan), harus sudah ada Conversation room (percakapan) antara akun Whatsapp (Gateway) dengan si penerima pesan.

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.

Introduction​

Json Request Components​

  • body: The main body text
    required, max 1024 characters
  • cards: The media cards, with the component details below.
    required, min 2, max 10 items

Card Components

  • card_index: Card order starts from 0 (first/most left card) optional
  • header: The card header image/video
    required
    • type: image and video only
    • link: the media file URL
  • body: The card text
    optional
  • buttons: Card button. There are 2 types of buttons url and quick_reply
    Note: 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).
    • url: max 1 button
    • quick_reply max 2 buttons
      optional

Card Button​

There are 2 types of card buttons, namely url and quick_reply. Make sure to have same type and button number for every card.

cards parameter value examples:

  "cards": [
    {
      "Card_index": 0,
      "header": {
        "type": "image",
        "link": "https://api-doc.nusasms.com/slate/img/logo.png"
      },
      "body": {"text": "Card 0 text"},
      "buttons": [
        {
          "text": "Btn 0 text",
          "url": "https://doc.nusasms.com/docs/nusasms/nusasms-api/"
        }
      ]
    },
    {
      "Card_index": 1,
      "header": {
        "type": "image",
        "link": "https://api-doc.nusasms.com/slate/img/logo.png"
      },
      "body": {"text": "Card 1 text"},
      "buttons": [
        {
          "text": "Btn 1 text",
          "url": "https://doc.nusasms.com/docs/nusasms/nusasms-api/"
        }
      ]
    }
  ]

Message Preview

Message preview


Request​

Responses​

Successful Response