Send Transactional WhatsApp Template Message

Overview

Transactional WhatsApp API enables you to send targeted transactional WhatsApp messages to your users. You can trigger these WhatsApp messages once a user takes a specific action on your platform.

Endpoint and Headers

POST https://whatsapp.useinsider.com/v1/send

Headers

Body Parameters

Sample Example

Sample Request

curl --location 'https://whatsapp.useinsider.com/v1/send' \
--header 'Content-Type: application/json' \
--header 'x-ins-auth-key: INS.1a2b3c4d5e6f' \
--data '{
    "messages": [
        {
            "phoneNumber": "+1**********",
            "message": {
                "type": "template",
                "template": {
                    "name": "{{TEMPLATE_NAME}}",
                    "language": {
                        "code": "{{TEMPLATE_LANGUAGE_CODE}}"
                    },
                    "components": [
                        {
                            "type": "body",
                            "parameters": [
                                {
                                    "type": "text",
                                    "text": "{{PARAMETER_VALUE}}"
                                }
                            ]
                        },
                        {
                            "type": "button",
                            "sub_type": "quick_reply",
                            "index": "0",
                            "parameters": [
                                {
                                    "type": "payload",
                                    "payload": "1"
                                }
                            ]
                        },
                        {
                            "type": "button",
                            "sub_type": "quick_reply",
                            "index": "1",
                            "parameters": [
                                {
                                    "type": "payload",
                                    "payload": "2"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    ]
}'

Sample Responses

One key information will be returned for each message to be sent. This key will be added to all events related to the message.

{
    "keys": [
        "whatsapp-*************************"
    ]
}

401 Unauthorized

If you use the wrong key, you will see the following error.

{
    "message": "unauthorized"
}

Limitations

• All functions must be executed with a simple HTTPS POST request.
• Only new WhatsApp messages can be sent via this API. No data can be retrieved.
• The API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
• Transactional API cannot be used for sending bulk/promotional WhatsApp messages. It is designed only to set transactional WhatsApp messages.
• The rate limit is 10 requests per second.