JavaScript

CallRail API - Retrieving a Single Call

See more CallRail Examples

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

var success = false;

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

var 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

http.SetRequestHeader("Authorization","Token token={api_token}");

var sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json?fields=keywords_spotted",sbResponseBody);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(http.LastHeader);
    console.log("Failed.");
    return;
}

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

var keyword;
var j;
var count_j;
var speaker;
var start;

var answered = jResp.BoolOf("answered");
var business_phone_number = jResp.StringOf("business_phone_number");
var customer_city = jResp.StringOf("customer_city");
var customer_country = jResp.StringOf("customer_country");
var customer_name = jResp.StringOf("customer_name");
var customer_phone_number = jResp.StringOf("customer_phone_number");
var customer_state = jResp.StringOf("customer_state");
var direction = jResp.StringOf("direction");
var duration = jResp.IntOf("duration");
var id = jResp.StringOf("id");
var recording = jResp.StringOf("recording");
var recording_duration = jResp.StringOf("recording_duration");
var recording_player = jResp.StringOf("recording_player");
var start_time = jResp.StringOf("start_time");
var tracking_phone_number = jResp.StringOf("tracking_phone_number");
var voicemail = jResp.BoolOf("voicemail");
var agent_email = jResp.StringOf("agent_email");
var i = 0;
var count_i = jResp.SizeOfArray("keywords_spotted");
while (i < count_i) {
    jResp.I = i;
    keyword = jResp.StringOf("keywords_spotted[i].keyword");
    j = 0;
    count_j = jResp.SizeOfArray("keywords_spotted[i].locations");
    while (j < count_j) {
        jResp.J = j;
        speaker = jResp.StringOf("keywords_spotted[i].locations[j].speaker");
        start = jResp.StringOf("keywords_spotted[i].locations[j].start");
        j = j+1;
    }

    i = i+1;
}