Chilkat Online Tools

autoit / Infobip WhatsApp / Send WhatsApp document message

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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": {
;     "mediaUrl": "{{exampleDocumentPath}}"
;   },
;   "callbackData": "Callback data"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("from","{{senderNumber}}")
$oJson.UpdateString("to","{{receiverNumber}}")
$oJson.UpdateString("messageId","test-message-{{$randomInt}}")
$oJson.UpdateString("content.mediaUrl","{{exampleDocumentPath}}")
$oJson.UpdateString("callbackData","Callback data")

$oHttp.SetRequestHeader "Authorization","App {{INFOBIP_API_KEY}}"
$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.PostJson3("https://domain.com/whatsapp/1/message/document","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "to": "441134960001",
;   "messageCount": 1,
;   "messageId": "test-message-726",
;   "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

Local $sV_to = $oJResp.StringOf("to")
Local $iMessageCount = $oJResp.IntOf("messageCount")
Local $sMessageId = $oJResp.StringOf("messageId")
Local $iGroupId = $oJResp.IntOf("status.groupId")
Local $sGroupName = $oJResp.StringOf("status.groupName")
Local $iId = $oJResp.IntOf("status.id")
Local $sName = $oJResp.StringOf("status.name")
Local $sDescription = $oJResp.StringOf("status.description")
Local $sAction = $oJResp.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": {
        "mediaUrl": "{{exampleDocumentPath}}"
    },
    "callbackData": "Callback data"
}'
https://domain.com/whatsapp/1/message/document

Postman Collection Item JSON

{
  "name": "Send WhatsApp document 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        \"mediaUrl\": \"{{exampleDocumentPath}}\"\n    },\n    \"callbackData\": \"Callback data\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/whatsapp/1/message/document",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "whatsapp",
        "1",
        "message",
        "document"
      ]
    },
    "description": "Send a document to a single recipient. Document 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": "Document 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        \"mediaUrl\": \"{{exampleDocumentPath}}\"\n    },\n    \"callbackData\": \"Callback data\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/whatsapp/1/message/document",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "whatsapp",
            "1",
            "message",
            "document"
          ]
        }
      },
      "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": "Sun, 07 Nov 2021 21:45:37 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Server",
          "value": "SMS API"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "X-Request-Id",
          "value": "1636321537250004225"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"to\": \"441134960001\",\n    \"messageCount\": 1,\n    \"messageId\": \"test-message-726\",\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": "Document message with all fields",
      "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        \"mediaUrl\": \"{{exampleDocumentPath}}\",\n        \"caption\": \"Example document caption\",\n        \"filename\": \"Example.pdf\"\n    },\n    \"callbackData\": \"Callback data\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/whatsapp/1/message/document",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "whatsapp",
            "1",
            "message",
            "document"
          ]
        }
      },
      "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": "Sun, 07 Nov 2021 21:47:07 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Server",
          "value": "SMS API"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "X-Request-Id",
          "value": "1636321627810888828"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"to\": \"441134960001\",\n    \"messageCount\": 1,\n    \"messageId\": \"test-message-759\",\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}"
    }
  ]
}