Send Carousel Template Messages

POST Method

The Send Carousel Template Messages allows you to send carousel template messages to WhatsApp users.
For more information, see the Carousel Templates page.

Prerequisites

Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
A prerequisite for using Kaleyra WhatsApp APIs is to have an active WhatsApp plan on kaleyra platform.
To set up a WhatsApp account on kaleyra.io, see Manual Signup
and Embedded Signup.
An active WhatsApp for Business API plan that includes:
- A WhatsApp business number.
- An associated profile with the business number.
- A WhatsApp verified and approved profile.

Base URL

https://<api_domain>/v2/<SID>

API Domain and Value

api_domain	Value
IN pod	api.in.kaleyra.io
SG Pod	api.ap.kaleyra.io
EU Pod	api.eu.kaleyra.io

API request to send Carousel Template Messages

To send Carousel Template Messages, use the https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages endpoint with the following request method:

Request Format

The following is the request format to send Carousel Template Messages:

curl -X POST \
  https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages \
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "<messaging_product>",
        "recipient_type": "<recipient_type>",
        "to": "<to>",
        "type": "<type>",
        "template": {
            "name": "<name>",
            "language": {
                "code": "<code>"
            },
            "components": [
			                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "text": "<message_body_text_variable>"
                        }
                    ]
                },
			                {
                    "type": "<type>",
                    "cards": [				
                        {
                            "card_index": <card_index>,
                            "components": [
                                {
                                    "type": "<type>",
                                    "parameters": [  
                                      {										
                                            "type": "<image>",
                                            "image": {
                                                "id": "<header_asset_id>"
                                            },										
											"type": "<video>",
                    						"video": {
                      							"id": "<header_asset_id>"
                    						},
                                        }
                                    ]
                                },							
                                {
                                    "type": "<body>",
                                    "parameters": [
                                        {
                                            "type": "text",
                                            "text": "<card_body_variable>"
                                        }
                                    ]
                                },
                                {
                                    "type": "<type>",
                                    "sub_type": "<sub_type>",
                                    "index": <button_index>,
                                    "parameters": [
                                        {
                                            "type": "<type>",
                                            "payload": "<quick_reply_button_payload>"
                                        }
                                    ]
                                },
                                {
                                    "type": "<type>",
                                    "sub_type": "<sub_type>",
                                    "index": <button_index>,
                                    "parameters": [
                                        {
                                            "type": "<type>",
                                            "payload": "<url_button_payload>"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
				
            ]
        }
    },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

The following is the sample request format to send Carousel Template Messages:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "whatsapp",
        "recipient_type": "individual",
        "to": "+91XXXXXXXXXX",
        "type": "template",
        "template": {
            "name": "Carousel Template",
            "language": {
                "code": "en_US"
            },
            "components": [
			                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "welcome"
                        }
                    ]
                },				
                {
                    "type": "carousel",
                    "cards": [					
                        {
                            "card_index": 0,
                            "components": [
                                {
                                    "type": "header",
                                    "parameters": [  
                                      {											
                                            "type": "image",
                                            "image": {
                                                "id": "15580815XXXX3159"
                                            },										
											"type": "video",
                    						"video": {
                      							"id": "15580815XXXX3169"
                    						},
                                        }
                                    ]
                                },								
                                {
                                    "type": "body",
                                    "parameters": [
                                        {
                                            "type": "text",
                                            "text": "john"
                                        }
                                    ]
                                },
                                {
                                    "type": "button",
                                    "sub_type": "quick_reply",
                                    "index": 0,
                                    "parameters": [
                                        {
                                            "type": "Payload",
                                            "payload": "more-aloes"
                                        }
                                    ]
                                },
                                {
                                    "type": "button",
                                    "sub_type": "url",
                                    "index": 1,
                                    "parameters": [
                                        {
                                            "type": "Payload",
                                            "payload": "blue-elf"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
				
            ]
        }
    },
    "extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }
}'

URL Parameters and Headers

Following is the list of parameters and headers to send the outgoing message request:

Parameter / Headers	Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	HXAP16XXXXXX97IN	Yes
`phone_number`	String	Phone number of the end customer you want to send a message to.	+91XXXXXXXXXX	Yes (valid phone numbers only)
`Content-Type`	String	Indicates the format of the content the API will be processing.	The only allowed value is application/json.	Yes
`api-key`	String	API key generated from kaleyra platform account.	Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3	Yes

Following is the list of attributes to be used in the payload to send the outgoing message:

Parameter	Data Type	Description	Example	Mandatory?
`messaging_object`	JSON object	Payload is supported only in JSON format. The messaging_object is the payload which contains the message object as defined by Meta which is used to send the WhatsApp message.	See the specific table for details.	Yes
`extra_info`	JSON object	This object will contain additional details that a user can send for certain functionalities.	See the specific table for details.	No

The following table describes the different attributes used for the messaging_object object.

Parameter	Data Type	Description	Example	Mandatory?
`messaging_product`	String	Messaging service used for the request.	Only allowed value is whatsapp	Yes
`recipient_type`	String	Currently, you can only send messages to individuals. Default is individual.	Only allowed value is individual	No
`to_number`	String	A valid WhatsApp number of the recipient. Ensure that the country code is prefixed to the number. (E164 format). Note: You can add multiple recipients, separate each number using the comma (,) delimiter.	+91XXXXXXXXX	Yes
`type`	String	The type of message you want to send. If omitted, defaults to text.	Only allowed value is template	No
`template`	JSON object	Contains the template information to be sent.	See the specific table for details.	Yes

The following table describes the different attributes used for the template object.

Parameter	Data Type	Description	Example	Mandatory?
`name`	String	Specifies the template name. Note: The `template_name` must be approved by WhatsApp before you start using this API.	Carousel Template	Yes
`language`	JSON object	Contains the template language information to be sent.	See the specific table for details.	Yes
`components`	JSON object	The components in the template.	See the specific table for details.	Yes

The following table describes the different attributes used for the language object.

Parameter	Data Type	Description	Example	Mandatory?
`code`	String	The template's language and locale code.	en_US	Yes

The following table describes the different attributes of the body-components.

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	The type of component used in the template.	body	Yes
`parameters`	JSON Object	The type of value and the value associated with the body.	See the specific table for details	Yes

The following table describes the different attributes of the body components parameters object.

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	Defines the type of body	Only allowed value is text	No
`text`	String	Required if template message body text uses variables, otherwise omit.	welcome	Yes

The following table describes the different attributes of the carousel-components.

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	The type of component used in the template.	The only allowed value is carousel	Yes
`cards`	JSON Object	The type of value and the value associated with the cards.	See the specific table for details	Yes

The following table describes the different attributes of the cards object.

Parameter	Data Type	Description	Example	Mandatory?
`card_index`	integer	Zero-indexed order in which card should appear within the card carousel. 0 indicates first card, 1 indicates second card, etc.	0	Yes
`components`	JSON object	The components in the cards.	See the specific table for details	Yes

The cards component object is an array of objects defining the cards displayed in the carousel received by the end-users. The elements of the cards array may be of different types such as header, body, and buttons; within each of this element type, different kind of parameters may be supported as described in the following:

header type element can have the following type parameters:

"image"
"video"

body type element can have the following type parameter:

"text"

button type element can have the following parameters:

payload

For element with type header these are the parameters:

image:

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	Defines the type of header.	The only allowed value is image	Yes
`image`	JSON object	The components in the card's header parameter.	See the specific table for details	Yes

The following table describes the different attributes used for the image object:

Parameter	Data Type	Description	Example	Mandatory?
`header_asset_id`	String	Header asset's uploaded media asset ID. Use the POST /<BUSINESS_PHONE_NUMBER_ID>/media endpoint to generate an asset ID.	15580815XXXX3159	Yes

video:

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	Defines the type of header.	The only allowed value is video	Yes
`video`	JSON object	The components in the card's header parameter.	See the specific table for details	Yes

The following table describes the different attributes used for the video object:

Parameter	Data Type	Description	Example	Mandatory?
`header_asset_id`	String	Header asset's uploaded media asset ID. Use the POST /<BUSINESS_PHONE_NUMBER_ID>/media endpoint to generate an asset ID.	15580815XXXX3169	Yes

For element with type body these are the parameters:

text:

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	Defines the type of body.	The only allowed value is text	Yes
`card_body_variable`	Object	Required if the template card body text uses variables, otherwise omit. Object describing a card body variable. If the template uses multiple variables, you must define an object for each variable.	{ "type": "text", "text": "john" }	Yes

For element with type button these are the parameters:

payload:

Parameter	Data Type	Description	Example	Mandatory?
sub_type	String	Type of button to create. The supported options are quick_reply, url, and catalog.	quick_reply	Yes
`button_index`	Integer	Zero-indexed order in which button appears at the bottom of the template message. 0 indicates the first button, 1 indicates second button, etc. Note that if any buttons use variables, the type and order of buttons must match the type and order defined on the template, so you can't use the index values to arrange the order of the buttons in the sent template. For example, if the template defines a phone number button first (which equates to index 0) and a URL button that supports a single variable second (which equates to index 1), if you attempt to send the template with the URL button index set to 0 , the API would return an error ("Parameter value for URL was expected but was not found") because it's expecting a button object with an index of 1 to be present in the post body payload.	0	Yes
`parameters`	JSON object	The type of value and the value associated with the button.	See the specific table for details	Yes

The following table describes the different attributes used for the button-parameters object.

Parameter	Data Type	Description	Example	Mandatory?
`type`	string	The type of button parameter	The only allowed value is payload	Yes
`quick_reply_button_payload`	String	Value to be included in messages webhooks (messages.button.payload) when the button is tapped.	more-aloes	No

The following table describes the different attributes used for the extra_info JSON object:

Parameter	Data Type	Description	Example	Mandatory?
`ref`	String	Include any contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more. Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.	customer1	No
`ref1`	String	Include the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more. Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.	marketing	No
`ref2`	String	Include the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more. Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.	dictionary	No
`wa_source`	String	Indicates the source from where the API has been triggered. Supported values for wa_source are "api", "clevertap", "zoho", "webengage", "shopify", "leadsquared", "responsys", "braze", "hubspot", "salesforce", "zapier", "eloqua", and "moengage". Note: If the customer passes any other value other than above-specified values, then the system will override that as the "API".	api	No

📘
Note:
In the case of ref, ref1, and ref2, if the length of the string exceeds 255 characters, it will be truncated.

Sample Success Response

The following success message appears with the status 202 Accepted:

202 Accepted 
{
"code":"WA202"
"message":"Request Accepted",
"data":{
  "message_id":"AXXXXXXXXXXXXXXXXXXX"
}
"error":{}
}

Sample Failure Response

The following are the failure responses:

401 Unauthorized
{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}

401 Unauthorized phone number
{
    "code": "WA401",
    "message": "Phone number is not present or does not belong to the account.",
    "data": {},
    "error": {
        "phone_number": "Phone number is not present or does not belong to the account."
    }
}

400 Incorrect payload
{
    "code": "WA400",
    "message": "Refer to correct payload format",
    "data": {},
    "error": {
        "payload": "Incorrect payload format"
    }
}

500 Internal Server Error
{
    "code": "WA500",
    "message": "Please try again later",
    "data": {},
    "error": {
        "error": "Internal server error"
    }
}

400 Low balance
{
    "code": "E110",
    "message": "Please check your balance, You have a low balance!",
    "data": {},
    "error": {
        "balance": "Please check your balance, You have a low balance!"
    }
}

401 Unauthorised Account type
{
    "code": "WA-401",
    "message": "API is not available for given customer.Please contact support for more info",
    "data": {},
    "error": {
        "account": "API is not available for given customer.Please contact support for more info"
    }
}

401 Unauthorized phone number version
{
    "code": "WA-401",
    "message": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint.",
    "data": {},
    "error": {
        "phone_number": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint."
    }
}

Updated about 17 hours ago

Prerequisites

Base URL

API Domain and Value

API request to send Carousel Template Messages

Request Format

Sample Request Format

URL Parameters and Headers

📘Note:

Sample Success Response

Sample Failure Response

📘
Note: