TCL / Infobip WhatsApp / Send WhatsApp interactive buttons message
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set 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"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "from" "{{senderNumber}}"
CkJsonObject_UpdateString $json "to" "{{receiverNumber}}"
CkJsonObject_UpdateString $json "messageId" "test-message-{{$randomInt}}"
CkJsonObject_UpdateString $json "content.body.text" "Some text"
CkJsonObject_UpdateString $json "content.action.buttons[0].type" "REPLY"
CkJsonObject_UpdateString $json "content.action.buttons[0].id" "1"
CkJsonObject_UpdateString $json "content.action.buttons[0].title" "Yes"
CkJsonObject_UpdateString $json "content.action.buttons[1].type" "REPLY"
CkJsonObject_UpdateString $json "content.action.buttons[1].id" "2"
CkJsonObject_UpdateString $json "content.action.buttons[1].title" "No"
CkJsonObject_UpdateString $json "callbackData" "Callback data"
CkHttp_SetRequestHeader $http "Authorization" "App {{INFOBIP_API_KEY}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/whatsapp/1/message/interactive/buttons" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set v_to [CkJsonObject_stringOf $jResp "to"]
set messageCount [CkJsonObject_IntOf $jResp "messageCount"]
set messageId [CkJsonObject_stringOf $jResp "messageId"]
set GroupId [CkJsonObject_IntOf $jResp "status.groupId"]
set GroupName [CkJsonObject_stringOf $jResp "status.groupName"]
set Id [CkJsonObject_IntOf $jResp "status.id"]
set Name [CkJsonObject_stringOf $jResp "status.name"]
set Description [CkJsonObject_stringOf $jResp "status.description"]
set Action [CkJsonObject_stringOf $jResp "status.action"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
