Tcl

CallRail API - Retrieving a Single Call

See more CallRail Examples

Returns a single call object associated with the target account. Tcl

load ./chilkat.dll

set success 0

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

set http [new_CkHttp]

# 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

CkHttp_SetRequestHeader $http "Authorization" "Token token={api_token}"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json?fields=keywords_spotted" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set answered [CkJsonObject_BoolOf $jResp "answered"]
set business_phone_number [CkJsonObject_stringOf $jResp "business_phone_number"]
set customer_city [CkJsonObject_stringOf $jResp "customer_city"]
set customer_country [CkJsonObject_stringOf $jResp "customer_country"]
set customer_name [CkJsonObject_stringOf $jResp "customer_name"]
set customer_phone_number [CkJsonObject_stringOf $jResp "customer_phone_number"]
set customer_state [CkJsonObject_stringOf $jResp "customer_state"]
set direction [CkJsonObject_stringOf $jResp "direction"]
set duration [CkJsonObject_IntOf $jResp "duration"]
set id [CkJsonObject_stringOf $jResp "id"]
set recording [CkJsonObject_stringOf $jResp "recording"]
set recording_duration [CkJsonObject_stringOf $jResp "recording_duration"]
set recording_player [CkJsonObject_stringOf $jResp "recording_player"]
set start_time [CkJsonObject_stringOf $jResp "start_time"]
set tracking_phone_number [CkJsonObject_stringOf $jResp "tracking_phone_number"]
set voicemail [CkJsonObject_BoolOf $jResp "voicemail"]
set agent_email [CkJsonObject_stringOf $jResp "agent_email"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "keywords_spotted"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set keyword [CkJsonObject_stringOf $jResp "keywords_spotted[i].keyword"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "keywords_spotted[i].locations"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set speaker [CkJsonObject_stringOf $jResp "keywords_spotted[i].locations[j].speaker"]
        set start [CkJsonObject_stringOf $jResp "keywords_spotted[i].locations[j].start"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp