Skip to main content
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>'
{
  "action": "general_transfer",
  "tcn_cid": "12345",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "language": "english"
}

​
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 with X-TCN-cid headers.

​
Authentication

This endpoint requires a valid collectwise_key header for API authentication, following the same pattern as other CollectWise API endpoints.

​
Response Fields

​
action

The action 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

The language 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"

​
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

​
collectwise_key
string
header
required

Path Parameters

​
tcn-cid
string
required

The TCN call identifier

Response

Call outcome found and returned

​
action
enum<string>
required

The action to be taken based on the call outcome

Available options:
end,
judge_transfer,
garnishment_transfer,
general_transfer
​
tcn_cid
string
required

The TCN call identifier

​
timestamp
string<date-time>
required

Timestamp when the call outcome was determined

​
language
string | null

The language used during the call (e.g., 'english', 'spanish'). May be null if not provided.