Send Template Message

Send WhatsApp Template Message

POST https://api.oneroute.io/api/public/conversation/template

Template messages can be delivered at any time. Each template needs to be registered and pre-approved by WhatsApp

Headers

Name	Type	Description
apiKey	string	API Key for authentication.

Request Body

Name	Type	Description
messages.*.save	boolean	To save the message as a conversation on OneRoute or not.
messages.*.template	object	The template object
messages	array	An array of messages to send
from	string
messages.*.to	string	Whatsapp number to send template message to.
messages.*.template.name	string	the template name
messages.*.metadata	object	Pass custom data to the metadata

200

{
    "data": [
        {
            "status": "success",
            "response": "gBGHI0kFNWAgTwIJk-_rr1Kse2yO"
        }
    ],
    "message": "Message sent to customer",
    "success": true
}

400

401

Example Request Payload

{
    "messages": [
        {
            "template": {
                "name": "first_welcome_messsage",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Michael"
                    }
                ] // leave the array empty if no placeholders in the template
            },
            "metadata": {
                "userId": "..."
            }, // custom properties
            "to": "234XXXXXXXX",
            "save": true
        },
                {
            "template": {
                "name": "new_conversation",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Timothy"
                    }
                ] // leave the array empty if no placeholders in the template
            },
            "metadata": {
                "location": "..."
            }, // custom properties
            "to": "234XXXXXXXX",
            "save": true
        }
    ],
    "from": "234XXXXXXXX"
}

Example Request Payload (Authentication Template)

{
    "messages": [
        {
            "template": {
                "name": "first_welcome_messsage",
                "parameters": [
                    {
                        "type": "text",
                        "text": "OTP CODE"
                    }
                ],
                "buttons": [
                    {
                        "type": "text",
                        "text": "OTP CODE"
                    }
                ]
            },
            "metadata": {
                "userId": "..."
            }, // custom properties
            "to": "234XXXXXXXX",
            "save": true
        }
    ],
    "from": "234XXXXXXXX"
}