API Specs

Home

API Reference

TrueCall

Support

Runs a partial check on the TrueCall ID, verifying only that it exists, matches whitelisting and time window settings. 

 This does not verify if the phone number matches the TrueCall ID and does not store the TrueCall ID. 

 Typically used on PING.

Check

100 - Missing api_key 

 101 - Missing tc_id 

 102 - Missing consumer_phone 

 103 - Missing dialed_number 

 104 - Invalid consumer_phone 

 105 - Invalid dialed_number 

 106 - Invalid dialed_number 

 200 - Invalid api_key 

 201 - Invalid api_key 

 202 - Invalid api_key 

 203 - Invalid tc_id 

 204 - Invalid api_key 

 205 - Session not associated 

 300 - Campaign source mismatch 

 400 - Already associated 

 500 - General failure 

 600 - User is suspended or pending config 

 601 - Team billing error 

 700 - dialed_number not tracked 

 701 - dialed_number not matched 

 800 - Fraud detected 

 801 - Unable to verify fraud

IPs associated with the session, both IP v4 and v6 depending on availability

Success

Introduction

Returns the info about the team that owns the api_key

Retrieves a paginated list of campaigns belonging to the team identified by the provided API key. The response includes campaign details and pagination information.

List Campaigns

Retrieves details of a specific campaign identified by its ID.

Get Campaign

List Sessions

Retrieves details of a session by its ID.

Get Session

Associates a specific TrueCall ID and dialed number combination to a customer's phone number. 

 This is to be called as soon as the customer call takes place.

Associate

Combines the Associate and Verify APIs: Associates a specific TrueCall ID and dialed number combination with a customer's phone number and runs a full verification on the TrueCall ID, validating all settings, including matching the consumer's phone number to the TrueCall ID. 

 This stores the TrueCall ID to your account and allows all data to be accessed with Get Sessions and List Session. 

 Typically used in Dual Identity campaigns (where the Generator is also the End User).

Associate & Verify

Runs a full verification on the TrueCall ID, validating all settings, including matching the consumer's phone number to the TrueCall ID. 

 This stores the TrueCall ID to your account and allows all data to be accessed with Get Sessions and List Session. 

 Typically used on POST.

General

Endpoints

Generator endpoints

Buyer endpoints

Check

Query Parameters

Response