Product Card Carousel Template Message

POST Method

Product card carousel templates allow businesses to send a single text message accompanied by a set of up to 10 product cards in a horizontally scrollable view. Carousel templates support up to 10 product cards, each composed of a message body, a product image, a product title, a product price, and either a single View button or a URL button.

This document explains how to send approved product card carousel templates to WhatsApp users.

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 platform, 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.
- A WABA ID onboarded on Kaleyra WhatsApp API V2.

Base URL

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

API Domain and Value

api_domain	Value
IN pod	api.in.kaleyra.io
SG Pod	api.kaleyra.io
EU Pod	api.eu.kaleyra.io
NA pod	api.na.kaleyra.ai

API request to send Product Card Carousel Template Message

To send an approved product card carousel template message, use the <api_domain>/v1/<sid>/whatsapp/<phone_number>/messages endpoint with the following request method:

Request Format

The following is the request format to send an approved product card carousel template message:

curl --location --request POST http://<api_domain>/v1/<sid>/whatsapp/<phone_number>/messages \ 
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -d  '{
    "messaging_object": {
        "messaging_product": "whatsapp",
        "recipient_type": "individual",
        "to": "<PHONE_NUMBER>",
        "type": "template",
        "template": {
            "name": "<TEMPLATE_NAME>",
            "language": {
                "code": "en"
            },
            "components": [
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "<text>"
                        },
                        {
                            "type": "text",
                            "text": "<text>"
                        }
                    ]
                },
                {
                    "type": "carousel",
                    "cards": [
                        {
                            "card_index": `<card_index>`,
                            "components": [
                                {
                                    "type": "header",
                                    "parameters": [
                                        {
                                            "type": "product",
                                            "product": {
                                                "product_retailer_id": "<product_retailer_id>",
                                                "catalog_id": "<catalog_id>"
                                            }
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "card_index": `<card_index>`,
                            "components": [
                                {
                                    "type": "header",
                                    "parameters": [
                                        {
                                            "type": "product",
                                            "product": {
                                                "product_retailer_id": "<product_retailer_id>",
                                                "catalog_id": "<catalog_id>"
                                            }
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

The following is the sample request format to send approved product card carousel template message:

curl --location --request POST http://api.in.kaleyra.io/v1/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
  -d  '{
    "messaging_object": {
        "messaging_product": "whatsapp",
        "recipient_type": "individual",
        "to": "+16505551234",
        "type": "template",
        "template": {
            "name": "carousel_template_product_cards_v1",
            "language": {
                "code": "en_US"
            },
            "components": [
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Pablo"
                        }
                    ]
                },
                {
                    "type": "carousel",
                    "cards": [
                        {
                            "card_index": 0,
                            "components": [
                                {
                                    "type": "header",
                                    "parameters": [
                                        {
                                            "type": "product",
                                            "product": {
                                                "product_retailer_id": "vrpj01fvwp",
                                                "catalog_id": "194836987003835"
                                            }
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "card_index": 1,
                            "components": [
                                {
                                    "type": "header",
                                    "parameters": [
                                        {
                                            "type": "product",
                                            "product": {
                                                "product_retailer_id": "va2l5ioeat",
                                                "catalog_id": "194836987003835"
                                            }
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    },
    "extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }
}'

URL Parameters and Headers

The 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 JSON 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`	String	WhatsApp end-user phone number. It should include country code prefix following E.164 format.	+16XXXXXX234	Yes
`type`	String	The type of message you want to send. If omitted, defaults to text.	Only allowed value for sending this message is	No

<ADD ANY ADDITIONAL TABLE FOR SPECIFIC OBJECTS IN THE MESSAGING_OBJECT >

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 enters any value other than the above-specified values, the system will override it 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 2 hours ago