Returns a telephone number if the record can be matched
To connect to this service you'll need to use one of these endpoints:
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
The following parameters can be supplied to this method
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.
ApplicationNameGives the name of the calling application - used to break down usage by application in the usage reports on the dashboard
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
This method returns an object containing the following fields:
Success field is
true, the other results described below can be used to get the results of the method.
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
Contains a list of matches found for the requested record on the telephone directory. Each match contains the following fields: