Chilkat Online Tools

DataFlex / Infobip WhatsApp / Send WhatsApp interactive buttons message

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sV_to
    Integer iMessageCount
    String sMessageId
    Integer iGroupId
    String sGroupName
    Integer iId
    String sName
    String sDescription
    String sAction
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // 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": {
    //       "buttons": [
    //         {
    //           "type": "REPLY",
    //           "id": "1",
    //           "title": "Yes"
    //         },
    //         {
    //           "type": "REPLY",
    //           "id": "2",
    //           "title": "No"
    //         }
    //       ]
    //     }
    //   },
    //   "callbackData": "Callback data"
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "from" "{{senderNumber}}" To iSuccess
    Get ComUpdateString Of hoJson "to" "{{receiverNumber}}" To iSuccess
    Get ComUpdateString Of hoJson "messageId" "test-message-{{$randomInt}}" To iSuccess
    Get ComUpdateString Of hoJson "content.body.text" "Some text" To iSuccess
    Get ComUpdateString Of hoJson "content.action.buttons[0].type" "REPLY" To iSuccess
    Get ComUpdateString Of hoJson "content.action.buttons[0].id" "1" To iSuccess
    Get ComUpdateString Of hoJson "content.action.buttons[0].title" "Yes" To iSuccess
    Get ComUpdateString Of hoJson "content.action.buttons[1].type" "REPLY" To iSuccess
    Get ComUpdateString Of hoJson "content.action.buttons[1].id" "2" To iSuccess
    Get ComUpdateString Of hoJson "content.action.buttons[1].title" "No" To iSuccess
    Get ComUpdateString Of hoJson "callbackData" "Callback data" To iSuccess

    Send ComSetRequestHeader To hoHttp "Authorization" "App {{INFOBIP_API_KEY}}"
    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://domain.com/whatsapp/1/message/interactive/buttons" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

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

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

    Get ComStringOf Of hoJResp "to" To sV_to
    Get ComIntOf Of hoJResp "messageCount" To iMessageCount
    Get ComStringOf Of hoJResp "messageId" To sMessageId
    Get ComIntOf Of hoJResp "status.groupId" To iGroupId
    Get ComStringOf Of hoJResp "status.groupName" To sGroupName
    Get ComIntOf Of hoJResp "status.id" To iId
    Get ComStringOf Of hoJResp "status.name" To sName
    Get ComStringOf Of hoJResp "status.description" To sDescription
    Get ComStringOf Of hoJResp "status.action" To sAction


End_Procedure

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": {
            "buttons": [
                {
                    "type": "REPLY",
                    "id": "1",
                    "title": "Yes"
                },
                {
                    "type": "REPLY",
                    "id": "2",
                    "title": "No"
                }
            ]
        }
    },
    "callbackData": "Callback data"
}'
https://domain.com/whatsapp/1/message/interactive/buttons

Postman Collection Item JSON

{
  "name": "Send WhatsApp interactive buttons 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            \"buttons\": [\n                {\n                    \"type\": \"REPLY\",\n                    \"id\": \"1\",\n                    \"title\": \"Yes\"\n                },\n                {\n                    \"type\": \"REPLY\",\n                    \"id\": \"2\",\n                    \"title\": \"No\"\n                }\n            ]\n        }\n    },\n    \"callbackData\": \"Callback data\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "whatsapp",
        "1",
        "message",
        "interactive",
        "buttons"
      ]
    },
    "description": "Send an interactive buttons message to a single recipient. Interactive buttons 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 buttons 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            \"buttons\": [\n                {\n                    \"type\": \"REPLY\",\n                    \"id\": \"1\",\n                    \"title\": \"Yes\"\n                },\n                {\n                    \"type\": \"REPLY\",\n                    \"id\": \"2\",\n                    \"title\": \"No\"\n                }\n            ]\n        }\n    },\n    \"callbackData\": \"Callback data\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "whatsapp",
            "1",
            "message",
            "interactive",
            "buttons"
          ]
        }
      },
      "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:10:32 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Server",
          "value": "SMS API"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "X-Request-Id",
          "value": "1636362632822738225"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"to\": \"441134960001\",\n    \"messageCount\": 1,\n    \"messageId\": \"test-message-290\",\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 buttons message with document 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            \"buttons\": [\n                {\n                    \"type\": \"REPLY\",\n                    \"id\": \"1\",\n                    \"title\": \"Yes\"\n                },\n                {\n                    \"type\": \"REPLY\",\n                    \"id\": \"2\",\n                    \"title\": \"No\"\n                }\n            ]\n        },\n        \"header\": {\n            \"type\": \"DOCUMENT\",\n            \"mediaUrl\": \"{{exampleDocumentPath}}\",\n            \"filename\": \"document.pdf\"\n        },\n        \"footer\": {\n            \"text\": \"Footer\"\n        }\n    },\n    \"callbackData\": \"Callback data\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "whatsapp",
            "1",
            "message",
            "interactive",
            "buttons"
          ]
        }
      },
      "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:46:19 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Server",
          "value": "SMS API"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "X-Request-Id",
          "value": "1636364779407146838"
        }
      ],
      "cookie": [
      ],
      "body": "{\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}"
    }
  ]
}