Ruby

CallRail API - Retrieving a Single Call

See more CallRail Examples

Returns a single call object associated with 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 GET \
#      "https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json?fields=keywords_spotted"

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

http.SetRequestHeader("Authorization","Token token={api_token}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json?fields=keywords_spotted",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

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

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

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "answered": false,
#   "business_phone_number": null,
#   "customer_city": "New York City",
#   "customer_country": "US",
#   "customer_name": "Jimmy Pesto, Sr.",
#   "customer_phone_number": "+13036231131",
#   "customer_state": "NY",
#   "direction": "inbound",
#   "duration": 4,
#   "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
#   "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
#   "recording_duration": "27",
#   "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91eb7f7cc08a4d01ed",
#   "start_time": "2017-01-24T11:27:48.119-05:00",
#   "tracking_phone_number": "+13038163491",
#   "voicemail": false,
#   "agent_email": "gil@televised.com",
#   "keywords_spotted": [
#     {
#       "keyword": "test phrase one",
#       "locations": [
#         {
#           "speaker": "caller",
#           "start": 7.71
#         },
#         {
#           "speaker": "agent",
#           "start": 13.38
#         },
#         {
#           "speaker": "caller",
#           "start": 17.96
#         }
#       ]
#     },
#     {
#       "keyword": "test phrase two",
#       "locations": [
#         {
#           "speaker": "caller",
#           "start": 8.44
#         }
#       ]
#     }
#   ]
# }

# 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.BoolOf("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.IntOf("duration")
id = jResp.stringOf("id")
recording = jResp.stringOf("recording")
recording_duration = jResp.stringOf("recording_duration")
recording_player = jResp.stringOf("recording_player")
start_time = jResp.stringOf("start_time")
tracking_phone_number = jResp.stringOf("tracking_phone_number")
voicemail = jResp.BoolOf("voicemail")
agent_email = jResp.stringOf("agent_email")
i = 0
count_i = jResp.SizeOfArray("keywords_spotted")
while i < count_i
    jResp.put_I(i)
    keyword = jResp.stringOf("keywords_spotted[i].keyword")
    j = 0
    count_j = jResp.SizeOfArray("keywords_spotted[i].locations")
    while j < count_j
        jResp.put_J(j)
        speaker = jResp.stringOf("keywords_spotted[i].locations[j].speaker")
        start = jResp.stringOf("keywords_spotted[i].locations[j].start")
        j = j + 1
    end
    i = i + 1
end