Lua

CallRail API - Listing All Calls

See more CallRail Examples

Returns a paginated list of all calls in the target account. Lua

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

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

http:set_request_header("Authorization", "Token token={api_token}")

local sbResponseBody = chilkat.StringBuilder.new()
local success = http:quick_get_sb("https://api.callrail.com/v3/a/{account_id}/calls.json", sbResponseBody)
if not success then
    print(http.last_error_text)
    return
end

local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

local respStatusCode = http.last_status
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(http.last_header)
    print("Failed.")
    return
end

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

local answered = false
local business_phone_number = ""
local customer_city = ""
local customer_country = ""
local customer_name = ""
local customer_phone_number = ""
local customer_state = ""
local direction = ""
local duration = 0
local id = ""
local recording = ""
local recording_duration = ""
local recording_player = ""
local start_time = ""
local tracking_phone_number = ""
local voicemail = false
local agent_email = ""

local page = jResp:int_of("page")
local per_page = jResp:int_of("per_page")
local total_pages = jResp:int_of("total_pages")
local total_records = jResp:int_of("total_records")
local i = 0
local count_i = jResp:size_of_array("calls")
while i < count_i do
    jResp.i = i
    answered = jResp:bool_of("calls[i].answered")
    business_phone_number = jResp:string_of("calls[i].business_phone_number")
    customer_city = jResp:string_of("calls[i].customer_city")
    customer_country = jResp:string_of("calls[i].customer_country")
    customer_name = jResp:string_of("calls[i].customer_name")
    customer_phone_number = jResp:string_of("calls[i].customer_phone_number")
    customer_state = jResp:string_of("calls[i].customer_state")
    direction = jResp:string_of("calls[i].direction")
    duration = jResp:int_of("calls[i].duration")
    id = jResp:string_of("calls[i].id")
    recording = jResp:string_of("calls[i].recording")
    recording_duration = jResp:string_of("calls[i].recording_duration")
    recording_player = jResp:string_of("calls[i].recording_player")
    start_time = jResp:string_of("calls[i].start_time")
    tracking_phone_number = jResp:string_of("calls[i].tracking_phone_number")
    voicemail = jResp:bool_of("calls[i].voicemail")
    agent_email = jResp:string_of("calls[i].agent_email")
    i = i + 1
end