We use cookies to personalise content and ads, to provide social media features and to analyse our traffic. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you’ve provided to them or that they’ve collected from your use of their services.Learn more about who we are, how you can contact us and how we process personal data in our Privacy Policy.
WhatsApp Business: Send template message
Base URL:
POST: https://api.smsgatewayapi.com/v1/whatsapp/send_template
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| client_secret | API client secret | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| to | destination number | the number that will receive the message | Required |
| sender | sender | The number or name of the sender. A number can't be longer than 14 characters. A name can't be longer than 11 characters and can't contain special characters | Required |
| date | Date and time the message will be sent | Format: yyyy-MM-dd HH:mm. If not provided, the message will be sent as soon as possible | Optional |
| reference | custom reference | String of max. 255 characters | Optional |
| template_name | template name | The name of the template you want to send | Required |
| variable{i} | content for variable | If your template has variables {{1}}, {{2}}, ...; you must define each variable parameter eg: variable1 will fill in {{1}}, variable2 will fill in {{2}}; Replace the {i} in the parameter with the required iteration. | Partial |
| button_variable{i} | content for variable | Only required if your template has dynamic buttons. If your template has button variables {{1}}, {{2}}, ...; you must define each button variable parameter eg: button_variable1 will replace {{1}}, button_variable2 will replace {{2}}; Replace the {i} in the parameter with the required iteration. | Partial |
| image | video | document | image, video or document URL in https. | Only required if your template has a header_type of 'image', 'video' or 'document' | Partial |
| test | true/false | The system will check all parameters but will not send a the message (no credits/balance used). | Optional |
| subid | id of a subaccount | If specified, the message will be sent from the subaccount. | Optional |
<?php //PHP - cURL $ch = curl_init(); $url = "https://api.smsgatewayapi.com/v1/whatsapp/send_template"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'to' => "393123456789", //Receiver (required) 'sender' => "WhatsAppSender" //Sender (required)
'template_name' => "sample_template" //Template name (required)
]; curl_setopt($ch, CURLOPT_URL, "$url"); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_VERBOSE, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-Client-Id: $client_id", "X-Client-Secret: $client_secret", "Content-Type: application/json", ]); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); $response = curl_exec($ch); ?>
Example request:
{
"template_name": "sample_template",
"to": "{nr}",
"date":"2024-10-15 15:30",
"sender": "YourWhatsAppBusinessSenderNumber",
"variable1": {variable1},
"button_variable1": "{button_variable1}"
}
Example response:
{
"messageid": "h2md1ewkyzjkuyn9ak7pryw1evtyw3x"
}