Ruby

CallRail API - Create an Outbound Phone Call

See more CallRail Examples

Initiates an outbound call from the target account. Ruby

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 -H "Authorization: Token token={api_token}" \
#      -X POST \
#      -H "Content-Type: application/json" \
#      -d '{
#           "caller_id": "+17703334455",
#           "business_phone_number": "+14045556666",
#           "customer_phone_number": "+14044442233",
#           "recording_enabled": true,
#           "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
#           "outbound_greeting_text": "These are not the droids you are looking for."
#          }' \
#          "https://api.callrail.com/v3/a/{account_id}/calls.json"

# 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.

# {
#   "caller_id": "+17703334455",
#   "business_phone_number": "+14045556666",
#   "customer_phone_number": "+14044442233",
#   "recording_enabled": true,
#   "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
#   "outbound_greeting_text": "These are not the droids you are looking for."
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("caller_id","+17703334455")
json.UpdateString("business_phone_number","+14045556666")
json.UpdateString("customer_phone_number","+14044442233")
json.UpdateBool("recording_enabled",true)
json.UpdateString("outbound_greeting_recording_url","http://www.test.com/greeting.mp3")
json.UpdateString("outbound_greeting_text","These are not the droids you are looking for.")

http.SetRequestHeader("Authorization","Token token={api_token}")
http.SetRequestHeader("Content-Type","application/json")

resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://api.callrail.com/v3/a/{account_id}/calls.json",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)

# {
#   "answered": null,
#   "business_phone_number": "+19044567899",
#   "customer_city": "Atlanta",
#   "customer_country": "US",
#   "customer_name": null,
#   "customer_phone_number": "+14703444700",
#   "customer_state": "GA",
#   "direction": "outbound",
#   "duration": null,
#   "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
#   "recording": null,
#   "recording_duration": null,
#   "start_time": "2017-02-22T15:02:24.916-05:00",
#   "tracking_phone_number": "+19044567899",
#   "voicemail": false
# }

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

answered = jResp.stringOf("answered")
business_phone_number = jResp.stringOf("business_phone_number")
customer_city = jResp.stringOf("customer_city")
customer_country = jResp.stringOf("customer_country")
customer_name = jResp.stringOf("customer_name")
customer_phone_number = jResp.stringOf("customer_phone_number")
customer_state = jResp.stringOf("customer_state")
direction = jResp.stringOf("direction")
duration = jResp.stringOf("duration")
id = jResp.stringOf("id")
recording = jResp.stringOf("recording")
recording_duration = jResp.stringOf("recording_duration")
start_time = jResp.stringOf("start_time")
tracking_phone_number = jResp.stringOf("tracking_phone_number")
voicemail = jResp.BoolOf("voicemail")