COcollectwise

Get TCN Call Outcome

Changed on

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}

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/tcn/call-outcome/{tcn-cid}
  • Auth
    API key in header collectwise_key

Path parameters

tcn-cidstring required

The TCN call identifier

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

Call outcome found and returned

action'end' | 'judge_transfer' | 'garnishment_transfer' | 'general_transfer' required

The action to be taken based on the call outcome

tcn_cidstring required

The TCN call identifier

timestampstring date-time required

Timestamp when the call outcome was determined

languagestring nullable

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

rpcboolean nullable

Whether right-party contact (identity verification) was completed during the call. Always null for integrations that do not report verification.

Example response

{
  "action": "general_transfer",
  "tcn_cid": "12345",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "language": "english",
  "rpc": true
}

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status