Ruby
Ruby
MessageMedia - Send Messages
See more MessageMedia Examples
Submit one or more (up to 100 per request) SMS, MMS, or text to voice messages for delivery.Chilkat Ruby Downloads
require 'chilkat'
success = false
# 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 --request POST \
# --header "Content-Type: application/json" \
# --header "Accept: application/json" \
# --data-binary "{
# \"messages\": [
# {
# \"callback_url\": \"https://my.callback.url.com\",
# \"content\": \"My first message\",
# \"destination_number\": \"+61491570156\",
# \"delivery_report\": true,
# \"format\": \"SMS\",
# \"message_expiry_timestamp\": \"2016-11-03T11:49:02.807Z\",
# \"metadata\": {
# \"myKey\": \"myValue\",
# \"anotherKey\": \"anotherValue\"
# },
# \"scheduled\": \"2016-11-03T11:49:02.807Z\",
# \"source_number\": \"+61491570157\",
# \"source_number_type\": \"INTERNATIONAL\"
# },
# {
# \"callback_url\": \"https://my.callback.url.com\",
# \"content\": \"My second message\",
# \"destination_number\": \"+61491570158\",
# \"delivery_report\": true,
# \"format\": \"MMS\",
# \"subject\": \"This is an MMS message\",
# \"media\": [ \"https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg\" ],
# \"message_expiry_timestamp\": \"2016-11-03T11:49:02.807Z\",
# \"metadata\": {
# \"myKey\": \"myValue\",
# \"anotherKey\": \"anotherValue\"
# },
# \"scheduled\": \"2016-11-03T11:49:02.807Z\",
# \"source_number\": \"+61491570159\",
# \"source_number_type\": \"INTERNATIONAL\"
# }
# ]
# }" \
# https://private-anon-ecbaffbc28-messages32.apiary-mock.com/v1/messages
# 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.
# {
# "messages": [
# {
# "callback_url": "https://my.callback.url.com",
# "content": "My first message",
# "destination_number": "+61491570156",
# "delivery_report": true,
# "format": "SMS",
# "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
# "metadata": {
# "myKey": "myValue",
# "anotherKey": "anotherValue"
# },
# "scheduled": "2016-11-03T11:49:02.807Z",
# "source_number": "+61491570157",
# "source_number_type": "INTERNATIONAL"
# },
# {
# "callback_url": "https://my.callback.url.com",
# "content": "My second message",
# "destination_number": "+61491570158",
# "delivery_report": true,
# "format": "MMS",
# "subject": "This is an MMS message",
# "media": [
# "https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg"
# ],
# "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
# "metadata": {
# "myKey": "myValue",
# "anotherKey": "anotherValue"
# },
# "scheduled": "2016-11-03T11:49:02.807Z",
# "source_number": "+61491570159",
# "source_number_type": "INTERNATIONAL"
# }
# ]
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("messages[0].callback_url","https://my.callback.url.com")
json.UpdateString("messages[0].content","My first message")
json.UpdateString("messages[0].destination_number","+61491570156")
json.UpdateBool("messages[0].delivery_report",true)
json.UpdateString("messages[0].format","SMS")
json.UpdateString("messages[0].message_expiry_timestamp","2016-11-03T11:49:02.807Z")
json.UpdateString("messages[0].metadata.myKey","myValue")
json.UpdateString("messages[0].metadata.anotherKey","anotherValue")
json.UpdateString("messages[0].scheduled","2016-11-03T11:49:02.807Z")
json.UpdateString("messages[0].source_number","+61491570157")
json.UpdateString("messages[0].source_number_type","INTERNATIONAL")
json.UpdateString("messages[1].callback_url","https://my.callback.url.com")
json.UpdateString("messages[1].content","My second message")
json.UpdateString("messages[1].destination_number","+61491570158")
json.UpdateBool("messages[1].delivery_report",true)
json.UpdateString("messages[1].format","MMS")
json.UpdateString("messages[1].subject","This is an MMS message")
json.UpdateString("messages[1].media[0]","https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg")
json.UpdateString("messages[1].message_expiry_timestamp","2016-11-03T11:49:02.807Z")
json.UpdateString("messages[1].metadata.myKey","myValue")
json.UpdateString("messages[1].metadata.anotherKey","anotherValue")
json.UpdateString("messages[1].scheduled","2016-11-03T11:49:02.807Z")
json.UpdateString("messages[1].source_number","+61491570159")
json.UpdateString("messages[1].source_number_type","INTERNATIONAL")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://private-anon-ecbaffbc28-messages32.apiary-mock.com/v1/messages",json,"application/json",resp)
if (success == 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": [
# {
# "message_id": "04fe9a97-a579-43c5-bb1a-58ed29bf0a6a",
# "callback_url": "https://my.url.com",
# "status": "delivered",
# "content": "My first message",
# "destination_number": "+61491570156",
# "delivery_report": true,
# "format": "SMS",
# "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
# "metadata": {
# "myKey": "myValue",
# "anotherKey": "anotherValue"
# },
# "scheduled": "2016-11-03T11:49:02.807Z",
# "source_number": "+61491570157",
# "source_number_type": "INTERNATIONAL"
# }
# ]
# }
# 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)
message_id = jResp.stringOf("messages[i].message_id")
callback_url = jResp.stringOf("messages[i].callback_url")
status = jResp.stringOf("messages[i].status")
content = jResp.stringOf("messages[i].content")
destination_number = jResp.stringOf("messages[i].destination_number")
delivery_report = jResp.BoolOf("messages[i].delivery_report")
format = jResp.stringOf("messages[i].format")
message_expiry_timestamp = jResp.stringOf("messages[i].message_expiry_timestamp")
MyKey = jResp.stringOf("messages[i].metadata.myKey")
AnotherKey = jResp.stringOf("messages[i].metadata.anotherKey")
scheduled = jResp.stringOf("messages[i].scheduled")
source_number = jResp.stringOf("messages[i].source_number")
source_number_type = jResp.stringOf("messages[i].source_number_type")
i = i + 1
end