WhatsApp Business: Send list message
Base URL:
POST: https://api.smsgatewayapi.com/v1/whatsapp/send_list
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Developer › API & Webhooks › API credentials | Required |
| client_secret | API client secret | A cs_ credential, shown once when you create it under Developer › API & Webhooks › API credentials | Required |
| message | message | the message to be sent | Partial |
| 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 |
| partner | partner slug | Integration partners only: the slug Smstools gave your integration, for example easyordi. It tells us which messages come through your integration. An unknown value is ignored and reported in a warnings entry | 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' => "32496123456", //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"
}
