Get TCN Call Outcome
curl --request GET \
--url https://collectwiseapi.com/tcn/call-outcome/{tcn-cid} \
--header 'collectwise_key: <api-key>'import requests
url = "https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}"
headers = {"collectwise_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {collectwise_key: '<api-key>'}};
fetch('https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"collectwise_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("collectwise_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}")
.header("collectwise_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["collectwise_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"action": "general_transfer",
"tcn_cid": "12345",
"timestamp": "2024-01-15T10:30:00.000Z",
"language": "english",
"rpc": true
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"error": "Call outcome not found",
"message": "Call may still be in progress or outcome not yet available"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}Communications
Get TCN Call Outcome
Retrieves the call outcome for a specific TCN call ID. This endpoint is designed to support TCN’s SIP integration where calls are routed to CollectWise AI agents.
GET
/
tcn
/
call-outcome
/
{tcn-cid}
Get TCN Call Outcome
curl --request GET \
--url https://collectwiseapi.com/tcn/call-outcome/{tcn-cid} \
--header 'collectwise_key: <api-key>'import requests
url = "https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}"
headers = {"collectwise_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {collectwise_key: '<api-key>'}};
fetch('https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"collectwise_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("collectwise_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}")
.header("collectwise_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["collectwise_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"action": "general_transfer",
"tcn_cid": "12345",
"timestamp": "2024-01-15T10:30:00.000Z",
"language": "english",
"rpc": true
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"error": "Call outcome not found",
"message": "Call may still be in progress or outcome not yet available"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}Overview
The TCN Call Outcome API provides a simple endpoint for TCN (Third-Party Call Network) integration to retrieve call outcomes from CollectWise AI agents. This endpoint is designed to support TCN’s SIP integration where calls are routed to our AI agents withX-TCN-cid headers.
Authentication
This endpoint requires a validcollectwise_key header for API authentication, following the same pattern as other CollectWise API endpoints.
Response Fields
action
Theaction field in the response can contain one of the following values:
"end"- Call completed normally, no transfer needed"judge_transfer"- Transfer to judge/supervisor for legal matters"garnishment_transfer"- Transfer to garnishment specialist"general_transfer"- General transfer to human agent
language
Thelanguage field indicates the language used during the call. This field may be null if not provided during call outcome creation.
Example values include:
"english""spanish"
rpc
Therpc field indicates whether right-party contact (identity verification) was completed during the call:
true- The right party was verified during the callfalse- Verification was attempted but not completednull- The integration does not report verification
Usage Pattern
This endpoint should be pinged every 1-2 seconds after a call ends, with a timeout of 2-3 minutes. The endpoint will return:- 200: Call outcome is available
- 404: Call is still in progress or outcome not yet available (continue polling)
Example Usage
curl -X GET \
"https://api.collectwiseapi.com/tcn/call-outcome/12345" \
-H "collectwise_key: your-api-key-here"
Authorizations
Path Parameters
The TCN call identifier
Response
Call outcome found and returned
The action to be taken based on the call outcome
Available options:
end, judge_transfer, garnishment_transfer, general_transfer The TCN call identifier
Timestamp when the call outcome was determined
The language used during the call (e.g., 'english', 'spanish'). May be null if not provided.
Whether right-party contact (identity verification) was completed during the call. Always null for integrations that do not report verification.
