Send Template Messages

The Send Template Messages allows you to send Template Messages to WhatsApp users.

WhatsApp message templates are specific message formats that businesses use to send out notifications or marketing communications. Messages can include appointment reminders, shipping information, issue resolution, payment updates or promotional communications.

Before sending a template message, you need to create a template. See Create Message Templates for Your WhatsApp Business Account for more information. If your account is not verified yet, you can use one of your pre-approved templates.

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 Template Messages:

To send 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 Template Messages; the request format is based on a sample template including several dynamic parameters in its text:

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": "<phone_number>",
        "type": "<type>",
        "template": {
            "name": "<template_name>",
            "language": {
                "code": "<code>"
            },
            "components": [
                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "image": {
                                "link": "<http(s)://URL>"
                            }
                        }
                    ]
                },
                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "text": "<text_string>"
                        },
                        {
                            "type": "<type>",
                            "currency": {
                                "fallback_value": "<fallback_value>",
                                "code": "<code>",
								"amount_1000": <number>
                            }
                        },
                        {
                            "type": "<type>",
                            "date_time": {
                                "fallback_value": "<fallback_value>"
                            }
                        }
                    ]
                },
                {
                    "type": "<type>",
                    "sub_type": "<sub_type>",
                    "index": "<index_value>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "payload": "<payload>"
                        }
                    ]
                },
                {
                    "type": "<type>",
                    "sub_type": "<sub_type>",
                    "index": "<index_value>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "payload": "<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 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": "+91XXXXXXXXX",
        "type": "template",
        "template": {
            "name": "order_delivery_update",
            "language": {
                "code": "en_US"
            },
            "components": [
                    "type": "header",
                    "parameters": [
                        {
                            "type": "image",
                            "image": {
                                "link": "https://d1imv9qltd8ha.cloudfront.net/docs/68d8921ec40e4bbb8f84bb1ed59c733f_IMG_2105.png"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "welcome"
                        },
                        {
                            "type": "currency",
                            "currency": {
                                "fallback_value": "value",
                                "code": "USD",
							                	"amount_1000": 3000
                            }
                        },
                        {
                            "type": "date_time",
                            "date_time": {
                                "fallback_value": "MONTH, DAY, YEAR"
                            }
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [
                        {
                            "type": "payload",
                            "payload": "Payload"
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "1",
                    "parameters": [
                        {
                            "type": "payload",
                            "payload": "sample"
                        }
                    ]
                }
            ]
        }
    },
    "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.	The only allowed value is whatsapp	Yes
`recipient_type`	String	Currently, you can only send messages to individuals. Default is individual.	The only allowed value is individual	No
`phone_number`	String	WhatsApp end-user phone number. It should include country code prefix following E.164 format.	+91XXXXXXXXX	Yes
`type`	String	The type of message you want to send. If omitted, defaults to text.	The 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?
`template_name`	String	Specifies the template name. Note: The `template_name` must be approved by WhatsApp before you start using this API.	order_delivery_update	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.	No
`parameters`	JSON object	Parameter object information.	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	Template language and locale code.	en_US	Yes

The component object is an array that composed by header, body, and button plus other components that can have the following type of elements:

header can have the following type of element:

"image"

body can have the following type of elements:

"text"
"currency"
"date_time"

button can have the following type of element:

"payload"

The following table(s) described the different attributes for the component's element of type:

image:

Parameter	Data Type	Description	Example	Mandatory?
`link`	String	The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.	https://d1imv9qltd8ha.cloudfront.net/docs/68d8921ec40e4bbb8f84bb1ed59c733f_IMG_2105.png	Yes

text:

Parameter	Data Type	Description	Example	Mandatory?
`text`	String	The text that is used in the body.	welcome	Yes

currency:

Parameter	Data Type	Description	Example	Mandatory?
`fallback_value`	String	Default text if localization fails.	value	Yes
`code`	String	Currency code as defined in ISO 4217.	USD	Yes
`amount_1000`	Numeric	Amount multiplied by 1000.	3000	Yes

date_time:

Parameter	Data Type	Description	Example	Mandatory?
`fallback_value`	String	Default text. For Cloud API, we always use the fallback value, and we do not attempt to localize using other optional fields.	MONTH, DAY, YEAR	Yes

button:

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
`index`	Integer	Position index of the button. You can have up to 10 buttons using index values of 0 to 9.	0	Yes

payload:

Parameter	Data Type	Description	Example	Mandatory?
`payload`	String	Developer-defined payload that is returned when the button is clicked in addition to the display text on the button.	sample	Yes

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."
    }
}

Prerequisites

Base URL

API Domain and Value

API request to send Template Messages:

Request Format

Sample Request Format

URL Parameters and Headers

📘Note:

Sample Success Response

Sample Failure Response

📘
Note: