Chilkat Online Tools

delphiDll / Infobip WhatsApp / Send WhatsApp document message

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_to: PWideChar;
messageCount: Integer;
messageId: PWideChar;
GroupId: Integer;
GroupName: PWideChar;
Id: Integer;
Name: PWideChar;
Description: PWideChar;
Action: PWideChar;

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

http := CkHttp_Create();

// 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"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'from','{{senderNumber}}');
CkJsonObject_UpdateString(json,'to','{{receiverNumber}}');
CkJsonObject_UpdateString(json,'messageId','test-message-{{$randomInt}}');
CkJsonObject_UpdateString(json,'content.mediaUrl','{{exampleDocumentPath}}');
CkJsonObject_UpdateString(json,'callbackData','Callback data');

CkHttp_SetRequestHeader(http,'Authorization','App {{INFOBIP_API_KEY}}');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

resp := CkHttp_PostJson3(http,'https://domain.com/whatsapp/1/message/document','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// 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

v_to := CkJsonObject__stringOf(jResp,'to');
messageCount := CkJsonObject_IntOf(jResp,'messageCount');
messageId := CkJsonObject__stringOf(jResp,'messageId');
GroupId := CkJsonObject_IntOf(jResp,'status.groupId');
GroupName := CkJsonObject__stringOf(jResp,'status.groupName');
Id := CkJsonObject_IntOf(jResp,'status.id');
Name := CkJsonObject__stringOf(jResp,'status.name');
Description := CkJsonObject__stringOf(jResp,'status.description');
Action := CkJsonObject__stringOf(jResp,'status.action');

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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": {
        "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}"
    }
  ]
}