TCL / Infobip WhatsApp / Send WhatsApp template 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.
# {
# "messages": [
# {
# "from": "{{senderNumber}}",
# "to": "{{receiverNumber}}",
# "messageId": "test-message-{{$randomInt}}",
# "content": {
# "templateName": "boarding_pass",
# "templateData": {
# "body": {
# "placeholders": [
# "123456789"
# ]
# },
# "header": {
# "type": "IMAGE",
# "mediaUrl": "{{exampleImagePath}}"
# }
# },
# "language": "en"
# },
# "callbackData": "Callback data"
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "messages[0].from" "{{senderNumber}}"
CkJsonObject_UpdateString $json "messages[0].to" "{{receiverNumber}}"
CkJsonObject_UpdateString $json "messages[0].messageId" "test-message-{{$randomInt}}"
CkJsonObject_UpdateString $json "messages[0].content.templateName" "boarding_pass"
CkJsonObject_UpdateString $json "messages[0].content.templateData.body.placeholders[0]" "123456789"
CkJsonObject_UpdateString $json "messages[0].content.templateData.header.type" "IMAGE"
CkJsonObject_UpdateString $json "messages[0].content.templateData.header.mediaUrl" "{{exampleImagePath}}"
CkJsonObject_UpdateString $json "messages[0].content.language" "en"
CkJsonObject_UpdateString $json "messages[0].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/template" "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)
# {
# "messages": [
# {
# "to": "441134960001",
# "messageCount": 1,
# "messageId": "test-message-448",
# "status": {
# "groupId": 1,
# "groupName": "PENDING",
# "id": 7,
# "name": "PENDING_ENROUTE",
# "description": "Message sent to next instance",
# "action": null
# }
# }
# ],
# "bulkId": null
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set bulkId [CkJsonObject_stringOf $jResp "bulkId"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "messages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_to [CkJsonObject_stringOf $jResp "messages[i].to"]
set messageCount [CkJsonObject_IntOf $jResp "messages[i].messageCount"]
set messageId [CkJsonObject_stringOf $jResp "messages[i].messageId"]
set GroupId [CkJsonObject_IntOf $jResp "messages[i].status.groupId"]
set GroupName [CkJsonObject_stringOf $jResp "messages[i].status.groupName"]
set Id [CkJsonObject_IntOf $jResp "messages[i].status.id"]
set Name [CkJsonObject_stringOf $jResp "messages[i].status.name"]
set Description [CkJsonObject_stringOf $jResp "messages[i].status.description"]
set Action [CkJsonObject_stringOf $jResp "messages[i].status.action"]
set i [expr $i + 1]
}
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 '{
"messages": [
{
"from": "{{senderNumber}}",
"to": "{{receiverNumber}}",
"messageId": "test-message-{{$randomInt}}",
"content": {
"templateName": "boarding_pass",
"templateData": {
"body": {
"placeholders": [
"123456789"
]
},
"header": {
"type": "IMAGE",
"mediaUrl": "{{exampleImagePath}}"
}
},
"language": "en"
},
"callbackData": "Callback data"
}
]
}'
https://domain.com/whatsapp/1/message/template
Postman Collection Item JSON
{
"name": "Send WhatsApp template 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.messages[0].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 \"messages\": [\n {\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"templateName\": \"boarding_pass\",\n \"templateData\": {\n \"body\": {\n \"placeholders\": [\n \"123456789\"\n ]\n },\n \"header\": {\n \"type\": \"IMAGE\",\n \"mediaUrl\": \"{{exampleImagePath}}\"\n }\n },\n \"language\": \"en\"\n },\n \"callbackData\": \"Callback data\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/template",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"template"
]
},
"description": "Send a single or multiple template messages to a one or more recipients. Template messages can be sent and delivered at anytime. Each template sent needs to be registered and pre-approved by WhatsApp."
},
"response": [
{
"name": "Template message \"boarding_pass\"",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"messages\": [\n {\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"templateName\": \"boarding_pass\",\n \"templateData\": {\n \"body\": {\n \"placeholders\": [\n \"123456789\"\n ]\n },\n \"header\": {\n \"type\": \"IMAGE\",\n \"mediaUrl\": \"{{exampleImagePath}}\"\n }\n },\n \"language\": \"en\"\n },\n \"callbackData\": \"Callback data\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/template",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"template"
]
}
},
"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:53:31 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636365211773062836"
}
],
"cookie": [
],
"body": "{\n \"messages\": [\n {\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 }\n ],\n \"bulkId\": null\n}"
},
{
"name": "Template message \"invoice\"",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"messages\": [\n {\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"templateName\": \"invoice\",\n \"templateData\": {\n \"body\": {\n \"placeholders\": [\n \"User\",\n \"123456789\"\n ]\n },\n \"header\": {\n \"type\": \"DOCUMENT\",\n \"mediaUrl\": \"{{exampleDocumentPath}}\",\n \"filename\": \"ExampleDocumet.pdf\"\n }\n },\n \"language\": \"en\"\n },\n \"callbackData\": \"Callback data\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/template",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"template"
]
}
},
"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 10:08:28 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636366108642122837"
}
],
"cookie": [
],
"body": "{\n \"messages\": [\n {\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-285\",\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 }\n ],\n \"bulkId\": null\n}"
}
]
}
