Filter By
How do I use the API key and secret to call an API?
FAQ item
Most of our external APIs are authenticated with an OAuth token which is generated using the OAuth API. To produce the authorisation string for the OAuth request, the app's client ID, ':' and password are concatenated and base64-encoded. This string is…
How much does it cost to use this site?
FAQ item
Using the developer portal and sandbox APIs is free of charge. Access to live APIs in our production environment are subject to contractual agreement which will specify the commercial terms for API usage.
How are APIs billed / paid for?
FAQ item
Where APIs are chargeable, they are billed under a billing agreement that forms part of our overall commercial contract. Please contact your account manager for more information.
Why can’t I see API products in the production environment when building an app?
FAQ item
API products in the production environment are only visible in the app creation process to developers who have the appropriate authorization. If you can’t see a product that you think that you should have access to, please contact your account manager.
What is the difference between sandbox and production APIs?
FAQ item
Our sandbox APIs emulate the live environment and give you the opportunity to send test API calls and to receive a simulated response. The production APIs work with our live systems and data.
Do our APIs work with other mobile operators?
FAQ item
Our APIs are designed to work with BT brands only, these include EE, BT and Plusnet. Some APIs support information for MVNOs on our mobile network. Not all of our brands are supported by all APIs – please check the relevant API documentation.
What types of services do your APIs provide?
FAQ item
Our APIs provide a wide range of services relating to both our company’s products and managing interactions with our customers.
How do I find out my quota limits for the production environment?
FAQ item
Depending on how you propose to use our APIs, we may enforce a quota for usage in production. This will be agreed as part of our commercial contract.
How do I access live data?
FAQ item
Live data is only available to organisations with an appropriate contractual agreement. Please contact our account management teams via ‘Contact us’ for further details.
How do I get help with a fault or issue?
FAQ item
Please try to resolve your issue by reading articles in the Knowledge Centre. If you can't find a solution, please use the form in the ‘Contact us’ section.
Why is my app approval status showing as “Pending”?
FAQ item
Apps in the production environment give access to live systems or live data and may require approval / configuration before going live. Please contact you account manager if you are concerned about any delay with your app.
Are there any quota limits on the sandbox environment?
FAQ item
We reserve the right to put limits on the volume of calls made to our sandbox and we believe that customers will be able to create and test their apps in the sandbox without hitting any usage limits.
Address Management
Product Documentation
Search the Rest of BT (RoBT) and Openreach address databases to find address records and keys to be used in orders. Where no suitable matching address is found, create an address and obtain a temporary address key.
Appointment Management
Product Documentation
List available engineering appointments and reserve an engineering visit.
Product And Network Availability
Product Documentation
Determine the services available at customer's location and the status of the existing installed services.
Location Insights for London
Product
Access insights on footfall activity and visitor catchments across any location in London
The Location Insights API provides data on footfall and home catchment for standard geographies and areas of interest (AoIs) in London.
Order Management And Progress Updates
Product Documentation
Submit, amend or cancel an order, and receive notifications about the order status. This API is based on TMF622.
Tenure
Product
Retrieves the Tenure for the associated MSISDN
Overview
The Subscriber Tenure API will return a True or False answer as to if the customers subscription tenure (rather than the contract tenure) with EE has been longstanding.
Tenure
Product Documentation
The Subscriber Tenure API will allow Partners to enter a date and the product will return a True/ False answer as to if the customers subscription tenure with EE started before this date.
Global Voice Services
Product Documentation
BT one voice customer facing API specs and documentation.
Document Management
Product Documentation
BT Document Management customer facing API specs and documentation.
Encrypt personally identifying information
Product Documentation
This API product converts a customer’s mobile telephone number (MSISDN) into the secure tokenised Anonymised Mobile Subscriber Reference (AMSR) and vice versa.
Age Eligibility
Product Documentation
This product offers a mechanism for a service provider to request information related to a user’s mobile phone account which can be used for spotting potentially fraudulent behaviour.
Address look-up
Product Documentation
This API product allows a developer to search for a specific postal address using detailed information (such as a house number + postcode) or return a candidate list of addresses.
Back to top