phpExt / Infobip WhatsApp / Send WhatsApp interactive buttons message
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "from": "{{senderNumber}}",
// "to": "{{receiverNumber}}",
// "messageId": "test-message-{{$randomInt}}",
// "content": {
// "body": {
// "text": "Some text"
// },
// "action": {
// "buttons": [
// {
// "type": "REPLY",
// "id": "1",
// "title": "Yes"
// },
// {
// "type": "REPLY",
// "id": "2",
// "title": "No"
// }
// ]
// }
// },
// "callbackData": "Callback data"
// }
$json = new CkJsonObject();
$json->UpdateString('from','{{senderNumber}}');
$json->UpdateString('to','{{receiverNumber}}');
$json->UpdateString('messageId','test-message-{{$randomInt}}');
$json->UpdateString('content.body.text','Some text');
$json->UpdateString('content.action.buttons[0].type','REPLY');
$json->UpdateString('content.action.buttons[0].id','1');
$json->UpdateString('content.action.buttons[0].title','Yes');
$json->UpdateString('content.action.buttons[1].type','REPLY');
$json->UpdateString('content.action.buttons[1].id','2');
$json->UpdateString('content.action.buttons[1].title','No');
$json->UpdateString('callbackData','Callback data');
$http->SetRequestHeader('Authorization','App {{INFOBIP_API_KEY}}');
$http->SetRequestHeader('Content-Type','application/json');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/whatsapp/1/message/interactive/buttons','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "to": "441134960001",
// "messageCount": 1,
// "messageId": "test-message-290",
// "status": {
// "groupId": 1,
// "groupName": "PENDING",
// "id": 7,
// "name": "PENDING_ENROUTE",
// "description": "Message sent to next instance",
// "action": null
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$v_to = $jResp->stringOf('to');
$messageCount = $jResp->IntOf('messageCount');
$messageId = $jResp->stringOf('messageId');
$GroupId = $jResp->IntOf('status.groupId');
$GroupName = $jResp->stringOf('status.groupName');
$Id = $jResp->IntOf('status.id');
$Name = $jResp->stringOf('status.name');
$Description = $jResp->stringOf('status.description');
$Action = $jResp->stringOf('status.action');
?>
Curl Command
curl -X POST
-H "Authorization: App {{INFOBIP_API_KEY}}"
-H "Content-Type: application/json"
-d '{
"from": "{{senderNumber}}",
"to": "{{receiverNumber}}",
"messageId": "test-message-{{$randomInt}}",
"content": {
"body": {
"text": "Some text"
},
"action": {
"buttons": [
{
"type": "REPLY",
"id": "1",
"title": "Yes"
},
{
"type": "REPLY",
"id": "2",
"title": "No"
}
]
}
},
"callbackData": "Callback data"
}'
https://domain.com/whatsapp/1/message/interactive/buttons
Postman Collection Item JSON
{
"name": "Send WhatsApp interactive buttons message",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Message sent successfully\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.status.description).to.eql(\"Message sent to next instance\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"body\": {\n \"text\": \"Some text\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"REPLY\",\n \"id\": \"1\",\n \"title\": \"Yes\"\n },\n {\n \"type\": \"REPLY\",\n \"id\": \"2\",\n \"title\": \"No\"\n }\n ]\n }\n },\n \"callbackData\": \"Callback data\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"interactive",
"buttons"
]
},
"description": "Send an interactive buttons message to a single recipient. Interactive buttons messages can only be successfully delivered, if the recipient has contacted the business within the last 24 hours, otherwise template message should be used."
},
"response": [
{
"name": "Interactive buttons message simple",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"body\": {\n \"text\": \"Some text\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"REPLY\",\n \"id\": \"1\",\n \"title\": \"Yes\"\n },\n {\n \"type\": \"REPLY\",\n \"id\": \"2\",\n \"title\": \"No\"\n }\n ]\n }\n },\n \"callbackData\": \"Callback data\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"interactive",
"buttons"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 09:10:32 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636362632822738225"
}
],
"cookie": [
],
"body": "{\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-290\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\",\n \"action\": null\n }\n}"
},
{
"name": "Interactive buttons message with document header",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"body\": {\n \"text\": \"Some text\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"REPLY\",\n \"id\": \"1\",\n \"title\": \"Yes\"\n },\n {\n \"type\": \"REPLY\",\n \"id\": \"2\",\n \"title\": \"No\"\n }\n ]\n },\n \"header\": {\n \"type\": \"DOCUMENT\",\n \"mediaUrl\": \"{{exampleDocumentPath}}\",\n \"filename\": \"document.pdf\"\n },\n \"footer\": {\n \"text\": \"Footer\"\n }\n },\n \"callbackData\": \"Callback data\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"interactive",
"buttons"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 09:46:19 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636364779407146838"
}
],
"cookie": [
],
"body": "{\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-448\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\",\n \"action\": null\n }\n}"
}
]
}
