Data8 Logo

DescriptionEndpoint URLsParametersAdvanced OptionsResultsCredit UsageSample CodeLive Demo
FindTelephoneNumber
Returns a telephone number if the record can be matched.
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.

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/TeleAppendBusiness/FindTelephoneNumber.json
OPEN API
OPEN API
https://webservices.data-8.co.uk/swagger/TeleAppendBusiness/swagger.json
SOAP
SOAP
https://webservices.data-8.co.uk/teleappendbusiness.asmx
MCP
MCP
https://webservices.data-8.co.uk/mcp/teleappendbusiness (tool name find_telephone_number)
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.

record
record

Contains the CompanyName and Address properties specifying the details of the company to search for a telephone number for.

The Address property should contain sufficient information to uniquely identify a premise, and the CompanyName property should include the full company name.

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.
Service Specific Options
Format
Format

A boolean option to indicate if the returned telephone number should be presented in a formatted string with spaces and brackets, or as a raw number.

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.

Result
Result

Contains the details found for the requested person on the telephone directory, in the following fields:

  • Name - the name that was matched to
  • Address - the address that was matched to
  • TelephoneNumber - the telephone number to call
Credit Usage

Requests to this method do not consume credits, but you must have some TeleAppendBusiness credits available.

Maximum Execution Time

This method has a maximum execution time of 1 second.

This is a fail-safe limit only - most requests are expected to return much quicker than this. If the time limit is reached, the response will be returned with a Status.Success value of false and you will not be charged.

Sample Code

Request Format

{
  "record": null,
  "options": {
    "Format": true
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Results": 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/TeleAppendBusiness/FindTelephoneNumber.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.
Read More

Username and Password

Post the request to
https://webservices.data-8.co.uk/TeleAppendBusiness/FindTelephoneNumber.json
and include username and password properties in the request JSON document.
Do not use for client-side requests!
Read More

JWT Token

Obtain a JWT token for your user and post the request to
https://webservices.data-8.co.uk/TeleAppendBusiness/FindTelephoneNumber.json
Include the JWT token in the request headers as:
Authorization: Bearer your-jwt-token
Read More
Live Demo
Parameter Value
Parameters
record
CompanyName
CompanyName
Name
Name
Title
Forename
MiddleName
Surname
Address
Address
Lines
Add Remove
Common Options
ApplicationName
ApplicationName
Service-Specific Options
Format
Format
Credits Remaining Today: 5
Try It Now!
An error has occurred. This application may no longer respond until reloaded. Reload 🗙