From 6c46f20288706eb90db922bd72d7d69e8a40148b Mon Sep 17 00:00:00 2001 From: Maksym Mateiuk <41195182+maksymmateiuk@users.noreply.github.com> Date: Mon, 26 Sep 2022 22:41:06 +0300 Subject: [PATCH] api_reference-last tags (#729) --- site/specs-temp/numbers.json | 211 +++++++++++++++++++---------------- 1 file changed, 116 insertions(+), 95 deletions(-) diff --git a/site/specs-temp/numbers.json b/site/specs-temp/numbers.json index 3720c8fa5..044439c43 100644 --- a/site/specs-temp/numbers.json +++ b/site/specs-temp/numbers.json @@ -21,7 +21,7 @@ "/accounts/{accountId}": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "

The account is the root resource for many of the operations in the Bandwidth Dashboard API.

The account is represented by an account id, which is the resource that represents a Bandwidth customer, providing a root resource for all of the customer's attributes and services.

The API calls that are used to manage the details of a customer account, and to manage the resources that a Bandwidth customer has access to or control over, are accessed through the /accounts resource.

This API call retrieves information about the account indicated by the Account ID.

", "operationId": "GetAccount", @@ -995,7 +995,7 @@ "/accounts/{accountId}/availableNpaNxx": { "get": { "tags": [ - "/accounts" + "Available Tns" ], "description": "Retrieves a list of available Npa-Nxx telephone numbers.", "operationId": "GetAvailableNpaNxx", @@ -1072,7 +1072,7 @@ "/accounts/{accountId}/availableNumbers": { "get": { "tags": [ - "/accounts" + "Available Tns" ], "description": "Retrieves the phone numbers according to the input parameters.\n

In this table are presented combinations of path parameters for different type of search:

Search TypeRequired ParametersCombinational ParametersOptional Parameters
Area CodeareaCoderateCenter (state required), city (state required), state, lata, zipquantity, enableTNDetail, protected
NPA-NXXnpaNxxrateCenter (state required), city (state required), state, lata, zip, orderByquantity, enableTNDetail, protected
NPA-NXX with Local Calling AreanpaNxxquantity, LCA, enableTNDetail, protected
NPA-NXX-XnpaNxxxrateCenter (state required), city (state required), state, lata, zip, orderByquantity, enableTNDetail, protected
NPA-NXX-X with Local Calling AreanpaNxxxrateCenter (state required), city (state required), state, lata, zipquantity, LCA, enableTNDetail, protected
RateCenterrateCenter, statecity, areaCode/npaNxx/npaNxxx, lata, zip, orderByquantity, enableTNDetail, protected
RateCenter with Local Calling ArearateCenter, statequantity, LCA, enableTNDetail, protected
StatestaterateCenter, city, areaCode/npaNxx/npaNxxx, lata, zipquantity, enableTNDetail, protected
Citystate, cityrateCenter, state, areaCode/npaNxx/npaNxxx, lata, zip, orderByquantity, enableTNDetail, protected
Zip CodeziprateCenter (state required), city (state required), state, areaCode/npaNxx/npaNxxx, lata, orderByquantity, enableTNDetail, protected
LATAlatarateCenter (state required), city (state required), state, areaCode/npaNxx/npaNxxx, zipquantity, enableTNDetail, protected
Local VanitylocalVanitystate, areaCodeendsIn, quantity, protected, enableTNdetails
TollFree VanitytollFreeVanityorderByquantity
TollFree WildCardtollFreeWildCardPatternorderByquantity
", "operationId": "GetAvailableTns", @@ -6275,7 +6275,7 @@ "/accounts/{accountId}/hosts": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve information about the hosts of account, as guided by optional search parameters.", "operationId": "GetHosts", @@ -7596,7 +7596,7 @@ "/accounts/{accountId}/inserviceNumbers": { "get": { "tags": [ - "/accounts" + "In-service Numbers" ], "description": "Retrieves a list of in-service phone numbers associated with the account ID", "summary": "Fetch in-service phone numbers", @@ -7735,7 +7735,7 @@ "/accounts/{accountId}/inserviceNumbers/totals": { "get": { "tags": [ - "/accounts" + "In-service Numbers" ], "description": "Returns the total number of in-service numbers for the given account.", "summary": "Fetch in-service phone numbers count", @@ -7768,7 +7768,7 @@ "/accounts/{accountId}/inserviceNumbers/{tn}": { "get": { "tags": [ - "/accounts" + "In-service Numbers" ], "description": "A GET on the number desired will return a 200 OK if the number is in-service on the account, or a 404 not found.", "summary": "Fetch in-service phone number.", @@ -8643,7 +8643,7 @@ "/accounts/{accountId}/moveTns": { "get": { "tags": [ - "/accounts" + "Move Tns" ], "description": "Retrieves the moveTns orders for the given account ID. A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter is provided, the order results will be limited to the last two years", "summary": "List Move Telephone Numbers orders", @@ -8743,7 +8743,7 @@ }, "post": { "tags": [ - "/accounts" + "Move Tns" ], "description": "Creates a MoveTnsOrder request to move numbers to the given site ID and sippeer ID as specified in the body. A successfully submitted order will have a status of \"RECEIVED\".\nA successfully completed order will have a status of \"COMPLETE\" if all of the telephone numbers were successfully moved and \"PARTIAL\" if some of the telephone numbers were moved. A failed order will have a status of \"FAILED\" and no telephone numbers would have been moved.

\n\n

Numbers can be moved to sites/sippeers of a different account (if the user has access to both accounts and the proper roles). This can be done by specifying the SourceAccountId parameter. The user can also specify how to handle E911 service on the number (if it exists) using the optional e911ServiceAction parameter", "summary": "Move Telephone Numbers", @@ -8801,7 +8801,7 @@ "/accounts/{accountId}/moveTns/{orderId}": { "get": { "tags": [ - "/accounts" + "Move Tns" ], "description": "Retrieve information about a MoveTnsOrder with specified ID", "summary": "Fetching Move Telephone Numbers order status", @@ -8843,7 +8843,7 @@ "/accounts/{accountId}/moveTns/{orderId}/history": { "get": { "tags": [ - "/accounts" + "Move Tns" ], "description": "Retrieves the history of the specified MoveTnsOrder", "summary": "Fetching Move Telephone Numbers order history", @@ -8885,7 +8885,7 @@ "/accounts/{accountId}/numbersAssignment": { "get": { "tags": [ - "/accounts" + "Numbers Assignment" ], "description": "Retrieve a list of the TelephoneNumbersAssignment 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 is provided, the order results will be limited to the last two years.", "summary": "List Telephone Numbers Assignment Orders", @@ -9021,7 +9021,7 @@ }, "post": { "tags": [ - "/accounts" + "Numbers Assignment" ], "description": "Create a TelephoneNumbersAssignment order to register the assignment status of a list of telephone numbers.", "summary": "Telephone Numbers Assignment Order", @@ -9085,7 +9085,7 @@ "/accounts/{accountId}/numbersAssignment/{orderid}": { "get": { "tags": [ - "/accounts" + "Numbers Assignment" ], "description": "Retrieve information about a TelephoneNumbersAssignment order with specified ID.", "summary": "Fetching Telephone Numbers Assignment Order status", @@ -9144,7 +9144,7 @@ "/accounts/{accountId}/orders": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "GET is used to retrieve order ids and order details for previously attempted Telephone Number orders. 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.

Please visit Guides and Tutorials to learn more.

", "operationId": "ListOrders", @@ -9253,7 +9253,7 @@ }, "post": { "tags": [ - "/accounts" + "Orders" ], "description": "A POST creates a request for Telephone Numbers\n
\nA POST on the /orders resource is used to request that the system provide one or more TNs for use by the account. The post creates a new number order record to preserve the request, as well as the response of the Bandwidth Dashboard API to the request. A well-formed POST on the /orders resource will create an order record, and return an order-id string that can be used to uniquely identify the new number order request.

Please visit Guides and Tutorials to learn more.

", "operationId": "CreateOrder", @@ -9369,7 +9369,7 @@ "/accounts/{accountId}/orders/{orderid}": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "GET all of the details associated with an identified order.

Please visit Guides and Tutorials to learn more.

", "operationId": "RetrieveOrder", @@ -9421,7 +9421,7 @@ }, "put": { "tags": [ - "/accounts" + "Orders" ], "description": "With the introduction of Backorder capabilities, new number orders may stay in backordered state while the order is filled. While in this state it is possible to update the modifiable fields in the record, as well as to request that backorder processing of the order be ended.\nThe fields that can be updated are...\n\n\n\nSpecifying a <CloseOrder> value of true will cancel the backorder request, leaving the currently ordered numbers on the account. No further numbers will be added to the account as a result of the order.

Please visit Guides and Tutorials to learn more.

", "operationId": "UpdateOrder", @@ -9483,7 +9483,7 @@ "/accounts/{accountId}/orders/{orderid}/areaCodes": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieves the area codes of the phone numbers from the specified order.

Please visit Guides and Tutorials to learn more.

", "operationId": "ListOrderAreaCodes", @@ -9526,7 +9526,7 @@ "/accounts/{accountId}/orders/{orderid}/npaNxx": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieves the Npa-Nxx of the phone numbers from the specified order.

Please visit Guides and Tutorials to learn more.

", "summary": "List Telephone Number order Npa-Nxx", @@ -9569,7 +9569,7 @@ "/accounts/{accountId}/orders/{orderid}/totals": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieves the total quantity of phone numbers from the specified Telephone Number order.

Please visit Guides and Tutorials to learn more.

", "operationId": "RetrieveOrderTotals", @@ -9612,7 +9612,7 @@ "/accounts/{accountId}/orders/{orderid}/tns": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Returns a list of phone numbers associated with the ID of a given Telephone Number order.

Please visit Guides and Tutorials to learn more.

", "operationId": "ListOrderTns", @@ -9655,7 +9655,7 @@ "/accounts/{accountId}/orders/{orderid}/notes": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieve all notes associated with the order.

Please visit Guides and Tutorials to learn more.

", "operationId": "ListOrderNotes", @@ -9706,7 +9706,7 @@ }, "post": { "tags": [ - "/accounts" + "Orders" ], "description": "Updates the Notes resource by adding a note. Adding a note to order causes a notification to be sent to Bandwidth Operations, so that they may assist as necessary. A note may be up to 500 characters in length.

Please visit Guides and Tutorials to learn more.

", "operationId": "CreateOrderNote", @@ -9767,7 +9767,7 @@ "/accounts/{accountId}/orders/{orderid}/notes/{noteId}": { "put": { "tags": [ - "/accounts" + "Orders" ], "description": "Update a specified note. Notes may only be updated, not deleted.

Please visit Guides and Tutorials to learn more.

", "operationId": "UpdateOrderNote", @@ -9838,7 +9838,7 @@ "/accounts/{accountId}/orders/{orderid}/history": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieve the history information associated with an order.

Please visit Guides and Tutorials to learn more.

", "operationId": "RetrieveOrderHistory", @@ -9897,7 +9897,7 @@ "/accounts/{accountId}/orders/totals": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieves a total number of tn orders.", "summary": "Get New Number Order TN Count Totals", @@ -11789,7 +11789,7 @@ "/accounts/{accountId}/products": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Discover what is currently enabled on the account\n", "operationId": "ListProducts", @@ -11822,7 +11822,7 @@ "/accounts/{accountId}/products/{productName}": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Discover whether product is currently enabled on the account", "operationId": "GetAccountProduct", @@ -11857,7 +11857,7 @@ "/accounts/{accountId}/products/e911/settings": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve the current host and EVS credentials settings that are used only for e911 traffic. This includes host details, EVS account ID information (including accounts where the Dashboard ID differs from the EVS ID), and the EVS route type", "operationId": "GetAccountE911ProductSettings", @@ -11889,7 +11889,7 @@ "/accounts/{accountId}/products/edgemanagement/settings": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve settings that are provided as part of the Edge Management product: The SBC settings that are associated with the account, SipAuthentication that provide settings for SIP authentication and ProductSpecificAccessRestrictions that can restrict Termination traffic for sipCredendital.", "operationId": "GetAccountEdgemanagementProductSettings", @@ -11921,7 +11921,7 @@ "/accounts/{accountId}/products/edgemanagement/settings/sipauthentication": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing SIP authentication configuration on account.", "operationId": "GetAccountEdgemanagementProductSettingsSipauthentication", @@ -11953,7 +11953,7 @@ "/accounts/{accountId}/products/messaging/a2pCampaigns": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing a2pCampaigns configuration on account.", "operationId": "GetAccountMessagingProductA2pCampaings", @@ -11985,7 +11985,7 @@ "/accounts/{accountId}/products/messaging/features/http": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing messaging http configuration on account.", "operationId": "GetAccountMessagingProductFeatureHttp", @@ -12017,7 +12017,7 @@ "/accounts/{accountId}/products/messaging/features/mms": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing messaging mms configuration on account.", "operationId": "GetAccountMessagingProductFeatureMms", @@ -12049,7 +12049,7 @@ "/accounts/{accountId}/products/messaging/features/mms/mm4settings": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing messaging mm4settings configuration on account.", "operationId": "GetAccountMessagingProductFeatureMm4settings", @@ -12081,7 +12081,7 @@ "/accounts/{accountId}/products/messaging/features/mms/settings": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing messaging mms feature settings on account.", "operationId": "GetAccountMessagingProductFeatureMmsSettings", @@ -12113,7 +12113,7 @@ "/accounts/{accountId}/products/messaging/features/sms": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve existing messaging sms configuration on account.", "operationId": "GetAccountMessagingProductFeatureSms", @@ -12145,7 +12145,7 @@ "/accounts/{accountId}/products/messaging/routes": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve the current list of routes associated with the various types of TNs that can be assigned messaging routes. Zero or more routes can be returned for each type of TN; each one of these routes is identified by an NNID, or an ESPID while we transition from ESPIDs to NNIDs.", "operationId": "GetAccountMessagingProductRoutes", @@ -12177,7 +12177,7 @@ "/accounts/{accountId}/products/messaging/settings": { "get": { "tags": [ - "/accounts" + "Account" ], "description": "Retrieve the current settings, indicating is Messaging product enabled now and if yes will Messaging feature be enabled on each new telephone number.", "operationId": "GetAccountMessagingProductSettings", @@ -14339,7 +14339,7 @@ "/accounts/{accountId}/sites": { "get": { "tags": [ - "/accounts" + "Site Management" ], "description": "Retrieve a list of all Sites associated with the account", "summary": "List Sites", @@ -14402,7 +14402,7 @@ }, "post": { "tags": [ - "/accounts" + "Site Management" ], "description": "Add a Site to the account", "summary": "Create Site", @@ -14527,7 +14527,7 @@ "/accounts/{accountId}/sites/{siteId}": { "get": { "tags": [ - "/accounts" + "Site Management" ], "description": "Retrieves the information associated with the Site id", "summary": "Retrieve Site", @@ -14585,7 +14585,7 @@ }, "put": { "tags": [ - "/accounts" + "Site Management" ], "description": "Updates the contents of Site", "summary": "Update Site", @@ -14718,7 +14718,7 @@ }, "delete": { "tags": [ - "/accounts" + "Site Management" ], "description": "Deletes the Site. Sites can only be deleted if there are no SIP Peers attached to it", "summary": "Delete Site", @@ -14763,7 +14763,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve information about a Sip Peer or set of Sip Peers on Site", "summary": "List Sip Peers", @@ -14803,7 +14803,7 @@ }, "post": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create Sip Peer", "summary": "Create Sip Peer", @@ -15049,7 +15049,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieves the information associated with the sip peer id", "summary": "Retrieve Sip Peer", @@ -15107,7 +15107,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Update Sip Peer\nThere are a few rules used to eliminate IP address collisions. The primary restriction is on the ability to share Term IP addresses across the Bandwidth Dashboard API structural elements. Essentially...\n\n\n\nIf the CallingName field is missing from the payload, CNAM will default to false on the Sip Peer", "summary": "Update Sip Peer", @@ -15194,7 +15194,7 @@ }, "delete": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Delete Sip Peer", "summary": "Delete Sip Peer", @@ -15245,7 +15245,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/tns": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve information about a Telephone number or set of Telephone numbers", "summary": "Retrieve Sip Peer TNs", @@ -15301,7 +15301,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/tns/{tn}": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve information about telephone number on Sip Peer", "summary": "Retrieve Sip Peer TN", @@ -15354,7 +15354,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Update settings for a TN allocated to their account", "summary": "Update Sip Peer TN settings", @@ -15441,7 +15441,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/totaltns": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve count of Telephone numbers for Sip Peer", "summary": "Retrieve Sip Peer TNs count", @@ -15503,7 +15503,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "A list of products associated with a Sip Peer", "summary": "Retrieve Sip Peer products", @@ -15548,7 +15548,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/origination/settings": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer Origination settings", "summary": "Retrieve Sip Peer Origination setting", @@ -15594,7 +15594,7 @@ }, "post": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create Sip Peer Origination settings", "summary": "Create Sip Peer Origination setting", @@ -15666,7 +15666,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Update Sip Peer Origination settings

Note: Changing the Voice Protocol from SIP to HTTP will remove Voice Hosts or Voice Host Groups and Termination Hosts, which are configured using API /accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}.

", "summary": "Update Sip Peer Origination setting", @@ -15716,7 +15716,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/termination/settings": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer Termination settings", "summary": "Retrieve Sip Peer Termination setting", @@ -15762,7 +15762,7 @@ }, "post": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create Sip Peer Termination settings", "summary": "Create Sip Peer Termination setting", @@ -15834,7 +15834,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Update Sip Peer Termination settings

Note: Changing the Voice Protocol from SIP to HTTP will remove Voice Hosts or Voice Host Groups and Termination Hosts, which are configured using API /accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}.

", "summary": "Update Sip Peer Termination setting", @@ -15884,7 +15884,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/messaging/features/sms": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer SMS settings", "summary": "Retrieve Sip Peer SMS setting", @@ -15927,7 +15927,7 @@ }, "post": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create Sip Peer SMS settings
\nWarning: settings A2pLongCode as 'ON' or 'OFF' will enforce this value for all tns under target sippeer
\nNote: In case of using SMPP protocol, it may be not possible to add or delete hosts with large subnet masks.
\nHost address may or may not include the subnet mask (/32 is assumed if not specified)\nRegular users can only specify subnets not larger then /20. Updating\nsubnet values larger than /20 requires Bandwidth staff intervention (Bandwidth staff may define subnets upto /14)\nAlso, host address should not intersect with addresses used by other services or other accounts,\notherwise a validation error will occur", "summary": "Create Sip Peer SMS setting", @@ -16008,7 +16008,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Update Sip Peer SMS settings
\nWarning: settings A2pLongCode as 'ON' or 'OFF' will enforce this value for all tns under target sippeer
\nNote: In case of using SMPP protocol, it may be not possible to add or delete hosts with large subnet masks.
\nUpdate smpp host. Host address may or may not include the subnet mask (/32 is assumed if not specified)\nRegular users can only specify subnets not larger then /20. Updating subnet values larger than\n/20 requires Bandwidth staff intervention (Bandwidth staff may define subnets upto /14)\nAlso, host address should not intersect with addresses used by other services or other accounts, otherwise a validation error will occur", "summary": "Update Sip Peer SMS setting", @@ -16089,7 +16089,7 @@ }, "delete": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Delete Sip Peer SMS settings", "summary": "Delete Sip Peer SMS setting", @@ -16137,7 +16137,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/messaging/features/mms": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer MMS settings", "summary": "Retrieve Sip Peer MMS setting", @@ -16180,7 +16180,7 @@ }, "post": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create Sip Peer MMS settings", "summary": "Create Sip Peer MMS setting", @@ -16249,7 +16249,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Update Sip Peer MMS settings", "summary": "Update Sip Peer MMS setting", @@ -16294,7 +16294,7 @@ }, "delete": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Delete Sip Peer MMS settings", "summary": "Delete Sip Peer MMS setting", @@ -16330,7 +16330,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/messaging/features/mms/settings": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer MMS feature settings", "summary": "Retrieve Sip Peer MMS feature setting", @@ -16375,7 +16375,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/messaging/applicationSettings": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer Application settings", "summary": "Retrieve Sip Peer Application setting", @@ -16418,7 +16418,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create/update/delete Sip Peer's application settings
Set the ApplicationsSettings value to 'REMOVE' to unassign application", "summary": "Update Sip Peer Application setting", @@ -16480,7 +16480,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/products/messaging/settings": { "get": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Retrieve Sip Peer Messaging settings", "summary": "Retrieve Sip Peer Messaging setting", @@ -16523,7 +16523,7 @@ }, "put": { "tags": [ - "/accounts" + "SipPeer Management" ], "description": "Create/update/delete Sip Peer's Messaging settings", "summary": "Update Sip Peer Messaging setting", @@ -16594,7 +16594,7 @@ "/accounts/{accountId}/sites/{siteId}/inserviceNumbers": { "get": { "tags": [ - "/accounts" + "In-service Numbers" ], "description": "Retrieves all the telephone numbers currently in-service for the given Site", "summary": "Retrieve Site in-service numbers", @@ -16758,7 +16758,7 @@ "/accounts/{accountId}/sites/{siteId}/orders": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieves all orders associated with the given Site", "summary": "Retrieve Site Orders", @@ -16832,7 +16832,7 @@ "/accounts/{accountId}/sites/{siteId}/orders/{orderId}": { "get": { "tags": [ - "/accounts" + "Orders" ], "description": "Retrieves order information associated with the given Site", "summary": "Retrieve Site Order", @@ -16884,7 +16884,7 @@ "/accounts/{accountId}/sites/{siteId}/orders/{orderid}/tns": { "get": { "tags": [ - "/accounts" + "Tns" ], "description": "Retrieves order TNs associated with the given Site", "summary": "Retrieve Order TNs of Site", @@ -17010,7 +17010,7 @@ "/accounts/{accountId}/sites/{siteId}/totaltns": { "get": { "tags": [ - "/accounts" + "Tns" ], "description": "Retrieves Site telephone numbers total count", "summary": "Retrieve Site TNs count", @@ -17797,7 +17797,7 @@ "/accounts/{accountId}/tnreservation": { "post": { "tags": [ - "/accounts" + "Tn Reservation" ], "description": "Reserves a telephone number for a default time of 4 hours. A successful reservation returns a location header that can be used to retrieve the reservation at a later time.", "operationId": "ReserveTn", @@ -17858,7 +17858,7 @@ "/accounts/{accountId}/tnreservation/{reservationid}": { "get": { "tags": [ - "/accounts" + "Tn Reservation" ], "description": "Retrieves a TN reservation's information.", "operationId": "GetTnReservation", @@ -17897,7 +17897,7 @@ }, "delete": { "tags": [ - "/accounts" + "Tn Reservation" ], "description": "Deletes a TN reservation.", "operationId": "DeleteTnReservation", @@ -18009,7 +18009,7 @@ }, "post": { "tags": [ - "/accounts" + "Porting" ], "description": "A list of toll free telephone numbers submitted to this endpoint will result in that list being broken down as follows: ", "operationId": "CreateTollFreePortingValidation", @@ -18299,7 +18299,7 @@ "/accounts/{accountId}/tnPortoutPasscodes": { "get": { "tags": [ - "/accounts" + "Porting" ], "description": "Retrieve information about one or more Telephone Numbers (TNs) with port out passcode.", "operationId": "GetTnPortOutPasscode", @@ -18366,7 +18366,7 @@ }, "post": { "tags": [ - "/accounts" + "Porting" ], "description": "Retrieve information about one or more Telephone Numbers (TNs), where the TNs are specified in POST body.", "operationId": "Retrieve tn port-out passcodes", @@ -19503,7 +19503,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/movetns": { "post": { "tags": [ - "Tns" + "Move Tns" ], "description": "The POST method moves all telephone numbers specified in the body to the given SIP peer.
The source SIP peer is determined by the Telephone Number, i.e. the PUT method can move multiple numbers from different source SIP peers.
The destination SIP peer is specified in the URL.
NOTE: only a maximum of 5000 Telephone Numbers can be moved in one operation.", "operationId": "CreateSipPeerTelephoneNumberBulk", @@ -19555,7 +19555,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/products/termination": { "get": { "tags": [ - "SipPeer products" + "SipPeer Management" ], "description": "Get all sip peer gateway IPs and subnets", "operationId": "GetSipPeerTerminationProducts", @@ -19616,7 +19616,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/products/termination/hosts": { "get": { "tags": [ - "SipPeer products" + "SipPeer Management" ], "description": "Get all sip peer gateway IPs and subnets", "operationId": "GetSipPeerTerminationGateways", @@ -19655,7 +19655,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/products/termination/hosts/{gatewayId}": { "get": { "tags": [ - "SipPeer products" + "SipPeer Management" ], "description": "Get sip peer gateway IP or subnet by id", "operationId": "GetSipPeerTerminationGateway", @@ -19713,7 +19713,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/products/termination/hosts/{gatewayId}/settings": { "get": { "tags": [ - "SipPeer products" + "SipPeer Management" ], "description": "Get all gateway attributes", "operationId": "GetSipPeerTerminationGatewayAttributes", @@ -19755,7 +19755,7 @@ "/accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/products/termination/hosts/{gatewayId}/settings/{attributeId}": { "get": { "tags": [ - "SipPeer products" + "SipPeer Management" ], "description": "Get gateway attribute by id", "operationId": "GetSipPeerTerminationGatewayAttribute", @@ -33955,6 +33955,9 @@ { "name": "10DLC" }, + { + "name": "Account" + }, { "name": "Addresses" }, @@ -33966,6 +33969,9 @@ "url": "/docs/account/applications/" } }, + { + "name": "Available Tns" + }, { "name": "Bulk Port-In", "description": "Manage bulk port-in orders", @@ -34018,6 +34024,9 @@ { "name": "Import Tn" }, + { + "name": "In-service Numbers" + }, { "name": "LIDB", "description": "LIDB - Line Information DataBase", @@ -34027,7 +34036,13 @@ } }, { - "name": "Rate Centers" + "name": "Move Tns" + }, + { + "name": "Numbers Assignment" + }, + { + "name": "Orders" }, { "name": "Porting", @@ -34037,6 +34052,9 @@ "url": "/docs/numbers/guides/portingNumbers/" } }, + { + "name": "Rate Centers" + }, { "name": "Reports", "externalDocs": { @@ -34052,7 +34070,10 @@ } }, { - "name": "SipPeer products" + "name": "SipPeer Management" + }, + { + "name": "Site Management" }, { "name": "Subscriptions", @@ -34065,10 +34086,10 @@ "name": "Tn Option" }, { - "name": "Tns" + "name": "Tn Reservation" }, { - "name": "/accounts" + "name": "Tns" } ] }