Skip to the content

IsCallable

Checks if a telephone number is registered on CTPS or not | data8

Live Demo

To connect to this service you'll need to use one of these endpoints:

JSON
Open API
SOAP

Description

Checks if the supplied number is registered with the CTPS, and so cannot be called for unsolicited direct marketing. If the number can be called for direct marketing purposes, the Callable field of the results will be set to true, otherwise it will be set to false. In either case, the TelephoneNumber field of the results will be set to the same value as was supplied as the number parameter.

Credit Usage

Each request to this method consumes 1 CTPS credit.

Parameters

The following parameters can be supplied to this method

username

username

See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix apikey-, e.g. apikey-ABCD-1234-EFGH-5678
password

password

If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
number

number

The telephone number to screen against the CTPS register. Formatting of this number is not important, so "01513554555", "+44 (0) 151 355 4555" and other variants will all give the same result.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name Description
ApplicationName

ApplicationName

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
Callable

Callable

Indicates if the supplied telephone number is callable (i.e. not on the CTPS)

TelephoneNumber

TelephoneNumber

Contains the original telephone number if it is callable

Live Demo

number
options
Name Value
Common Options

Sample Code