Send a Text Template Message through WhatsApp

This API will help you create and send WhatsApp Message Templates.
Template messages are predefined messages that are used for standard communication and are designed to be reusable.

1. Sign up for free

Before you get started, sign up for a Kaleyra.io account for free Create an API Key. To view the API Key and the SID, see View API Key and SID.

2. Pre-requisites

Below listed are the pre-requisites for using Kalyera WhatsApp API’s

• A WhatsApp business number.
• An associated profile with the business number.
• A WhatsApp verified and approved profile.

For more details, read what WhatsApp has to say about creating a business account.
Read Message Templates for any questions you may have about creating templates.

3. Send a Text Template Message

You can use the below API’s to send a template message via WhatsApp account

Request Format - POST

curl -X POST "https://api.kaleyra.io/v1/<SID>/messages" \
     -H "api-key: <API_KEY>" \
     -d "from=<FROM_NUMBER>" \
     -d "to=<TO_NUMBER>" \
     -d "type=<MESSAGE_TYPE>" \
     -d "channel=<CHANNEL_NAME>" \
     -d "template_name=<TEMPLATE_NAME>" \
     -d "params=<TEMPLATE_PARAMETERS>" \
     -d "lang_code=<LANGUAGE_CODE>" \
     -d "callback_url=<CALLBACK_URL>"

Request Format - GET

curl --request GET 'https://api.kaleyra.io/v1/<SID>/messages?channel=<CHANNEL_NAME>&to=<TO_NUMBER>&from=<FROM_NUMBER>&type=<MESSAGE_TYPE>&template_name=<TEMPLATE_NAME>&params=<TEMPLATE_PARAMETERS>&lang_code=<LANGUAGE_CODE>&callback_url=<CALLBACK_URL>' 
--header 'api-key: <API_KEY>'

📘

NOTE

Replace the placeholders above with relevant values as mentioned below.

developers.kaleyra.io

WhatsApp Callback URL

4. Response

If your request is successful, the response will be similar to the response shown below:

{
    "id": "1b408138-61bf-46d3-9a1d-f13089dbf0a5",
    "type": "template", 
    "createdDateTime": "2020-01-29 05:30:39+00:00", 
    "totalCount": 1, 
    "data": [
        {
            "message_id": "1b408138-61bf-46d3-9a1d-f13089dbf0a5:0",
            "recipient": "1202XXXXXXX" 
        }
    ],
    "error": {}
  
}

Error Codes

The below table provides information about the error codes you would receive when executing the WhatsApp Template Message API.