(PureBasic) CallRail API - Retrieving a Single Call

Returns a single call object associated with the target account.

For more information, see https://apidocs.callrail.com/#retrieving-a-single-call

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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

    CkHttp::ckSetRequestHeader(http,"Authorization","Token token={api_token}")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json?fields=keywords_spotted",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; 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

    keyword.s
    j.i
    count_j.i
    speaker.s
    start.s

    answered.i = CkJsonObject::ckBoolOf(jResp,"answered")
    business_phone_number.s = CkJsonObject::ckStringOf(jResp,"business_phone_number")
    customer_city.s = CkJsonObject::ckStringOf(jResp,"customer_city")
    customer_country.s = CkJsonObject::ckStringOf(jResp,"customer_country")
    customer_name.s = CkJsonObject::ckStringOf(jResp,"customer_name")
    customer_phone_number.s = CkJsonObject::ckStringOf(jResp,"customer_phone_number")
    customer_state.s = CkJsonObject::ckStringOf(jResp,"customer_state")
    direction.s = CkJsonObject::ckStringOf(jResp,"direction")
    duration.i = CkJsonObject::ckIntOf(jResp,"duration")
    id.s = CkJsonObject::ckStringOf(jResp,"id")
    recording.s = CkJsonObject::ckStringOf(jResp,"recording")
    recording_duration.s = CkJsonObject::ckStringOf(jResp,"recording_duration")
    recording_player.s = CkJsonObject::ckStringOf(jResp,"recording_player")
    start_time.s = CkJsonObject::ckStringOf(jResp,"start_time")
    tracking_phone_number.s = CkJsonObject::ckStringOf(jResp,"tracking_phone_number")
    voicemail.i = CkJsonObject::ckBoolOf(jResp,"voicemail")
    agent_email.s = CkJsonObject::ckStringOf(jResp,"agent_email")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"keywords_spotted")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        keyword = CkJsonObject::ckStringOf(jResp,"keywords_spotted[i].keyword")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"keywords_spotted[i].locations")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            speaker = CkJsonObject::ckStringOf(jResp,"keywords_spotted[i].locations[j].speaker")
            start = CkJsonObject::ckStringOf(jResp,"keywords_spotted[i].locations[j].start")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure