Sending Carousel Message

Send Carousel via API

The Carousel Message API allows you to send interactive carousel messages directly through an API request.

Request URL (V4)

POST https://pickyassist.com/app/api/v2/push

This API allows you to send carousel messages to multiple numbers

API Variable Details

Variable	Data Type	Description	Required
token	string	Unique token for the project	Mandatory
application	number	Specify through which application the message need to sent 121 = WhatsApp Business API 101 = WhatsApp Cloud API If you have connected multiple channels or using WhatsApp Cloud api then please get the channel id from your project under Channel Settings	Mandatory
interactive_type	number	Specifies the type of interactive carousel message you want to send. 11 - Media Carousel 12 - Product Carousel	Mandatory
globalmessage	string	Message text displayed above the carousel cards in the Message Body section. With emoji supported by whatsapp. (Maximum 1024 characters)	Mandatory
interactive	Object	Contains the carousel configuration, including the list of carousel cards	Mandatory
cards	array	Contains the individual carousel cards and their media, message, and button details.
media	URL	URL from we need to fetch the Card media. Only image or video url	Mandatory
card_message	string	Specifies the message text displayed on the carousel card. (Max 160 characters, and up to 2 line breaks)	Mandatory
buttons	array	Contains the details of interactive buttons configured for the carousel card
type	numeric	Specifies the type of button. 1 = Quick Reply (max 2 per card) 2 = Url Button (only 1 button per card)	Mandatory
title	string	Specifies the text displayed on the URL/Quick Reply buttons	Mandatory
button_id	string	Specifies the identifier of the button, used to identify the button selected by the user.	Mandatory, if button type=1
url	URL	Specifies the URL opened when the button is clicked	Mandatory, if button type=2
number	numeric	Mobile Number with full country code without 0 or + [phone] – Wrong Format 55123456789 – Correct Format	Mandatory
product_id	string	The unique ID of the product	Mandatory for Product Carousel
data	array	This is an array in which you need to pass the mobile number

Sample Request - Media Carousel

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.

Carousel with URL button

{
   "token":"your token",
   "application":"121",
   "interactive_type":11,
   "globalmessage":"test message body",
    "interactive":{
     	 "cards": [
    {
      "media": "media url 1",
      "card_message": "CARD MESSAGE 1",
      "buttons": [
        {
         “type”:2,
          "title": "BUTTON TITLE 1",
          "url": "BUTTON URL 1"
        }
      ]
    },
    {
      "media": "media url 2",
      "card_message": "CARD MESSAGE 2",
      "buttons": [
        {
“type”:2,
 "title": "BUTTON TITLE 2",
             "url": "BUTTON URL 2"
        }
      ]
    }

  ]

     },
   "data":[
      {
         "number":"19834434690"
      }   ]
}

Carousel with Quick Reply Button

{
   "token":"your token",
   "application":"121",
   "interactive_type":11,
   "globalmessage":"test message body",
    "interactive": {
        "cards": [
            {
                "media": "media url 1",
                "card_message": "CARD MESSAGE 1",
                "buttons": [
                    {
                        "type": 1,
                        "title": "BUTTON TITLE 1",
                        "button_id": "QUICK REPLYBUTTON ID"
                    },
                    {
                        "type": 1,
                        "title": "BUTTON TITLE2",
                        "button_id": "QUICK REPLYBUTTON ID"
                    }
                ]
            },
            {
                "media": "media url 2",
                "card_message": "CARD MESSAGE 2",
                "buttons": [
                    {
                        "type": 1,
                        "title": "BUTTON TITLE 1",
                        "button_id": "QUICK REPLYBUTTON ID"
                    },
                    {
                        "type": 1,
                        "title": "BUTTON TITLE2",
                        "button_id": "QUICK REPLYBUTTON ID"
                    }
                ]
            }
        ]
    },
   "data":[
      {
         "number":"19834434690"
      }   ]
}

Sample Response

{
"status":100,
"push_id":"405904770",
"message":"Success",
"data":[
{"msg_id":509099555,
"number":"919999999999",
"credit":0}
]
}

Sample Request - Product Carousel

The Product Carousel API allows you to send multiple products from your WhatsApp Catalog directly to customers through an API request.

{
   "token":"your token",
   "application":"121",
   "interactive_type":12,
   "globalmessage":"test message body",
    "interactive":{
     	 "cards": [
    {
      "product_id": "<PRODUCT_ID>"
    },
    {
      "product_id": "<PRODUCT_ID>"
        }
     ]
  }
        ]
     },
   "data":[
      {
         "number":"19834434699"
      }   ]
}