Send a template API
Send a Template API, Documentation - Template(HSM) Sending API, HSM API, template API, send WhatsApp templateUse this endpoint to send a WhatsApp template (HSM) message to a customer from your own system.
| Method | Endpoint | What it does |
|---|---|---|
| POST | {{domain_name}}/wabiz/send |
Send a template message |
Authentication
Section titled “Authentication”Contact support@businessonbot.com to get your guest API key and URL.
The API documentation is intended to be used as a reference to communicate with BusinessOnBot. BusinessOnBot will be calling the customer’s APIs with the request specified in the documentation and expects responses as mentioned.
For all the APIs, BusinessOnBot will be passing the API KEY with the custom http header ‘x-guest-id’.
Responses
Section titled “Responses”The endpoint returns JSON with a status and a statusCode:
status |
statusCode |
Meaning |
|---|---|---|
success |
200 |
The request worked |
failure |
400 |
Bad payload or bad request. The error field says what went wrong. |
failure |
500 |
Internal server error |
The exact responses are shown below.
Send a template
Section titled “Send a template”Method: POST
URL: {{domain_name}}/wabiz/send
Headers
Section titled “Headers”Basic Auth -x-api-key : stringRequest body (JSON)
Section titled “Request body (JSON)”{ "type": "template", "name": "String", "phone": "String", "language": "en_US", "header": [ { "type": "text", "text": "string" } // OR { "type": "image", "link": "string" // Public URL } // OR { "type": "video", "link": "string" // Public URL } // OR { "type": "document", "link": "string" // Public URL } ], "body": [ { "type": "text", "text": "string" } ], "buttons": [ { "type": "url", "params": ["string"] } ]}Success response
Section titled “Success response”{ "status": "success", "statusCode": 200}Error responses
Section titled “Error responses”{ "status" : "failure", "statusCode": "400", "error": "Bad payload!!" } { "status" : "failure", "statusCode": "500", "error": "Internal Server Error!!" }Was this page helpful?
Thanks, this helps us improve this page.
Still stuck? Email support@businessonbot.com