The API In-depth

Modified on: 2015-06-04 20:31:13 UTC

NOTE: If you haven't already read the previous articles, we suggest you start from the beginning of our API Basics section, which provides a general overview.

Below we'll walk you through the API details, including the various API calls, the fields they include, the different formats available, and any error messages you may encounter.

The three TrueCNAM API calls you may want to integrate into your application are explained below. All of them use similar fields when sending an API request.

1. CNAM queries - available to all customers.

This is the API call you would use to query CNAM on a incoming phone call. The response can also include a TrueSpam score, and TrueCLID indication. It is performed using the "call_party=terminating" variable. This API call is limited by the number of per-minute and per-day query limits on your account.

2. TrueCLID call start - available to all customers.

This API call allows you to populate our TrueCLID system with an active call you are placing TO someone. It is performed using the "call_party=orig_call_start" variable. This API call does not count against your per-minute and per-day query limits.

3. TrueCLID call end - carrier / service provider customers only.

This API call lets you notify TrueCLID that an active outbound call you previously populated to TrueCLID using "call_party=orig_call_start" has been disconnected. This API call is optional, even if you previously populated TrueCLID with an active call. When you use this API call after previously sending a TrueCLID "call_party=orig_call_start" we'll also provide you with the CNAM information of the called party, and the CNAM returned here does not count against your billing. It is performed using the "call_party=orig_call_end" variable. 

Please note: This API call is only available to customers that have Carrier or Service Provider accounts, and is not available on end user accounts such those with our Free, Basic, Pro, Business, or Enterprise plans. End user accounts attempting to use this API call will receive an error.

Next, see CNAM query API call in-depth

Did you find it helpful? Yes No

Can you please tell us how we can improve this article?