Xbase++

CallRail API - Listing All Calls

See more CallRail Examples

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

LOCAL nSuccess
LOCAL oHttp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL nAnswered
LOCAL cBusiness_phone_number
LOCAL cCustomer_city
LOCAL cCustomer_country
LOCAL cCustomer_name
LOCAL cCustomer_phone_number
LOCAL cCustomer_state
LOCAL cDirection
LOCAL nDuration
LOCAL cId
LOCAL cRecording
LOCAL cRecording_duration
LOCAL cRecording_player
LOCAL cStart_time
LOCAL cTracking_phone_number
LOCAL nVoicemail
LOCAL cAgent_email
LOCAL nPage
LOCAL nPer_page
LOCAL nTotal_pages
LOCAL nTotal_records
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

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

oHttp:SetRequestHeader("Authorization", "Token token={api_token}")

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oHttp:QuickGetSb("https://api.callrail.com/v3/a/{account_id}/calls.json", oSbResponseBody)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

nRespStatusCode := oHttp:LastStatus
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oHttp:LastHeader
    ? "Failed."
    oHttp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
ENDIF

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

nPage := oJResp:IntOf("page")
nPer_page := oJResp:IntOf("per_page")
nTotal_pages := oJResp:IntOf("total_pages")
nTotal_records := oJResp:IntOf("total_records")
i := 0
nCount_i := oJResp:SizeOfArray("calls")
DO WHILE i < nCount_i
    oJResp:I := i
    nAnswered := oJResp:BoolOf("calls[i].answered")
    cBusiness_phone_number := oJResp:StringOf("calls[i].business_phone_number")
    cCustomer_city := oJResp:StringOf("calls[i].customer_city")
    cCustomer_country := oJResp:StringOf("calls[i].customer_country")
    cCustomer_name := oJResp:StringOf("calls[i].customer_name")
    cCustomer_phone_number := oJResp:StringOf("calls[i].customer_phone_number")
    cCustomer_state := oJResp:StringOf("calls[i].customer_state")
    cDirection := oJResp:StringOf("calls[i].direction")
    nDuration := oJResp:IntOf("calls[i].duration")
    cId := oJResp:StringOf("calls[i].id")
    cRecording := oJResp:StringOf("calls[i].recording")
    cRecording_duration := oJResp:StringOf("calls[i].recording_duration")
    cRecording_player := oJResp:StringOf("calls[i].recording_player")
    cStart_time := oJResp:StringOf("calls[i].start_time")
    cTracking_phone_number := oJResp:StringOf("calls[i].tracking_phone_number")
    nVoicemail := oJResp:BoolOf("calls[i].voicemail")
    cAgent_email := oJResp:StringOf("calls[i].agent_email")
    i := i + 1
ENDDO

oHttp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()