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 list message
Base URL:
POST: https://api.smsgatewayapi.com/v1/whatsapp/send_list
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 |
list | array of list items | Provide an array of objects, where each object includes a title and an associated array of actions. | 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 |
button_text | button text | The text displayed on the button. Upon clicking this button, the list will become visible in WhatsApp. | Required |
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_list"; $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)
"list" => [ //List (required) [ "title" => "detitel", "actions" => [ [ "id" => "rateid1", "title" => "⭐️", "description" => "Experience wasn't good enough" ], [ "id" => "rateid2", "title" => "⭐⭐️", "description" => "Experience could be better" ], [ "id" => "rateid3", "title" => "⭐⭐⭐️", "description" => "Experience was ok" ], [ "id" => "rateid4", "title" => "⭐⭐⭐️⭐️", "description" => "Experience was good" ], [ "id" => "rateid5", "title" => "⭐⭐⭐️⭐️⭐️", "description" => "Experience was excellent" ] ] ] ], "footer" => "www.smstools.com", "header" => "Smstools WhatsApp", "button_text" => "Rate us"
]; 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", "list": [ { "title": "detitel", "actions": [ { "id": "rateid1", "title": "⭐️", "description": "Experience wasn't good enough" }, { "id": "rateid2", "title": "⭐⭐️", "description": "Experience could be better" }, { "id": "rateid3", "title": "⭐⭐⭐️", "description": "Experience was ok" }, { "id": "rateid4", "title": "⭐⭐⭐️⭐️", "description": "Experience was good" }, { "id": "rateid5", "title": "⭐⭐⭐️⭐️⭐️", "description": "Experience was excellent" } ] } ], "footer": "www.smstools.com", "header": "Smstools WhatsApp", "button_text": "Rate us" }
Example response:
{ "messageid": "h2md1ewkyzjkuyn9ak7pryw1evtyw3x" }