IsValidAdvanced

Validate a UK landline number

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

JSON

Open API

SOAP

Description

Checks a UK landline number for validity.

This service is not appropriate if you need to validate any number other than a UK landline number. If you need to validate mobile numbers or international numbers, you should consider the use of the PhoneValidation service.

This service is deprecated in favour of the PhoneValidation service. This service will remain operational for the foreseeable future, but the PhoneValidation service should be used for all new development.

Credit Usage

Each request to this method consumes 1 TelephoneLineValidation 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 validate
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.

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
Service-Specific Options
Name	Description
IgnoreExtraDigits	IgnoreExtraDigits Indicates if any extra digits beyond those needed to dial the number should be ignored. With this option turned on, `015135545550` would be returned as valid even though the number is really `01513554555` without the trailing `0`, otherwise it would be invalid.
AllowedPrefixes	AllowedPrefixes An optional comma-separated list of telephone number prefixes that are allowed. If this option is specified, any telephone number that does not match one of these prefixes is automatically flagged as invalid. These numbers must be specified in international format.
BarredPrefixes	BarredPrefixes An optional comma-separated list of telephone number prefixes that are not allowed. If this option is specified, any telephone number that matches one of these prefixes will automatically be flagged as invalid. These prefixes must be specified in international format.
UseMobileValidation	UseMobileValidation If set to true then the service will use MobileValidation on any number it recognises as a mobile number and TelephoneLineValidation on all other numbers. Please ensure you have MobileValidation credits available before using this option. The option defaults to false.

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

Result

Result

One of the following options to indicate the validity of the supplied number:

Code	Description
Valid	The number appears to be valid
Ambiguous	It is not possible to tell from the details returned from the telephone network whether or not the number is valid
Invalid	The number appears to be invalid
TemporaryInvalid	There was a problem contacting the number, but of a type that is expected to be temporary (e.g. congestion in the telephone network)
Unknown	The telephone network returned a status code that our service did not understand
Error	There was some problem contacting the telephone network
TimedOut	A timeout error occurred while waiting for the telephone network to respond
NumberChanged	The number is invalid, but calling the number may give a pre-recorded message indicating the new number that should be used instead

Live Demo

number

options

Name	Value
Common Options
ApplicationName
Service-Specific Options
IgnoreExtraDigits
AllowedPrefixes
BarredPrefixes
UseMobileValidation

Sample Code

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- https://www.data-8.co.uk/ValidationAdmin/AjaxAPIKey -->
<script type="text/javascript" src="https://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key&load=TelephoneLineValidation">
</script>

<script type="text/javascript">

function IsValidAdvanced(number) {
  /// <param name="number">string</param>
  var telephonelinevalidation = new data8.telephonelinevalidation();
  
  telephonelinevalidation.isvalidadvanced(
    number,
    [
      new data8.option('IgnoreExtraDigits', 'false'),
      new data8.option('AllowedPrefixes', '+44151'),
      new data8.option('BarredPrefixes', '+4420'),
      new data8.option('UseMobileValidation', 'false')
    ],
    showIsValidAdvancedResult
  );
}

function showIsValidAdvancedResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  }
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // result.Result
    //   One of the following options to indicate the validity of the supplied number:
    //   
    //   {.table .table-striped}
    //   | Code | Description |
    //   |-------|----------------|
    //   | Valid | The number appears to be valid |
    //   | Ambiguous | It is not possible to tell from the details returned from the telephone network whether or not the number is valid |
    //   | Invalid | The number appears to be invalid |
    //   | TemporaryInvalid | There was a problem contacting the number, but of a type that is expected to be temporary (e.g. congestion in the telephone network) |
    //   | Unknown | The telephone network returned a status code that our service did not understand |
    //   | Error | There was some problem contacting the telephone network |
    //   | TimedOut | A timeout error occurred while waiting for the telephone network to respond |
    //   | NumberChanged | The number is invalid, but calling the number may give a pre-recorded message indicating the new number that should be used instead |
  }
}

</script>

// NOTE: A Service Reference to the web service must be added to use this sample code.
private void IsValidAdvanced(string number)
{
    // Declare the required options.
    Option IgnoreExtraDigits = new Option();
    IgnoreExtraDigits.Name = "IgnoreExtraDigits";
    IgnoreExtraDigits.Value = "false";
    Option AllowedPrefixes = new Option();
    AllowedPrefixes.Name = "AllowedPrefixes";
    AllowedPrefixes.Value = "+44151";
    Option BarredPrefixes = new Option();
    BarredPrefixes.Name = "BarredPrefixes";
    BarredPrefixes.Value = "+4420";
    Option UseMobileValidation = new Option();
    UseMobileValidation.Name = "UseMobileValidation";
    UseMobileValidation.Value = "false";
    // Invoke the web service method.
    TelephoneLineValidationSoapClient proxy = new TelephoneLineValidationSoapClient();
    TelephoneLineValidationAdvancedOutput results = proxy.IsValidAdvanced("your-username", "your-password", number, new Option[] {
                IgnoreExtraDigits,
                AllowedPrefixes,
                BarredPrefixes,
                UseMobileValidation});
    // Check that the call succeeded, and show the error message if there was a problem.
    if ((results.Status.Success == false))
    {
        MessageBox.Show(("Error: " + results.Status.ErrorMessage));
    }
    else
    {
        // TODO: Process method results here.
        // Results can be extracted from the following fields:
        // result.Result
        //   One of the following options to indicate the validity of the supplied number:
        //   
        //   {.table .table-striped}
        //   | Code | Description |
        //   |-------|----------------|
        //   | Valid | The number appears to be valid |
        //   | Ambiguous | It is not possible to tell from the details returned from the telephone network whether or not the number is valid |
        //   | Invalid | The number appears to be invalid |
        //   | TemporaryInvalid | There was a problem contacting the number, but of a type that is expected to be temporary (e.g. congestion in the telephone network) |
        //   | Unknown | The telephone network returned a status code that our service did not understand |
        //   | Error | There was some problem contacting the telephone network |
        //   | TimedOut | A timeout error occurred while waiting for the telephone network to respond |
        //   | NumberChanged | The number is invalid, but calling the number may give a pre-recorded message indicating the new number that should be used instead |
    }
}

'NOTE: A Service Reference to the web service must be added to use this sample code.
Private Sub IsValidAdvanced(ByVal number As String)
    'Declare the required options.
    Dim IgnoreExtraDigits As [Option] = New [Option]()
    IgnoreExtraDigits.Name = "IgnoreExtraDigits"
    IgnoreExtraDigits.Value = "false"
    Dim AllowedPrefixes As [Option] = New [Option]()
    AllowedPrefixes.Name = "AllowedPrefixes"
    AllowedPrefixes.Value = "+44151"
    Dim BarredPrefixes As [Option] = New [Option]()
    BarredPrefixes.Name = "BarredPrefixes"
    BarredPrefixes.Value = "+4420"
    Dim UseMobileValidation As [Option] = New [Option]()
    UseMobileValidation.Name = "UseMobileValidation"
    UseMobileValidation.Value = "false"
    'Invoke the web service method.
    Dim proxy As TelephoneLineValidationSoapClient = New TelephoneLineValidationSoapClient()
    Dim results As TelephoneLineValidationAdvancedOutput = proxy.IsValidAdvanced("your-username", "your-password", number, New [Option]() {IgnoreExtraDigits, AllowedPrefixes, BarredPrefixes, UseMobileValidation})
    'Check that the call succeeded, and show the error message if there was a problem.
    If (results.Status.Success = false) Then
        MessageBox.Show(("Error: " + results.Status.ErrorMessage))
    Else
        'TODO: Process method results here.
        'Results can be extracted from the following fields:
        'result.Result
        '  One of the following options to indicate the validity of the supplied number:
        '  
        '  {.table .table-striped}
        '  | Code | Description |
        '  |-------|----------------|
        '  | Valid | The number appears to be valid |
        '  | Ambiguous | It is not possible to tell from the details returned from the telephone network whether or not the number is valid |
        '  | Invalid | The number appears to be invalid |
        '  | TemporaryInvalid | There was a problem contacting the number, but of a type that is expected to be temporary (e.g. congestion in the telephone network) |
        '  | Unknown | The telephone network returned a status code that our service did not understand |
        '  | Error | There was some problem contacting the telephone network |
        '  | TimedOut | A timeout error occurred while waiting for the telephone network to respond |
        '  | NumberChanged | The number is invalid, but calling the number may give a pre-recorded message indicating the new number that should be used instead |
    End If
End Sub

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function IsValidAdvanced($number)
{
  $options = array(
    "Option" => array(
      array(
        "Name" => "IgnoreExtraDigits",
        "Value" => "false"
      ),
      array(
        "Name" => "AllowedPrefixes",
        "Value" => "+44151"
      ),
      array(
        "Name" => "BarredPrefixes",
        "Value" => "+4420"
      ),
      array(
        "Name" => "UseMobileValidation",
        "Value" => "false"
      )
    )
  );
  $params = array(
    "username" => "your-username",
    "password" => "your-password",
    "number" => $number,
    "options" => $options
  );
  $client = new SoapClient("https://webservices.data-8.co.uk/TelephoneLineValidation.asmx?WSDL");
  $result = $client->IsValidAdvanced($params);
  if ($result->IsValidAdvancedResult->Status->Success == 0)
  {
    echo "Error: " . $result->IsValidAdvancedResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->IsValidAdvancedResult->Result
    //   One of the following options to indicate the validity of the supplied number:
    //   
    //   {.table .table-striped}
    //   | Code | Description |
    //   |-------|----------------|
    //   | Valid | The number appears to be valid |
    //   | Ambiguous | It is not possible to tell from the details returned from the telephone network whether or not the number is valid |
    //   | Invalid | The number appears to be invalid |
    //   | TemporaryInvalid | There was a problem contacting the number, but of a type that is expected to be temporary (e.g. congestion in the telephone network) |
    //   | Unknown | The telephone network returned a status code that our service did not understand |
    //   | Error | There was some problem contacting the telephone network |
    //   | TimedOut | A timeout error occurred while waiting for the telephone network to respond |
    //   | NumberChanged | The number is invalid, but calling the number may give a pre-recorded message indicating the new number that should be used instead |
  }
}

Request Format

{
  "number": "01513554555",
  "options": {
    "IgnoreExtraDigits": false,
    "AllowedPrefixes": 44151,
    "BarredPrefixes": 4420,
    "UseMobileValidation": false
  }
}

Results Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Result": "Valid"
}

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