WhatsApp Business: Send action message
Base URL:
POST: https://api.smsgatewayapi.com/v1/whatsapp/send_action
| 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 |
| message | message | the message to be sent | Required |
| to | destination number | the number(s) that will receive the message in international format (eg: 324xx, 316xx, ...) | 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 |
| buttons | array of button items | Provide an array of objects, where each object contains an id and a title. Both id and title are required fields. Please note: Min amount buttons: 1, Max amount buttons: 3 | Required |
| header | header message | The header of the message displayed in WhatsApp. | Optional |
| footer | footer message | The footer of the message displayed in WhatsApp | Optional |
| 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_action"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'to' => "551234567890", //Receiver (required) 'sender' => "WhatsAppSender" //Sender (required)
'message' => "Hello World", //Message (required)
'buttons' => [ //Buttons (required) [ "id" => "button_1", "title" => "Yes" ], [ "id" => "button_2", "title" => "No" ], ]
]; 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:
{
"message": "Hello world",
"to": "{nr}",
"date":"2024-10-15 15:30",
"sender": "YourWhatsAppBusinessSenderNumber",
"buttons": [
{
"id": "button_1",
"title": "Yes"
},
{
"id": "button_2",
"title": "No"
},
],
"footer": "www.smstools.com",
"header": "Smstools WhatsApp",
}
Example response:
{
"messageid": "h2md1ewkyzjkuyn9ak7pryw1evtyw3x"
}
