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.
To connect to this service you'll need to use one of these endpoints:
Protocol | URL |
---|---|
JSON |
JSON
https://webservices.data-8.co.uk/TPS/GetCallableNumber.json |
OPEN API |
OPEN API
https://webservices.data-8.co.uk/swagger/TPS/swagger.json |
SOAP |
SOAP
https://webservices.data-8.co.uk/tps.asmx |
Name | Description |
---|---|
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 |
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 |
options | options
An array of options that control further details of how this method operates. See 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.
Name | Description |
---|---|
Common Options | |
ApplicationName |
ApplicationName
Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.
|
Name | Description |
---|---|
Status | Status
Indicates whether the method call was successful, or if some error occurred. If the |
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 |
Each request to this method consumes 1 TPS credit for each entry in the supplied "numbers" parameter.
Request Format
{ "numbers": null, "options": {} }
Response Format
{ "Status": { "Success": true, "CreditsRemaining": 1000 }, "Callable": null, "TelephoneNumber": null }
Depending on your chosen authentication method you will need to modify this request slightly:
API Key
https://webservices.data-8.co.uk/TPS/GetCallableNumber.json?key=your-api-key
and do NOT include the
username
or password
properties in the request JSON document.
Username and Password
https://webservices.data-8.co.uk/TPS/GetCallableNumber.json
and include
username
and password
properties in the request JSON document.Do not use for client-side requests!
JWT Token
https://webservices.data-8.co.uk/TPS/GetCallableNumber.json
Include the JWT token in the request headers as:
Authorization: Bearer your-jwt-token
Parameter | Value |
---|---|
Parameters | |
numbers | numbers |
Common Options | |
ApplicationName |
ApplicationName
|
Credits Remaining Today: 5 |