B4X

CallRail API - Create an Outbound Phone Call

See more CallRail Examples

Initiates an outbound call from 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 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."
'  }

Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("caller_id", "+17703334455")
json.UpdateString("business_phone_number", "+14045556666")
json.UpdateString("customer_phone_number", "+14044442233")
json.UpdateBool("recording_enabled", True)
json.UpdateString("outbound_greeting_recording_url", "http://www.test.com/greeting.mp3")
json.UpdateString("outbound_greeting_text", "These are not the droids you are looking for.")

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

Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://api.callrail.com/v3/a/{account_id}/calls.json", json, "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


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

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

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


'  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



Dim answered As String = jResp.StringOf("answered")
Dim business_phone_number As String = jResp.StringOf("business_phone_number")
Dim customer_city As String = jResp.StringOf("customer_city")
Dim customer_country As String = jResp.StringOf("customer_country")
Dim customer_name As String = jResp.StringOf("customer_name")
Dim customer_phone_number As String = jResp.StringOf("customer_phone_number")
Dim customer_state As String = jResp.StringOf("customer_state")
Dim direction As String = jResp.StringOf("direction")
Dim duration As String = jResp.StringOf("duration")
Dim id As String = jResp.StringOf("id")
Dim recording As String = jResp.StringOf("recording")
Dim recording_duration As String = jResp.StringOf("recording_duration")
Dim start_time As String = jResp.StringOf("start_time")
Dim tracking_phone_number As String = jResp.StringOf("tracking_phone_number")
Dim voicemail As Boolean = jResp.BoolOf("voicemail")