In this table are presented combinations of path parameters for different type of search:
| Search Type | Required Parameters | Combinational Parameters | Optional Parameters |
|---|---|---|---|
| Area Code | areaCode | rateCenter (state required), city (state required), state, lata, zip | quantity, enableTNDetail, protected |
| NPA-NXX | npaNxx | rateCenter (state required), city (state required), state, lata, zip, orderBy | quantity, enableTNDetail, protected |
| NPA-NXX with Local Calling Area | npaNxx | quantity, LCA, enableTNDetail, protected | |
| NPA-NXX-X | npaNxxx | rateCenter (state required), city (state required), state, lata, zip, orderBy | quantity, enableTNDetail, protected |
| NPA-NXX-X with Local Calling Area | npaNxxx | rateCenter (state required), city (state required), state, lata, zip | quantity, LCA, enableTNDetail, protected |
| RateCenter | rateCenter, state | city, areaCode/npaNxx/npaNxxx, lata, zip, orderBy | quantity, enableTNDetail, protected |
| RateCenter with Local Calling Area | rateCenter, state | quantity, LCA, enableTNDetail, protected | |
| State | state | rateCenter, city, areaCode/npaNxx/npaNxxx, lata, zip | quantity, enableTNDetail, protected |
| City | state, city | rateCenter, state, areaCode/npaNxx/npaNxxx, lata, zip, orderBy | quantity, enableTNDetail, protected |
| Zip Code | zip | rateCenter (state required), city (state required), state, areaCode/npaNxx/npaNxxx, lata, orderBy | quantity, enableTNDetail, protected |
| LATA | lata | rateCenter (state required), city (state required), state, areaCode/npaNxx/npaNxxx, zip | quantity, enableTNDetail, protected |
| Local Vanity | localVanity | state, areaCode | endsIn, quantity, protected, enableTNdetails |
| TollFree Vanity | tollFreeVanity | orderBy | quantity |
| TollFree WildCard | tollFreeWildCardPattern | orderBy | quantity |
The 3-digit area code associated with the TN.
The 6-digit prefix associated with the TN.
The name of the city. NOTE: `State` becomes a required - parameter when searching by `city`.
- example: RALEIGH - in: query - name: city - required: false - schema: - type: string - description:The two-letter abbreviation of the state the RateCenter is in
example: NC in: query @@ -16388,27 +17577,157 @@ paths: responses: '200': content: + application/json: + examples: + NANPA TN Detail: + value: |- + { + "resultCount": 2, + "telephoneNumberDetailList": [ + { + "countryCodeA3": "USA", + "phoneNumberType": "GEOGRAPHIC", + "city": "CARY-RESEARCH TRIANGLE PARK", + "LATA": 426, + "rateCenter": "CARY-RTP", + "state": "NC", + "fullNumber": "+19193716651", + "tier": 0, + "vendorId": 49, + "vendorName": "Bandwidth CLEC" + }, + { + "countryCodeA3": "USA", + "phoneNumberType": "GEOGRAPHIC", + "city": "CARY-RESEARCH TRIANGLE PARK", + "LATA": 426, + "rateCenter": "CARY-RTP", + "state": "NC", + "fullNumber": "+19193716675", + "tier": 0, + "vendorId": 49, + "vendorName": "Bandwidth CLEC" + } + ] + } + Other TN Detail: + value: |- + { + "resultCount": 2, + "telephoneNumberDetailList": [ + { + "countryCodeA3": "NLD", + "phoneNumberType": "GEOGRAPHIC", + "city": "AMSTERDAM", + "areaCode": 20, + "tier": 0, + "fullNumber": "+131208908115" + }, + { + "countryCodeA3": "NLD", + "phoneNumberType": "NATIONAL", + "city": "AMSTERDAM", + "areaCode": 20, + "tier": 0, + "fullNumber": "+131208908116" + } + ] + } + TN Detail Disabled: + value: |- + { + "resultCount": 2, + "telephoneNumberList": [ + "+14354776112" + ] + } + schema: + $ref: '#/components/schemas/SearchResult' application/xml: examples: - example: + NANPA TN Detail: + value: |- + +A list of available numbers is provided. Additional information - is available if the queryParameter enableTNDetail is true. If no - numbers are available an empty SearchResult element is returned.
+ description: Created '400': content: + application/json: + examples: + example: + value: |- + { + "error": { + "code": 4010, + "description": "One of more required search parameters are null or empty, please refer to the api documentation" + } + } + schema: + $ref: '#/components/schemas/SearchResultError' application/xml: examples: example: @@ -16421,204 +17740,11 @@ paths: schema: - $ref: '#/components/schemas/SearchResultErrorWrapper' + $ref: '#/components/schemas/SearchResultError' description:Invalid/missing input parameter
summary: Retrieve available tns tags: - Available Tns - /accounts/{accountId}/bdrs: - post: - deprecated: true - description: >- -Note - this API is being replaced with the /billingreports API - - we strongly recommend that you use that endpoint.
This API - allows the retrieval of a ZIP file containing BDR records for a - specified date range. These BDR records are delivered as a ZIP - compressed comma separated values (CSV) file. The general flow of the - API calls required to retrieve these records is:
The bdr id resource will query the status of the bdr file that is - being generated. There are essentially two responses...
A GET on the BDR ID will - return a still processing indication if the file creation has not - completed, or will redirect to the file to be downloaded.
- operationId: GetBDRStatus - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: bdrid - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - -Retrieve a list of the externalTns orders that are associated with - the account.
A maximum of 1,000 orders can be retrieved per - request. If no date range or specific query parameter (marked by * below) is provided, the order results will be - limited to the last two years.
- operationId: ListExternalTnsOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: The status of the TN Option order being searched for. - example: PARTIAL - in: query - name: status - required: false - schema: - items: - type: string - type: array - - description: A Telephone Number (TN) that is referenced in the order. - example: '+19199918388' - in: query - name: tn - required: true - schema: - type: string - - description: >- - The Customer Order ID is an ID assigned by the account owner to - provide a reference number for the TN Option order. - example: ABCCorp12345 - in: query - name: customerOrderId - required: true - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date after this date will be included. Format is - yyyy-MM-dd. - example: '2013-10-22' - in: query - name: createdDateFrom - required: false - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date before this date will be included. Format is - yyyy-MM-dd. - example: '2013-10-25' - in: query - name: createdDateTo - required: false - schema: - type: string - - description: >- - This search parameter represents the internal Bandwidth Dashboard - API ID that has been assigned to the TN Option Order. This - parameter is the first few characters of the internal ID - the - entire ID does not need to be specified. - example: ed1c0bed-e2 - in: query - name: orderIdFragment - required: true - schema: - type: string - - description: >- - Whether or not the results should be restricted to IMPORT or REMOVE - orders. - example: REMOVE - in: query - name: action - required: false - schema: - type: string - - description: >- - Whether or not the results should be restricted to CARRIER or - SUBSCRIBER orders. - example: SUBSCRIBER - in: query - name: loaType - required: false - schema: - default: ALL - type: string - - description: >- - For Date-based searches, the starting date of a date range - (inclusive) that will be used to find External Tn Orders that were - modified within the date range. It is in the form yyyy-MM-dd. - example: '2013-10-22' - in: query - name: modifiedDateFrom - required: false - schema: - type: string - - description: >- - For Date-based searches, the ending date of a date range (inclusive) - that will be used to find External Tn Orders that were modified - within the date range. It is in the form yyyy-MM-dd. - example: '2013-10-25' - in: query - name: modifiedDateTo - required: false - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - -13552
- 13552
- Create a externalTns order to add or remove telephone numbers - provided by the customer from the Bandwidth network.
Note: the - attempt to import a telephone number that is already present in the - account will not create an error, but will reset all of the - attributes of that telephone number in the Dashboard system as if the - telephone number was being imported for the first time.
- operationId: CreateExternalTnsOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - requestBody: - content: - application/xml: - examples: - example: - value: |- - -Retrieve information about a externalTns order with specified ID.
- operationId: GetExternalTnsOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - -[int]
- The descriptive payload for the externalTns query provides a - broad range of information about the externalTns order identified in - the URL. Included amongst the information - is...
NOT FOUND - the order id does not exist in the system
- summary: Retrieve external tns order - tags: - - External Tn /accounts/{accountId}/geocodeRequest: post: description: >- @@ -24329,7 +25025,7 @@ paths: description: >-Service unavailable - for some reason service is temporary unavailable.
- summary: Validate address + summary: Validate E911 address [NANPA] tags: - Addresses /accounts/{accountId}/hosts: @@ -25850,41 +26546,67 @@ paths: get: description: >- Retrieves a list of in-service phone numbers associated with the account - ID + ID. + + + In this table are presented capabilities that are not universally + available. The following request query parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANPA|city| + + |NANPA|tier| + + |NANPA|npaNxx| + + |NANPA|npaNxxx| + + |NANPA|lata| + + |NANPA|state| + + |NANPA|ratecenter| + + + When the query parameters listed in the table above are passed, only + inservice the North American Numbering Plan phone numbers from are + returned. operationId: ReadInserviceTns parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: The `page` to fetch in a paginated collection - example: 1 - in: query - name: page - required: false - schema: - default: 1 - type: integer - - description: The number of TNs to retrieve - example: 300 - in: query - name: size - required: false - schema: - default: 300 - type: integer + - $ref: '#/components/parameters/pageQueryParam' + - $ref: '#/components/parameters/sizeQueryParam' + - $ref: '#/components/parameters/startdateQueryParam' + - $ref: '#/components/parameters/enddateQueryParam' + - $ref: '#/components/parameters/countryCodeA3QueryParam' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + - $ref: '#/components/parameters/areaCodeQueryParam' + - $ref: '#/components/parameters/cityQueryParam' + - $ref: '#/components/parameters/tierQueryParam' - description: >- - An Area Code search filter - all returned TNs will be in the entered - Area Code - example: 919 +The 6-digit prefix associated with the TN.
The 7-digit prefix associated with the TN.
Please visit Please visit Guides and Tutorials to learn more.
operationId: CreateOrder @@ -28249,7 +28958,7 @@ paths: content: application/xml: examples: - AreaCodeSearchAndOrderType: + AreaCodeSearchAndOrderType [NANPA]: description: >- Allowed ranges ~ [2-9] for the first digit and [0, 9] for both the second and third digits. @@ -28266,7 +28975,7 @@ paths:| Report Type | Report ID | Report Name | Description | Number Region |
|---|---|---|---|---|
| Numbers | 37 | Bandwidth Phone Number Inventory | A list of all telephone numbers in 'Available' status at the time that the report was compiled | NANPA |
| Numbers | 4 | Phone Number Inventory | A list of all phone numbers associated with an account | |
| Numbers | 34 | End-User Phone Number Assignment | A list of phone numbers and their end-user assignment statuses | NANPA |
| Numbers | 50 | Protected Phone Numbers | This report will provide a simple report that lists all of the protected TNs on an account, as well as their status. | NANPA |
| Voice Enabled Numbers | 2 | Voice Phone Number Details | Complete information about all phone numbers within the report’s scope | |
| Voice Enabled Numbers | 65 | Phone Number Route Plan | This report lists all of the route plans that are active for the indicated account | NANPA |
| Voice Enabled Numbers | 48 | Phone Number Utilization | This account report will provide insight into the current utilization and assignment data associated with the Bandwidth Dashboard TN inventory | NANPA |
| Voice Enabled Numbers | 47 | Under-Utilized and Unassigned Phone Numbers | This report will list all of the Telephone Numbers that appear to be under-utilized and unassigned. | NANPA |
| Messaging Enabled Numbers | 67 | Messaging Phone Number Details | Details of phone numbers with active messaging for particular snapshot date | |
| Messaging Enabled Numbers | 31 | External Phone Number Details | Complete information about customer provided phone numbers within the report’s scope | NANPA |
| Emergency Enabled Numbers | 6 | Emergency Services Phone Number Details | Emergency Service information associated with phone numbers within the report’s scope | NANPA |
| Emergency Enabled Numbers | 36 | Alternate Caller ID E911 Report | E911 detail information for accounts that use an alternative identifier for the end user | NANPA |
| Emergency Enabled Numbers | 42 | E911 Dynamic Location Routing Addresses | A list of all E911 addresses provisioned to an account. The list of addresses shown are only for Dynamic Location Routing-enabled accounts. | NANPA |
| Orders | 59 | New Number Orders | Phone number details for historic or current new number orders | |
| Orders | 30 | Disconnect Orders | Information about all phone numbers that have been disconnected from the account | |
| Orders | 14 | Port-in Orders | Phone number details for historic or current port-in orders | |
| Orders | 8 | Port-out Orders | Phone number details for historic or current port-out orders | |
| Account | 16 | UC Account Summary | Detailed account information for a given UC account | NANPA |
| Users | 24 | User Information | Information about all active and inactive users for a given account |
The 6-digit prefix associated with the TN.
The 7-digit prefix associated with the TN.
| Number - attribute | Action value | Description of - action |
|---|---|---|
| LongCode | systemDefault | Removes - the per-TN A2P attributes, and it reverts to the Location/SIP Peer - characteristics. Any values for Class or Campaign ID are not - valid |
| LongCode | asSpecified | Sets - the message class and campaign ID - this is the default if - unspecified |
| LongCode | off | Will - set the TN as a 'P' TN. Any values for Class or Campaign ID are not - valid |
| LongCode | delete | Will - delete the campaign ID from TN. Any values for Class or Campaign ID are - not valid |
| LongCode | unchanged | Do - nothing with respect to - A2P |
| TollFree | systemDefault | Removes - the per-TN A2P attributes, and it reverts to the Location/SIP Peer - characteristics. Any values for Class or Campaign ID are not - valid |
| TollFree | asSpecified | Sets - the message class and campaign ID - this is the default if - unspecified |
| TollFree | off | If the - Togglz value is set to 'on' this is invalid for Toll Free telephone - numbers. Any values for Class or Campaign ID in the payload are invalid. - If the Togglz value is set to off this behaves like and A2P TN, where - the characteristics of the TNs is set to - 'P' |
| TollFree | unchanged | Do - nothing with respect to A2P |
| Action - value | Description of - action |
|---|---|
| asSpecified | Creates/updates the - origination route plan for the TN with route plan details provided in - the request |
| off | Removes the origination route - plan for the TN. Route list is the request must be - empty |
| unchanged | Doesn't update/create the - origination route plan, even when route plan details exist in the - request |
| Action value | Description of - action |
|---|---|
| true | Enables Pindrop integration on each - phone number in the option - group |
| false | Explicitly disables Pindrop - integration on each phone number in the option - group |
| Action - value | Description of - action |
|---|---|
| true | Enables Call Verification on each - phone number in the option - group |
| false | Explicitly disables Call - Verification on each phone number in the option - group |
| Attribute | +Product | +Number Region | +
|---|---|---|
| TelephoneNumbers | ++ | + |
| PortOutPasscode | +Numbers | +NANPA | +
| Protected | +Numbers | +NANPA | +
| OriginationRoutePlan | +Voice | ++ |
| NumberFormat | +Voice | ++ |
| RPIDFormat | +Voice | ++ |
| RewriteUser | +Voice | ++ |
| CallForward | +Voice | ++ |
| FinalDestinationURI | +Voice | ++ |
| PindropEnabled | +Voice | +NANPA | +
| ESPID | +Voice | +NANPA | +
| CallingNameDisplay | +Voice | +NANPA | +
| Sms | +Messaging | ++ |
| A2pSettings | +Messaging | +NANPA | +
| NNID | +Messaging | +NANPA | +
| Number attribute | Action value | Description of action |
|---|---|---|
| LongCode | systemDefault | Removes the per-TN A2P attributes, and it reverts to the Location/SIP Peer characteristics. Any values for Class or Campaign ID are not valid |
| LongCode | asSpecified | Sets the message class and campaign ID - this is the default if unspecified |
| LongCode | off | Will set the TN as a ''P'' TN. Any values for Class or Campaign ID are not valid |
| LongCode | delete | Will delete the campaign ID from TN. Any values for Class or Campaign ID are not valid |
| LongCode | unchanged | Do nothing with respect to A2P |
| TollFree | systemDefault | Removes the per-TN A2P attributes, and it reverts to the Location/SIP Peer characteristics. Any values for Class or Campaign ID are not valid |
| TollFree | asSpecified | Sets the message class and campaign ID - this is the default if unspecified |
| TollFree | off | If the Togglz value is set to ''on'' this is invalid for Toll Free telephone numbers. Any values for Class or Campaign ID in the payload are invalid. If the Togglz value is set to off this behaves like and A2P TN, where the characteristics of the TNs is set to ''P'' |
| TollFree | unchanged | Do nothing with respect to A2P |
| Action value | Description of action |
|---|---|
| asSpecified | Creates/updates the origination route plan for the TN with route plan details provided in the request |
| off | Removes the origination route plan for the TN. Route list is the request must be empty |
| unchanged | Doesn''t update/create the origination route plan, even when route plan details exist in the request |
| Action value | Description of action |
|---|---|
| true | Enables Pindrop integration on each phone number in the option group |
| false | Explicitly disables Pindrop integration on each phone number in the option group |
List losing carriers that a non-NANPA number can be ported from, - given a countryCodeA3 and optional areaCode and phoneNumberType - values.
+List losing carriers that a number can be ported from. This endpoint + is only relevant for non-NANPA number portin orders, which require a + losing carrier to be specified.
operationId: portingLosingCarriers parameters: - - $ref: '#/components/parameters/countryCodeA3QueryParameter' - - $ref: '#/components/parameters/phoneNumberTypeQueryParameter' - - $ref: '#/components/parameters/areaCodeQueryParameter' + - $ref: '#/components/parameters/countryCodeA3QueryParam_eq' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam_eq' + - $ref: '#/components/parameters/areaCodeQueryParam_eq' responses: '200': $ref: '#/components/responses/listOfLosingCarriersResponse' '400': - $ref: >- - #/components/responses/badRequestLosingInvlaidCountryCodeCarriersResponse + $ref: '#/components/responses/badRequestError' '502': - $ref: '#/components/responses/noUpstreamServicesLosingCarriersResponse' - summary: List losing carriers for porting non-NANPA telephone numbers + $ref: '#/components/responses/internalServerError' + summary: List losing carriers tags: - Porting /rateCenters: @@ -42877,34 +43658,97 @@ paths: summary: List Rate Centers tags: - Rate Centers + /restrictions: + get: + description: >- + Information about how services work in various countries and which + restrictions and rules apply. Please consult this information before + buying and configuring your numbers. + operationId: ListRestrictions + parameters: + - $ref: '#/components/parameters/countryCodeA3QueryParam' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + +The 6-digit prefix associated with the TN.
The 7-digit prefix associated with the TN.