Signup Login

TPS/CTPS Check a Telephone Number

API Method: tps_check

Description

Checks a telephone number against both the domestic and business Telephone Preference Scheme (TPS and CTPS) lists to ensure that the number is not registered with either scheme and may be freely called for marketing purposes.

Mandatory Parameters

Name Description
api_key or javascript_key Use your API key if invoking server-side. If invoking from the browser via JavaScript, generate a JavaScript key using the javascript_key method.
telephone_number Enter a UK telephone number. This can include spaces, brackets etc.

Optional Parameters

Name Description
client You can optionally include an identifier for your final client or user. This is logged in your usage log and you will be able to view your usage statistics by client.
output Set to json for a JSON response; the default response is XML. Not applicable to the SOAP API.
callback When using JSON, specify a JSONP wrapper in which the JSON response is to be wrapped.

Returned Values

The XML response is contained within a <tps_check_res> element.

Name Description
status Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code Returns the error code when the status is error. See below for error codes.
t2a_version_number The current API version number.
credit_used The number of credits used in order to execute the request.
mode Returns normal or test when executed in the free test mode.
tps_status call if the number is NOT in the TPS (the domestic) register; no_call if the number IS in the TPS register.
ctps_status call if the number is NOT in the CTPS (the business) register; no_call if the number IS in the CTPS register.

Error Codes

See the common error codes. There are no errors which are specific to this method.

Free Test Mode

When operating in the free test mode errors are returned if mandatory parameters are missing, or it returns a dummy data response, in an identical format to a real response.

Note that the mode is returned as test when the method is operating in the free test mode.