Fetching Information

Retrieving information from the Bandwidth Phone Number API is achieved by issuing an HTTP GET against an identifiable resource. Rather than repeat all of the resource names in this section, simply suffice it to say that with a few exceptions, a GET on a resource will yield the available information about that resource.

Query parameters are used to filter or restrict the information returned to the caller.


Since an account may have a very large number of orders or TNs, the system uses the pagination mechanism to control the number of results that are returned.

When a query is issued and no pagination parameters are specified, the system returns the http status code of 404 (Not found) with a link in the body of the message that indicates how to specify the pagination parameters.

Available Inventory: Rate Centers and Cities

The Rate Centers and Cities API Calls return information about the Bandwidth CLEC Network, including coverage data, indicating both the extent of on-net and off-net coverage, as well as number availability, again from an on-net and off-net perspective.

The rules are as follows:

  • If supported=true is specified, then the coverage or availability is reported for the Bandwidth CLEC only.
  • If supported=true is omitted, then the coverage or availability is reported for the combination of the Bandwidth CLEC and our partners
  • If available=true is applied, then only Rate Centers in which we have available numbers are reported.
  • If available is omitted, then all Rate Centers within the scope defined by supported will be returned.

These rules apply for both the /rateCenters and /cities API calls.

Supported = true Supported is missing
available = true Available numbers within the Bandwidth CLEC network Available numbers within the Bandwidth CLEC network combined with our partner networks
available is missing Coverage in the Bandwidth CLEC Coverage of the combined Bandwidth CLEC + Partner networks


The supported and available query parameters used above in the /rateCenters API call operate in an identical manner for the /cities API.

Available Inventory: NPA NXX combinations

The API supports discovering available inventory per NPA-NXX for a user supplied area code and state.

Billing Data Records REST APIs for Retrieving zipped files

This API call allows the user to retrieve Billing Data Records (BDRs) for an account from the network for all billing records created during a specified date range.

POST a BDR zipped file request

The POST to request the retrieval is formatted to indicate the start and end date of the range. Both dates are required for a valid request.

A successful response to the POST also returns a link containing a BDR ID, included in the Location header. This is the Identifier of the successful request, not the identifier of the file containing the BDRs. This link will be used to fetch the zipped file of billing records once the file is ready.

GET a BDR zipped file record

To retrieve the zipped file with the BDR records, a GET is issued on the path returned in the location header.

If the zip file containing the BDR data is ready, this request will return 303 See Other with a Location Header redirecting the request to the BDR zip file content.

results matching ""

    No results matching ""