Chilkat Online Tools

Ruby / Infobip WhatsApp / Send WhatsApp contact message

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": {
#     "contacts": [
#       {
#         "addresses": [
#           {
#             "street": "Istarska",
#             "city": "Vodnjan",
#             "zip": "52215",
#             "country": "Croatia",
#             "countryCode": "HR",
#             "type": "WORK"
#           },
#           {
#             "street": "Istarska",
#             "city": "Vodnjan",
#             "zip": "52215",
#             "country": "Croatia",
#             "countryCode": "HR",
#             "type": "HOME"
#           }
#         ],
#         "birthday": "2010-01-01",
#         "emails": [
#           {
#             "email": "John.Smith@example.com",
#             "type": "WORK"
#           },
#           {
#             "email": "John.Smith.priv@example.com",
#             "type": "HOME"
#           }
#         ],
#         "name": {
#           "firstName": "John",
#           "lastName": "Smith",
#           "middleName": "B",
#           "namePrefix": "Mr.",
#           "formattedName": "Mr. John Smith"
#         },
#         "org": {
#           "company": "Company Name",
#           "department": "Department",
#           "title": "Director"
#         },
#         "phones": [
#           {
#             "phone": "+441134960019",
#             "type": "HOME",
#             "waId": "441134960019"
#           },
#           {
#             "phone": "+441134960000",
#             "type": "WORK",
#             "waId": "441134960000"
#           }
#         ],
#         "urls": [
#           {
#             "url": "http://example.com/John.Smith",
#             "type": "WORK"
#           },
#           {
#             "url": "http://example.com/home/John.Smith",
#             "type": "HOME"
#           }
#         ]
#       }
#     ]
#   },
#   "callbackData": "Callback data"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("from","{{senderNumber}}")
json.UpdateString("to","{{receiverNumber}}")
json.UpdateString("messageId","test-message-{{$randomInt}}")
json.UpdateString("content.contacts[0].addresses[0].street","Istarska")
json.UpdateString("content.contacts[0].addresses[0].city","Vodnjan")
json.UpdateString("content.contacts[0].addresses[0].zip","52215")
json.UpdateString("content.contacts[0].addresses[0].country","Croatia")
json.UpdateString("content.contacts[0].addresses[0].countryCode","HR")
json.UpdateString("content.contacts[0].addresses[0].type","WORK")
json.UpdateString("content.contacts[0].addresses[1].street","Istarska")
json.UpdateString("content.contacts[0].addresses[1].city","Vodnjan")
json.UpdateString("content.contacts[0].addresses[1].zip","52215")
json.UpdateString("content.contacts[0].addresses[1].country","Croatia")
json.UpdateString("content.contacts[0].addresses[1].countryCode","HR")
json.UpdateString("content.contacts[0].addresses[1].type","HOME")
json.UpdateString("content.contacts[0].birthday","2010-01-01")
json.UpdateString("content.contacts[0].emails[0].email","John.Smith@example.com")
json.UpdateString("content.contacts[0].emails[0].type","WORK")
json.UpdateString("content.contacts[0].emails[1].email","John.Smith.priv@example.com")
json.UpdateString("content.contacts[0].emails[1].type","HOME")
json.UpdateString("content.contacts[0].name.firstName","John")
json.UpdateString("content.contacts[0].name.lastName","Smith")
json.UpdateString("content.contacts[0].name.middleName","B")
json.UpdateString("content.contacts[0].name.namePrefix","Mr.")
json.UpdateString("content.contacts[0].name.formattedName","Mr. John Smith")
json.UpdateString("content.contacts[0].org.company","Company Name")
json.UpdateString("content.contacts[0].org.department","Department")
json.UpdateString("content.contacts[0].org.title","Director")
json.UpdateString("content.contacts[0].phones[0].phone","+441134960019")
json.UpdateString("content.contacts[0].phones[0].type","HOME")
json.UpdateString("content.contacts[0].phones[0].waId","441134960019")
json.UpdateString("content.contacts[0].phones[1].phone","+441134960000")
json.UpdateString("content.contacts[0].phones[1].type","WORK")
json.UpdateString("content.contacts[0].phones[1].waId","441134960000")
json.UpdateString("content.contacts[0].urls[0].url","http://example.com/John.Smith")
json.UpdateString("content.contacts[0].urls[0].type","WORK")
json.UpdateString("content.contacts[0].urls[1].url","http://example.com/home/John.Smith")
json.UpdateString("content.contacts[0].urls[1].type","HOME")
json.UpdateString("callbackData","Callback data")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/whatsapp/1/message/contact","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "to": "441134960001",
#   "messageCount": 1,
#   "messageId": "test-message-254",
#   "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 = jResp.stringOf("to")
messageCount = jResp.IntOf("messageCount")
messageId = jResp.stringOf("messageId")
GroupId = jResp.IntOf("status.groupId")
GroupName = jResp.stringOf("status.groupName")
Id = jResp.IntOf("status.id")
Name = jResp.stringOf("status.name")
Description = jResp.stringOf("status.description")
Action = jResp.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": {
        "contacts": [
            {
                "addresses": [
                    {
                        "street": "Istarska",
                        "city": "Vodnjan",
                        "zip": "52215",
                        "country": "Croatia",
                        "countryCode": "HR",
                        "type": "WORK"
                    },
                    {
                        "street": "Istarska",
                        "city": "Vodnjan",
                        "zip": "52215",
                        "country": "Croatia",
                        "countryCode": "HR",
                        "type": "HOME"
                    }
                ],
                "birthday": "2010-01-01",
                "emails": [
                    {
                        "email": "John.Smith@example.com",
                        "type": "WORK"
                    },
                    {
                        "email": "John.Smith.priv@example.com",
                        "type": "HOME"
                    }
                ],
                "name": {
                    "firstName": "John",
                    "lastName": "Smith",
                    "middleName": "B",
                    "namePrefix": "Mr.",
                    "formattedName": "Mr. John Smith"
                },
                "org": {
                    "company": "Company Name",
                    "department": "Department",
                    "title": "Director"
                },
                "phones": [
                    {
                        "phone": "+441134960019",
                        "type": "HOME",
                        "waId": "441134960019"
                    },
                    {
                        "phone": "+441134960000",
                        "type": "WORK",
                        "waId": "441134960000"
                    }
                ],
                "urls": [
                    {
                        "url": "http://example.com/John.Smith",
                        "type": "WORK"
                    },
                    {
                        "url": "http://example.com/home/John.Smith",
                        "type": "HOME"
                    }
                ]
            }
        ]
    },
    "callbackData": "Callback data"
}'
https://domain.com/whatsapp/1/message/contact

Postman Collection Item JSON

{
  "name": "Send WhatsApp contact 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        \"contacts\": [\n            {\n                \"addresses\": [\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"birthday\": \"2010-01-01\",\n                \"emails\": [\n                    {\n                        \"email\": \"John.Smith@example.com\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"email\": \"John.Smith.priv@example.com\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"name\": {\n                    \"firstName\": \"John\",\n                    \"lastName\": \"Smith\",\n                    \"middleName\": \"B\",\n                    \"namePrefix\": \"Mr.\",\n                    \"formattedName\": \"Mr. John Smith\"\n                },\n                \"org\": {\n                    \"company\": \"Company Name\",\n                    \"department\": \"Department\",\n                    \"title\": \"Director\"\n                },\n                \"phones\": [\n                    {\n                        \"phone\": \"+441134960019\",\n                        \"type\": \"HOME\",\n                        \"waId\": \"441134960019\"\n                    },\n                    {\n                        \"phone\": \"+441134960000\",\n                        \"type\": \"WORK\",\n                        \"waId\": \"441134960000\"\n                    }\n                ],\n                \"urls\": [\n                    {\n                        \"url\": \"http://example.com/John.Smith\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"url\": \"http://example.com/home/John.Smith\",\n                        \"type\": \"HOME\"\n                    }\n                ]\n            }\n        ]\n    },\n    \"callbackData\": \"Callback data\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/whatsapp/1/message/contact",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "whatsapp",
        "1",
        "message",
        "contact"
      ]
    },
    "description": "Send a contact to a single recipient. Contact 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": "Single contact message",
      "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        \"contacts\": [\n            {\n                \"addresses\": [\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"birthday\": \"2010-01-01\",\n                \"emails\": [\n                    {\n                        \"email\": \"John.Smith@example.com\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"email\": \"John.Smith.priv@example.com\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"name\": {\n                    \"firstName\": \"John\",\n                    \"lastName\": \"Smith\",\n                    \"middleName\": \"B\",\n                    \"namePrefix\": \"Mr.\",\n                    \"formattedName\": \"Mr. John Smith\"\n                },\n                \"org\": {\n                    \"company\": \"Company Name\",\n                    \"department\": \"Department\",\n                    \"title\": \"Director\"\n                },\n                \"phones\": [\n                    {\n                        \"phone\": \"+441134960019\",\n                        \"type\": \"HOME\",\n                        \"waId\": \"441134960019\"\n                    },\n                    {\n                        \"phone\": \"+441134960000\",\n                        \"type\": \"WORK\",\n                        \"waId\": \"441134960000\"\n                    }\n                ],\n                \"urls\": [\n                    {\n                        \"url\": \"http://example.com/John.Smith\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"url\": \"http://example.com/home/John.Smith\",\n                        \"type\": \"HOME\"\n                    }\n                ]\n            }\n        ]\n    },\n    \"callbackData\": \"Callback data\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/whatsapp/1/message/contact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "whatsapp",
            "1",
            "message",
            "contact"
          ]
        }
      },
      "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:04:58 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Server",
          "value": "SMS API"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "X-Request-Id",
          "value": "1636362298092064666"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"to\": \"441134960001\",\n    \"messageCount\": 1,\n    \"messageId\": \"test-message-254\",\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": "Multiple contacts message",
      "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        \"contacts\": [\n            {\n                \"addresses\": [\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"birthday\": \"2010-01-01\",\n                \"emails\": [\n                    {\n                        \"email\": \"John.Smith@example.com\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"email\": \"John.Smith.priv@example.com\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"name\": {\n                    \"firstName\": \"John\",\n                    \"lastName\": \"Smith\",\n                    \"middleName\": \"B\",\n                    \"namePrefix\": \"Mr.\",\n                    \"formattedName\": \"Mr. John Smith\"\n                },\n                \"org\": {\n                    \"company\": \"Company Name\",\n                    \"department\": \"Department\",\n                    \"title\": \"Director\"\n                },\n                \"phones\": [\n                    {\n                        \"phone\": \"+441134960019\",\n                        \"type\": \"HOME\",\n                        \"waId\": \"441134960019\"\n                    },\n                    {\n                        \"phone\": \"+441134960000\",\n                        \"type\": \"WORK\",\n                        \"waId\": \"441134960000\"\n                    }\n                ],\n                \"urls\": [\n                    {\n                        \"url\": \"http://example.com/John.Smith\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"url\": \"http://example.com/home/John.Smith\",\n                        \"type\": \"HOME\"\n                    }\n                ]\n            },\n            {\n                \"addresses\": [\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"street\": \"Istarska\",\n                        \"city\": \"Vodnjan\",\n                        \"zip\": \"52215\",\n                        \"country\": \"Croatia\",\n                        \"countryCode\": \"HR\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"birthday\": \"2010-01-01\",\n                \"emails\": [\n                    {\n                        \"email\": \"Alexander.Abraham@example.com\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"email\": \"Alexander.Abraham.priv@example.com\",\n                        \"type\": \"HOME\"\n                    }\n                ],\n                \"name\": {\n                    \"firstName\": \"Alexander\",\n                    \"lastName\": \"Abraham\",\n                    \"middleName\": \"B\",\n                    \"namePrefix\": \"Mr.\",\n                    \"formattedName\": \"Mr. Alexander Abraham\"\n                },\n                \"org\": {\n                    \"company\": \"Company Name\",\n                    \"department\": \"Department\",\n                    \"title\": \"Director\"\n                },\n                \"phones\": [\n                    {\n                        \"phone\": \"+441134960010\",\n                        \"type\": \"HOME\",\n                        \"waId\": \"441134960010\"\n                    },\n                    {\n                        \"phone\": \"+441134960011\",\n                        \"type\": \"WORK\",\n                        \"waId\": \"441134960011\"\n                    }\n                ],\n                \"urls\": [\n                    {\n                        \"url\": \"http://example.com/Alexander.Abraham\",\n                        \"type\": \"WORK\"\n                    },\n                    {\n                        \"url\": \"http://example.com/home/Alexander.Abraham\",\n                        \"type\": \"HOME\"\n                    }\n                ]\n            }\n        ]\n    },\n    \"callbackData\": \"Callback data\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/whatsapp/1/message/contact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "whatsapp",
            "1",
            "message",
            "contact"
          ]
        }
      },
      "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:06:55 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Server",
          "value": "SMS API"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "X-Request-Id",
          "value": "1636362415245731828"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"to\": \"441134960001\",\n    \"messageCount\": 1,\n    \"messageId\": \"test-message-296\",\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}"
    }
  ]
}