(Ruby) WhatsApp - Send a Linked Media Message

Demonstrates how to send a media message where the media content is a link to an external URL. This example demonstrates sending an image (JPG) media message.

For more information, see https://developers.facebook.com/docs/whatsapp/api/messages/media

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl -X POST https://example.com/v1/messages \
#   -H "Authorization: Bearer your-auth-token" \
#   -d '
# {
#     "recipient_type": "individual-or-group",
#     "to": "whatsapp-id-or-group-id",
#     "type": "image",
#     "image": {
#       "link": "http(s)://the-url",
#       "provider": {
#         "name" : "provider-name"
#       },
#     "caption": "your-image-caption"
#   }
# }'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "recipient_type": "individual-or-group",
#   "to": "whatsapp-id-or-group-id",
#   "type": "image",
#   "image": {
#     "link": "http(s)://the-url",
#     "provider": {
#       "name": "provider-name"
#     },
#     "caption": "your-image-caption"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("recipient_type","individual-or-group")
json.UpdateString("to","whatsapp-id-or-group-id")
json.UpdateString("type","image")
json.UpdateString("image.link","http(s)://the-url")
json.UpdateString("image.provider.name","provider-name")
json.UpdateString("image.caption","your-image-caption")

# Adds the "Authorization: Bearer your-auth-token" header.
http.put_AuthToken("your-auth-token")

# resp is a CkHttpResponse
resp = http.PostJson3("https://example.com/v1/messages","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)

# {
#   "messages": [
#     {
#       "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

i = 0
count_i = jResp.SizeOfArray("messages")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("messages[i].id")
    i = i + 1
end