Skip to the content

FindTelephoneNumber

Returns a telephone number if the record can be matched

Live Demo

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

WSDL
https://webservices.data-8.co.uk/teleappendbusiness.asmx
JSON
https://webservices.data-8.co.uk/TeleAppendBusiness/FindTelephoneNumber.json

Description

Checks to see if a telephone number match can be made for this record. If it can, it returns the details of the record within BT OSIS.

By default matches are performed at Surname level (i.e. a match will be allowed if the surname matches regardless of the title or forename passed in). This can be overridden by specifying the option MatchLevel.

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

record

Contains the Name, Address and CompanyName properties specifying the details of the person/business to search for a telephone number for.

The Address property should contain sufficient information to uniquely identify a premise, and the CompanyName property should be detailed enough to identify the company.

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.

XD

XD

true will check ex-directory records for a match.

DQR

DQR

DQR records are not in the printed phone books but they are available on 118 services if you can uniquely identify them. Setting this option to true will search the DQR data for a matching record.

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
Results

Results

Contains a list of matches found for the requested record on the telephone directory. Each match contains the following fields:

  • Name - the name that was matched to
  • Address - the address that was matched to
  • TelephoneNumber - the telephone number to call
  • LineType - the type of telephone line: Residential, Fax, Doctor orTelephone.

Live Demo

record

CompanyName

Name

Sorry, this parameter type is not currently supported in Live Demo

Address

Sorry, this parameter type is not currently supported in Live Demo
options
Name Value

Sample Code

Start a Free 30 Day Trial Today

Start a free trial today