Lua

CallRail API - Retrieving a Single Call

See more CallRail Examples

Returns a single call object associated with 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/{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: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/{call_id}.json?fields=keywords_spotted", 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)

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

local keyword = ""
local j = 0
local count_j = 0
local speaker = ""
local start = ""

local answered = jResp:bool_of("answered")
local business_phone_number = jResp:string_of("business_phone_number")
local customer_city = jResp:string_of("customer_city")
local customer_country = jResp:string_of("customer_country")
local customer_name = jResp:string_of("customer_name")
local customer_phone_number = jResp:string_of("customer_phone_number")
local customer_state = jResp:string_of("customer_state")
local direction = jResp:string_of("direction")
local duration = jResp:int_of("duration")
local id = jResp:string_of("id")
local recording = jResp:string_of("recording")
local recording_duration = jResp:string_of("recording_duration")
local recording_player = jResp:string_of("recording_player")
local start_time = jResp:string_of("start_time")
local tracking_phone_number = jResp:string_of("tracking_phone_number")
local voicemail = jResp:bool_of("voicemail")
local agent_email = jResp:string_of("agent_email")
local i = 0
local count_i = jResp:size_of_array("keywords_spotted")
while i < count_i do
    jResp.i = i
    keyword = jResp:string_of("keywords_spotted[i].keyword")
    j = 0
    count_j = jResp:size_of_array("keywords_spotted[i].locations")
    while j < count_j do
        jResp.j = j
        speaker = jResp:string_of("keywords_spotted[i].locations[j].speaker")
        start = jResp:string_of("keywords_spotted[i].locations[j].start")
        j = j + 1
    end

    i = i + 1
end