This guide will take you through the basics of ordering phone numbers with the Bandwidth Dashboard API.
Phone number ordering in the Bandwidth Dashboard is asynchronous when creating an "order". The orders are then processed and the order status is updated asynchronously. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for
Order processing times can vary and are not guaranteed, so bandwidth does not recommend setting a timeout on waiting for an order to show either
FAILED status, but instead relying on a webhook from an orders subscription.
Ordering Phone Numbers for use with the network allows you to provosion specific phone numbers from available inventory that have been discovered in a search.
The Dashboard API allows you to submit different order types in your API request body to order numbers based on different requirements.
|Order a known, available number or set of numbers|
|Order an unknown number or group of numbers from the same Area Code|
|Order an unknown number or group of numbers from the same Rate Center|
|Order an unknown number or group of numbers from the same NPANxx|
|Order an unknown toll-free number or group of toll-free numbers from that follow a specified vanity pattern|
|Order an unknown toll-free number or group of toll-free numbers from any toll-free area code (ex. 8* or 83)|
|Order an unknown number or group of numbers from the same state|
|Order an unknown number or group of numbers from the same city|
|Order an unknown number or group of numbers from the same zip code|
|Order an unknown number or group of numbers from the same LATA|
|Order an unknown number or group of numbers from a combination of search parameters|
To see specific examples of each order type, please visit the Dashboard API Reference.
EVERY type of order can/must include the parameters below
|No||The desired quantity of requested numbers. values range from 1-5000. Default: |
|No||Optional value for Id set by customer|
|Yes||The ID of the Site (Sub-Account) that the SIP Peer is to be associated with.|
|No||The ID of the SIP Peer (Location) that the telephone numbers are to be assigned to.|
|No||By default all order submissions are fulfilled partially. Setting the |
These parameters may or may not be required based on the type of order. Check out the reference documentation for more information on the different types of orders
|A list of telephone numbers to order|
|Allowed ranged: [2-9] for the first digit and [0, 9] for both the second and third digits.|
|A text Rate Center name. Must be combined with State information|
|The two-letter abbreviation of the state|
|The name of the city that the Ordered telephone numbers should apply to|
|A five-digit (XXXXX) or nine-digit (XXXXX-XXXX) format value.|
|A maximum five-digit (XXXXX) numeric format.|
|If set to |
|NpaNxx combination to be searched. Valid Npa values: [2-9] for the first digit, and [0-9] for both the second and third digits. Valid Nxx values: [2-9] for the first digit, and [0-9] for both the second and third digits. Valid Xxvalues [0-9]. ℹ️ If set to true, enables the ability to get local calling access numbers if numbers are not available for the given criteria.|
|A text string used to request a regular vanity number. Valid range is between 4 and 7 alphanumeric characters.|
|Intended to use with |
|A text string used to request a toll free vanity number. Valid range is between 4 and 7 alphanumeric characters.|
|A 3-digit wild card pattern for specifying toll free prefixes, comprised of 8 followed by two stars, a digit and a star or two digits|
|If a telephone number or numbers have been previously reserved, the ReservationIdList provides the IDs necessary to release the numbers. This only applies to reserved numbers - if no reservation has been placed on the numbers this list is not required.|
|Attributes to be assigned to the telephone number. Optional parameter. Possible values: |
- Order by Area Code
- Order a Specific Number
Search and Order 1 Number in a specific Area Code
Order a specific Number
ARequest to an existing order will return it's status as well as any information originally used to create the order.
- Order Status Webhook
- Poll for Order Status
Order Status Webhook
This is a webhook that bandwidth sends to your server upon order completion/failure - there is no need to poll the resource if using this recommended method.
Poll Order Information