Xojo / Infobip WhatsApp / Send WhatsApp interactive list message
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// 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": {
// "title": "Choose one",
// "sections": [
// {
// "rows": [
// {
// "id": "1",
// "title": "row1 title"
// },
// {
// "id": "2",
// "title": "row2 title"
// }
// ]
// }
// ]
// }
// },
// "callbackData": "Callback data"
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("from","{{senderNumber}}")
success = json.UpdateString("to","{{receiverNumber}}")
success = json.UpdateString("messageId","test-message-{{$randomInt}}")
success = json.UpdateString("content.body.text","Some text")
success = json.UpdateString("content.action.title","Choose one")
success = json.UpdateString("content.action.sections[0].rows[0].id","1")
success = json.UpdateString("content.action.sections[0].rows[0].title","row1 title")
success = json.UpdateString("content.action.sections[0].rows[1].id","2")
success = json.UpdateString("content.action.sections[0].rows[1].title","row2 title")
success = json.UpdateString("callbackData","Callback data")
http.SetRequestHeader "Authorization","App {{INFOBIP_API_KEY}}"
http.SetRequestHeader "Content-Type","application/json"
Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://domain.com/whatsapp/1/message/interactive/list","application/json",json)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "to": "441134960001",
// "messageCount": 1,
// "messageId": "test-message-686",
// "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
Dim v_to As String
v_to = jResp.StringOf("to")
Dim messageCount As Int32
messageCount = jResp.IntOf("messageCount")
Dim messageId As String
messageId = jResp.StringOf("messageId")
Dim GroupId As Int32
GroupId = jResp.IntOf("status.groupId")
Dim GroupName As String
GroupName = jResp.StringOf("status.groupName")
Dim Id As Int32
Id = jResp.IntOf("status.id")
Dim Name As String
Name = jResp.StringOf("status.name")
Dim Description As String
Description = jResp.StringOf("status.description")
Dim Action As String
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": {
"title": "Choose one",
"sections": [
{
"rows": [
{
"id": "1",
"title": "row1 title"
},
{
"id": "2",
"title": "row2 title"
}
]
}
]
}
},
"callbackData": "Callback data"
}'
https://domain.com/whatsapp/1/message/interactive/list
Postman Collection Item JSON
{
"name": "Send WhatsApp interactive list 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 \"title\": \"Choose one\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"1\",\n \"title\": \"row1 title\"\n },\n {\n \"id\": \"2\",\n \"title\": \"row2 title\"\n }\n ]\n }\n ]\n }\n },\n \"callbackData\": \"Callback data\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/interactive/list",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"interactive",
"list"
]
},
"description": "Send an interactive list message to a single recipient. Interactive list 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 list 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 \"title\": \"Choose one\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"1\",\n \"title\": \"row1 title\"\n },\n {\n \"id\": \"2\",\n \"title\": \"row2 title\"\n }\n ]\n }\n ]\n }\n },\n \"callbackData\": \"Callback data\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/interactive/list",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"interactive",
"list"
]
}
},
"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:48:17 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636364897523954227"
}
],
"cookie": [
],
"body": "{\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-686\",\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 list message with 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 \"title\": \"Choose one\",\n \"sections\": [\n {\n \"title\": \"First section title\",\n \"rows\": [\n {\n \"id\": \"1\",\n \"title\": \"first row title\",\n \"description\": \"first row description\"\n },\n {\n \"id\": \"2\",\n \"title\": \"second row title\",\n \"description\": \"second row description\"\n }\n ]\n },\n {\n \"title\": \"Second section title\",\n \"rows\": [\n {\n \"id\": \"3\",\n \"title\": \"third row title\"\n }\n ]\n }\n ]\n },\n \"header\": {\n \"type\": \"TEXT\",\n \"text\": \"Header\"\n },\n \"footer\": {\n \"text\": \"Footer\"\n }\n },\n \"callbackData\": \"Callback data\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/interactive/list",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"interactive",
"list"
]
}
},
"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:50:40 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636365040207560828"
}
],
"cookie": [
],
"body": "{\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-856\",\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}"
}
]
}
