IsCallable
Checks if a telephone number is registered on TPS | data8
To connect to this service you'll need to use one of these endpoints:
Description
Checks if the supplied number
is registered with the TPS, 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.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
number | number The telephone number to screen against the TPS register. Formatting of this number is not important, so |
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 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 TPS) |
TelephoneNumber | TelephoneNumber Contains the original telephone number if it is callable |