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.
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
find_telephone_number) |
| 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 |
| password | password
If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank. |
| record | record
Contains the The |
| options | options
An array of options that control further details of how this method operates. See 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. |
| Name | Description |
|---|---|
| Status | Status
Indicates whether the method call was successful, or if some error occurred. If the |
| Result | Result
Contains the details found for the requested person on the telephone directory, in the following fields:
|
Requests to this method do not consume credits, but you must have some TeleAppendBusiness credits available.
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.
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
https://webservices.data-8.co.uk/TeleAppendBusiness/FindTelephoneNumber.json?key=your-api-keyand do NOT include the
username or password properties in the request JSON document.
Username and Password
https://webservices.data-8.co.uk/TeleAppendBusiness/FindTelephoneNumber.jsonand include
username and password properties in the request JSON document.Do not use for client-side requests!
JWT Token
https://webservices.data-8.co.uk/TeleAppendBusiness/FindTelephoneNumber.jsonInclude the JWT token in the request headers as:
Authorization: Bearer your-jwt-token| Parameter | Value |
|---|---|
| Parameters | |
| record | |
| CompanyName | CompanyName
|
| Name | |
| Name | Title
Forename
MiddleName
Surname
|
| Address | |
| Address | Lines |
| Common Options | |
| ApplicationName |
ApplicationName
|
| Service-Specific Options | |
Format |
Format |
Credits Remaining Today: 5 | |