GetCallableNumber - CTPS • Data8 Web Services API Documentation

GetCallableNumber

Selects the first callable telephone number from a list.

Description

Finds the first number from the list supplied that is callable, i.e. is not registered on the CTPS. 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 CTPS results in an extra charge on your account for the appropriate number of credits for a CTPS search. If you supply two telephone numbers and the first one is callable, you will only be charged for one CTPS 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 CTPS searches as we have to search for both numbers against the CTPS.

Endpoint URLs

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

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/CTPS/GetCallableNumber.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/CTPS/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/ctps.asmx

Parameters

The following parameters can be supplied to this method:

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 `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 CTPS register in order
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

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.

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.

Results

This method returns an object containing the following fields:

Name	Description
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 CTPS)
TelephoneNumber	TelephoneNumber Contains the first telephone number in the supplied list that is callable

Credit Usage

Each request to this method consumes 1 CTPS credit for each entry in the supplied "numbers" parameter.

Sample Code

Request Format

{
  "numbers": [
    "[\"01513554555\"]"
  ],
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Callable": true,
  "TelephoneNumber": null
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/CTPS/GetCallableNumber.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
numbers	numbers Add Remove
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 5 Try It Now!