Lua

CallRail API - Create an Outbound Phone Call

See more CallRail Examples

Initiates an outbound call from 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 POST \
--      -H "Content-Type: application/json" \
--      -d '{
--           "caller_id": "+17703334455",
--           "business_phone_number": "+14045556666",
--           "customer_phone_number": "+14044442233",
--           "recording_enabled": true,
--           "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
--           "outbound_greeting_text": "These are not the droids you are looking for."
--          }' \
--          "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

-- Use this online tool to generate code from sample JSON:
-- Generate Code to Create JSON

-- The following JSON is sent in the request body.

-- {
--   "caller_id": "+17703334455",
--   "business_phone_number": "+14045556666",
--   "customer_phone_number": "+14044442233",
--   "recording_enabled": true,
--   "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
--   "outbound_greeting_text": "These are not the droids you are looking for."
-- }

local json = chilkat.JsonObject.new()
json:update_string("caller_id", "+17703334455")
json:update_string("business_phone_number", "+14045556666")
json:update_string("customer_phone_number", "+14044442233")
json:update_bool("recording_enabled", true)
json:update_string("outbound_greeting_recording_url", "http://www.test.com/greeting.mp3")
json:update_string("outbound_greeting_text", "These are not the droids you are looking for.")

http:set_request_header("Authorization", "Token token={api_token}")
http:set_request_header("Content-Type", "application/json")

local resp = chilkat.HttpResponse.new()
local success = http:http_json("POST", "https://api.callrail.com/v3/a/{account_id}/calls.json", json, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

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

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

local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
end

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

-- {
--   "answered": null,
--   "business_phone_number": "+19044567899",
--   "customer_city": "Atlanta",
--   "customer_country": "US",
--   "customer_name": null,
--   "customer_phone_number": "+14703444700",
--   "customer_state": "GA",
--   "direction": "outbound",
--   "duration": null,
--   "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
--   "recording": null,
--   "recording_duration": null,
--   "start_time": "2017-02-22T15:02:24.916-05:00",
--   "tracking_phone_number": "+19044567899",
--   "voicemail": false
-- }

-- 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 = jResp:string_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:string_of("duration")
local id = jResp:string_of("id")
local recording = jResp:string_of("recording")
local recording_duration = jResp:string_of("recording_duration")
local start_time = jResp:string_of("start_time")
local tracking_phone_number = jResp:string_of("tracking_phone_number")
local voicemail = jResp:bool_of("voicemail")