PowerShell

CallRail API - Create an Outbound Phone Call

See more CallRail Examples

Initiates an outbound call from the target account. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.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."
# }

$json = New-Object Chilkat.JsonObject
$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")

$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpJson("POST","https://api.callrail.com/v3/a/{account_id}/calls.json",$json,"application/json",$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

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

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")
    exit
}

# 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

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