Tcl

CallRail API - Listing All Calls

See more CallRail Examples

Returns a paginated list of all calls in 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.json"

# 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.json" $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)

# {
#   "page": 1,
#   "per_page": 100,
#   "total_pages": 1,
#   "total_records": 9,
#   "calls": [
#     {
#       "answered": false,
#       "business_phone_number": null,
#       "customer_city": "Denver",
#       "customer_country": "US",
#       "customer_name": "RUEGSEGGER SIMO",
#       "customer_phone_number": "+13036231131",
#       "customer_state": "CO",
#       "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"
#     },
#     {
#       "answered": false,
#       "business_phone_number": null,
#       "customer_city": "Blue Ridge",
#       "customer_country": "US",
#       "customer_name": "BLUE RIDGE, GA",
#       "customer_phone_number": "+17064558047",
#       "customer_state": "GA",
#       "direction": "inbound",
#       "duration": 16,
#       "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
#       "recording": null,
#       "recording_duration": null,
#       "recording_player": null,
#       "start_time": "2017-01-24T19:50:03.456-05:00",
#       "tracking_phone_number": "+17708243899",
#       "voicemail": false,
#       "agent_email": "elbert@bpp.com"
#     }
#   ]
# }

# 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 page [CkJsonObject_IntOf $jResp "page"]
set per_page [CkJsonObject_IntOf $jResp "per_page"]
set total_pages [CkJsonObject_IntOf $jResp "total_pages"]
set total_records [CkJsonObject_IntOf $jResp "total_records"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "calls"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set answered [CkJsonObject_BoolOf $jResp "calls[i].answered"]
    set business_phone_number [CkJsonObject_stringOf $jResp "calls[i].business_phone_number"]
    set customer_city [CkJsonObject_stringOf $jResp "calls[i].customer_city"]
    set customer_country [CkJsonObject_stringOf $jResp "calls[i].customer_country"]
    set customer_name [CkJsonObject_stringOf $jResp "calls[i].customer_name"]
    set customer_phone_number [CkJsonObject_stringOf $jResp "calls[i].customer_phone_number"]
    set customer_state [CkJsonObject_stringOf $jResp "calls[i].customer_state"]
    set direction [CkJsonObject_stringOf $jResp "calls[i].direction"]
    set duration [CkJsonObject_IntOf $jResp "calls[i].duration"]
    set id [CkJsonObject_stringOf $jResp "calls[i].id"]
    set recording [CkJsonObject_stringOf $jResp "calls[i].recording"]
    set recording_duration [CkJsonObject_stringOf $jResp "calls[i].recording_duration"]
    set recording_player [CkJsonObject_stringOf $jResp "calls[i].recording_player"]
    set start_time [CkJsonObject_stringOf $jResp "calls[i].start_time"]
    set tracking_phone_number [CkJsonObject_stringOf $jResp "calls[i].tracking_phone_number"]
    set voicemail [CkJsonObject_BoolOf $jResp "calls[i].voicemail"]
    set agent_email [CkJsonObject_stringOf $jResp "calls[i].agent_email"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp