Skip to the content

GetCallableNumber

Selects the first callable telephone number from a list.

Live Demo

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

WSDL
https://webservices.data-8.co.uk/tps.asmx
JSON
https://webservices.data-8.co.uk/TPS/GetCallableNumber.json

Description

Finds the first number from the list supplied that is callable, i.e. is not registered on the TPS. This is useful if you have more than one number for a person and want to check which number you can contact them on.

If there is a callable number in the list you provide, the TelephoneNumber field in the results will contain the first such callable number, and the Callable field will be set to true. Otherwise, the TelephoneNumber field will be blank and the Callable field will be false.

Each telephone number that needs to be searched against the TPS results in an extra charge on your account for the appropriate number of credits for a TPS search. If you supply two telephone numbers and the first one is callable, you will only be charged for one TPS lookup as we never have to look up the second one. However, if the first number is not callable you will be charged for two TPS searches as we have to search for both numbers against the TPS.

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.
numbers

numbers

A list of telephone numbers to check against the TPS register in order

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 at least one of the supplied telephone numbers is callable (i.e. not on the TPS)

TelephoneNumber

TelephoneNumber

Contains the first telephone number in the supplied list that is callable

Live Demo

numbers Sorry, this parameter type is not currently supported in Live Demo
options No options are currently supported by this method
Credits Remaining Today: 5

Sample Code

Start a Free 30 Day Trial Today

Start a free trial today