Send Authentication Template Messages
POST Method
The Send Authentication Template Messages API allows you to send WhatsApp messages using the approved authentication templates with one-time password buttons.
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 Authentication Template Messages
To send Authentication 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 Authentication Template Messages:
curl -X POST \
https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages \
-H 'Content-Type: <content_type>' \
-H 'api-key: <api-key>' \
-d '{
"messaging_object": {
"messaging_product": "<messaging_product>",
"recipient_type": "<recipient_type>",
"to": "<to_number>",
"type": "<type>",
"template": {
"name": "<template_name>",
"language": {
"code": "<template_language_code>"
},
"components": [
{
"type": "<type>",
"parameters": [
{
"type": "<type>",
"text": "<one-time-password>"
}
]
},
{
"type": "<type>",
"sub_type": "<sub_type>",
"index": <index_value>,
"parameters": [
{
"type": "<type>",
"text": "<one_time_password>"
}
]
}
]
}
},
"extra_info": {
"ref": "<ref>",
"ref1": "<ref1>",
"ref2": "<ref2>",
"wa_source": "<wa_source>"
}
}'
Sample Request Format
The following is the sample request format to send Authentication Template Messages:
curl -X POST \
https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
-H 'Content-Type: application/json' \
-H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
-d '{
"messaging_object": {
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "+91XXXXXXXXX",
"type": "template",
"template": {
"name": "auth1",
"language": {
"code": "en_US"
},
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "J$FpXXXX"
}
]
},
{
"type": "button",
"sub_type": "url",
"index": 0,
"parameters": [
{
"type": "text",
"text": "J$FXXXXp"
}
]
}
]
}
},
"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. | 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 |
language | JSON object | Contains the language 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. | auth1 | Yes |
The following table describes the different attributes used for the language
object.
Parameter | Data Type | Description | Example | Mandatory? |
---|---|---|---|---|
template_language_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. | The only allowed value is 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-parameters
object.
Parameter | Data Type | Description | Example | Mandatory? |
---|---|---|---|---|
type | String | Specifies the parameter type. The supported values are currency, document, date and time, image, text, and video. Note: For text-based templates, the only supported parameter types are currency, date_time, and text | The only allowed value is text | Yes |
one_time_password | String | The one-time password or verification code to be delivered to the customer. Maximum 15 characters. Note: This value must appear twice in the payload. | J$FpXXXX | Yes |
The following table describes the different attributes of the button-components
.
Parameter | Data Type | Description | Example | Mandatory? |
---|---|---|---|---|
type | String | Specifies the component type. The supported options are header, body and button. Note: For text-based templates, type=body is supported. | button | Yes |
sub_type | String | Type of button to create. The supported options are quick_reply, url, and catalog. | url | Yes |
index_value | Integer | Position index of the button. You can have up to 10 buttons using index values of 0 to 9. | 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 of the button-parameters
object.
Parameter | Data Type | Description | Example | Mandatory? |
---|---|---|---|---|
type | String | Defines the type of button. | The only allowed value is text | Yes |
one_time_password | String | The one-time password or verification code to be delivered to the customer. Maximum 15 characters. Note: This value must appear twice in the payload. | J$FXXXXp | Yes |
The following table describes the different attributes used for the extra_info
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 16 hours ago