B4X

CallRail API - Listing All Calls

See more CallRail Examples

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

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("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

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

Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
success = http.QuickGetSb("https://api.callrail.com/v3/a/{account_id}/calls.json", sbResponseBody)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Log("Response Body:")
Log(jResp.Emit)

Dim respStatusCode As Int = http.LastStatus
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(http.LastHeader)
    Log("Failed.")
    Return
End If


'  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



Dim answered As Boolean
Dim business_phone_number As String
Dim customer_city As String
Dim customer_country As String
Dim customer_name As String
Dim customer_phone_number As String
Dim customer_state As String
Dim direction As String
Dim duration As Int
Dim id As String
Dim recording As String
Dim recording_duration As String
Dim recording_player As String
Dim start_time As String
Dim tracking_phone_number As String
Dim voicemail As Boolean
Dim agent_email As String

Dim page As Int = jResp.IntOf("page")
Dim per_page As Int = jResp.IntOf("per_page")
Dim total_pages As Int = jResp.IntOf("total_pages")
Dim total_records As Int = jResp.IntOf("total_records")
Dim i As Int = 0
Dim count_i As Int = jResp.SizeOfArray("calls")
Do While i < count_i
    jResp.I = i
    answered = jResp.BoolOf("calls[i].answered")
    business_phone_number = jResp.StringOf("calls[i].business_phone_number")
    customer_city = jResp.StringOf("calls[i].customer_city")
    customer_country = jResp.StringOf("calls[i].customer_country")
    customer_name = jResp.StringOf("calls[i].customer_name")
    customer_phone_number = jResp.StringOf("calls[i].customer_phone_number")
    customer_state = jResp.StringOf("calls[i].customer_state")
    direction = jResp.StringOf("calls[i].direction")
    duration = jResp.IntOf("calls[i].duration")
    id = jResp.StringOf("calls[i].id")
    recording = jResp.StringOf("calls[i].recording")
    recording_duration = jResp.StringOf("calls[i].recording_duration")
    recording_player = jResp.StringOf("calls[i].recording_player")
    start_time = jResp.StringOf("calls[i].start_time")
    tracking_phone_number = jResp.StringOf("calls[i].tracking_phone_number")
    voicemail = jResp.BoolOf("calls[i].voicemail")
    agent_email = jResp.StringOf("calls[i].agent_email")
    i = i + 1
Loop