PowerShell

CallRail API - Update a Call

See more CallRail Examples

Updates a call object in the target account. You can use the API to add a Tag or a Note to a call, or to set the call’s lead status. 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 PUT \
#      -H "Content-Type: application/json" \
#      -v \
#      -d '{
#            "note": "Call customer back tomorrow",
#            "tags": ["New Client"],
#            "lead_status": "good_lead",
#            "value": "$1.00",
#            "append_tags": true,
#          }' \
#         "https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.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.

# {
#   "note": "Call customer back tomorrow",
#   "tags": [
#     "New Client"
#   ],
#   "lead_status": "good_lead",
#   "value": "$1.00",
#   "append_tags": true
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("note","Call customer back tomorrow")
$json.UpdateString("tags[0]","New Client")
$json.UpdateString("lead_status","good_lead")
$json.UpdateString("value","$1.00")
$json.UpdateBool("append_tags",$true)

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

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)

$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpSb("PUT","https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json",$sbRequestBody,"utf-8","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": 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/213472384/recording.json",
#   "recording_duration": "27",
#   "start_time": "2017-01-24T11:27:48.119-05:00",
#   "tracking_phone_number": "+13038163491",
#   "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.BoolOf("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.IntOf("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")