Wholesale Hosted Communications (WHC) & WHC Express

  • Hosted communications

Electronically pass orders for Wholesale Hosted Communication (WHC) from your systems to BT.

Overview

Wholesale Hosted Communications (WHC) and WHC Express APIs offer you an alternative to traditional portal-based order placement for both you, and your end customers. 

WHC and WHC Express APIs enable you to pass orders directly to BT’s systems at any stage of the sales cycle, with your systems controlling all the transactions. This enables you to create your own unique propositions by bundling our services with product elements from your portfolio such as data connectivity and mobile handsets.

The full suite of APIs can be seen here, covering ordering of WHC/WHC Express (including CPE) and numbers as well as the traditional BT portal transactions you expect such as provide, modify and cease.

APIs Included

BT

OAuth 2

Identity and Authentication

OAuth 2 produces an access token which is required to authorise API calls for a given app.

Product Documentation
BT Wholesale

Validate and qualify company

Voice

Use this API to validate key data before placing an order on WHC/WHC Express.This will prevent order submission failures.

  • Validate the required unique fields, 'Company Name & Company Domain', are not already in use before...
Product Documentation
BT Wholesale

Address Management

Broadband
Voice

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.

Product Documentation
BT Wholesale

Number portability check

Voice

Check whether a particular number range (for WHC Express you can only port a particular number not number range) can be ported based on portState value in response.

  • Enter a number to verify if this is capable of being...
Product Documentation
BT Wholesale

Verify data

Voice

Validate the service provider information and the data they are using, in order to prevent potential duplicate order failures.

  • Used to retrieve the following key data for a Reseller: sales tag, reseller id, xxxx. -...
Product Documentation
BT Wholesale

Activate Port

Voice

Activate the port and progress HV SingleLine/MultiLine Order.

Product Documentation
BT Wholesale

Reserve/RingFence numbers

Voice

RingFence numbers for WHC

Order and allocate new numbers, and/or allocate ported number ranges to a WHC Company to then be onward consumed by its sites, features and users.

  • Enter a areaCode or location, along with a...
Product Documentation
BT Wholesale

SingleLine/MultiLine import order

Voice

Place, amend or cancel an order to port a Hosted Voice SingleLine/MultiLine number.

  • Once order creation request is sent then we will be getting acknowledgment immediately and further notifications related to order...
Product Documentation
BT Wholesale

Product order (WHC/WHC Express)

Voice

Place an order for WHC/WHC Express and any of its core assets; company, numbers, sites and users(WHC Express does not support site and numbers as orderable entity).

  • Once order is created and submitted, further...
Product Documentation
BT Wholesale

Get available numbers

Voice

Get available new numbers that you want to reserve against company, site or user.

  • Enter cugId or company service id or site service id to get available new or ported telephone numbers.
Product Documentation

Key Features

  • Try out our API’s in a safe sandbox environment using our stubbed* APIs
  • Review detailed but clear descriptions on what each API and each parameter can do
  • Check, qualify and verify date before placement of orders, reducing order failures
  • Provide, Add, Modify, Cease, all the traditional transactions you can do on the portal are available

*Stubbed means that there is no endpoint, so you use our real APIs that mimic real-life scenarios, but they are safe in that they do not put live orders into the system.

The full suite of APIs can be seen here.

Benefits

  • Reduce your order management costs
  • Reduce the time it takes to place and manage orders
  • Reduce manual order entry errors
  • Provide your customers with a single common interface using your branded order systems
  • Advance your digital evolution
WHC

How does it work?

The following scenarios are supported via WHC APIs:

Scenario 1: Place an order with a ported number 

Scenario 2: Place an order without a ported number

Other scenarios will be added in the coming months such as modify and add users to an order.

Need more information

New to WHC and want to find out more about the product in general, then click here.  Existing customers who want to review some of our documentation should click here to access product literature from the Document Centre.

API Process

Click on the link below to download the WHC API Provide Order User Guide

BT Wholesale_WHC API Provide Order Guide v4.pdf (413.62 KB)

 

Back to top