Chilkat Online Tools

.NET Core C# / Infobip WhatsApp / Send WhatsApp template message

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("messages[0].from","{{senderNumber}}");
json.UpdateString("messages[0].to","{{receiverNumber}}");
json.UpdateString("messages[0].messageId","test-message-{{$randomInt}}");
json.UpdateString("messages[0].content.templateName","boarding_pass");
json.UpdateString("messages[0].content.templateData.body.placeholders[0]","123456789");
json.UpdateString("messages[0].content.templateData.header.type","IMAGE");
json.UpdateString("messages[0].content.templateData.header.mediaUrl","{{exampleImagePath}}");
json.UpdateString("messages[0].content.language","en");
json.UpdateString("messages[0].callbackData","Callback data");

http.SetRequestHeader("Authorization","App {{INFOBIP_API_KEY}}");
http.SetRequestHeader("Content-Type","application/json");

Chilkat.HttpResponse resp = http.PostJson3("https://domain.com/whatsapp/1/message/template","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

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

string v_to;
int messageCount;
string messageId;
int GroupId;
string GroupName;
int Id;
string Name;
string Description;
string Action;

string bulkId = jResp.StringOf("bulkId");
int i = 0;
int count_i = jResp.SizeOfArray("messages");
while (i < count_i) {
    jResp.I = i;
    v_to = jResp.StringOf("messages[i].to");
    messageCount = jResp.IntOf("messages[i].messageCount");
    messageId = jResp.StringOf("messages[i].messageId");
    GroupId = jResp.IntOf("messages[i].status.groupId");
    GroupName = jResp.StringOf("messages[i].status.groupName");
    Id = jResp.IntOf("messages[i].status.id");
    Name = jResp.StringOf("messages[i].status.name");
    Description = jResp.StringOf("messages[i].status.description");
    Action = jResp.StringOf("messages[i].status.action");
    i = i + 1;
}

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