From 32fe7f6d16f43784b00cb295aa080d39f0674ad9 Mon Sep 17 00:00:00 2001 From: msafronenko Date: Tue, 20 Sep 2022 13:43:37 +0300 Subject: [PATCH 1/2] How to request Numbers reports --- site/docs/numbers/downloadingReports.mdx | 254 ------------- .../numbers/setup-reports/accountReports.mdx | 344 ++++++++++++++++++ .../numbers/setup-reports/billingReports.mdx | 220 +++++++++++ site/sidebar.js | 9 +- site/specs-temp/numbers.json | 4 +- 5 files changed, 574 insertions(+), 257 deletions(-) delete mode 100644 site/docs/numbers/downloadingReports.mdx create mode 100644 site/docs/numbers/setup-reports/accountReports.mdx create mode 100644 site/docs/numbers/setup-reports/billingReports.mdx diff --git a/site/docs/numbers/downloadingReports.mdx b/site/docs/numbers/downloadingReports.mdx deleted file mode 100644 index 10c0ffef0..000000000 --- a/site/docs/numbers/downloadingReports.mdx +++ /dev/null @@ -1,254 +0,0 @@ ---- -id: downloadingReports -title: Downloading Reports -slug: /numbers/guides/downloadingReports -description: How to download billing and usage reports using the Bandwidth APIs -keywords: - - bandwidth - - numbers - - reports -image: '@site/static/img/bw-icon.svg' ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -export const accountId = "{accountId}"; - -export const Highlight = ({children, color}) => ( - - {children} - - ); - -The Bandwidth numbers API allows you to automate the creation and download of certain reports related to account usage. This is handled through various requests to our `/reports` and `/billingReports` endpoints. The available reports for each endpoint are detailed in their respective sections. - -## Account Reports - -A GET request to `https://dashboard.bandwidth.com/api/accounts/{accountId}/reports` will return an XML list of the available report types, their ID number, and a description of each. The report ID needs to be passed in to the URL of the API request to indicate which type of report we want to create. - -A GET request to `https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}` will return details for a specific report, like a description and the parameters needed to define boundaries for the report. - -| Report Name | ID | Description | -|-------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------| -| Full Phone Number Details | 2 | Complete information about all phone numbers within the report’s scope | -| Phone Number Inventory | 4 | A list of all phone numbers associated with an account | -| E911 Phone Number Details | 6 | E911 information associated with phone numbers within the report’s scope | -| Port-out Orders | 8 | Phone number details for historic or current port-out orders | -| Port-in Orders | 14 | Phone number details for historic or current port-in orders | -| UC Account Summary | 16 | Detailed account information for a given UC account | -| User Information | 24 | Information about all active and inactive users for a given account | -| Disconnected Phone Numbers | 30 | Information about all phone numbers that have been disconnected from the account | -| External Phone Number Details | 31 | Complete information about customer provided phone numbers within the report’s scope | -| End-User Phone Number Assignment | 34 | A list of phone numbers and their end-user assignment statuses | -| Alternate Caller ID E911 Report | 36 | E911 detail information for accounts that use an alternative identifier for the end user | -| E911 Addresses | 42 | A list of all E911 addresses provisioned to an account. The list of addresses shown are only for Dynamic Location Routing-enabled accounts. | -| Number Utilization Telephone Number List Report | 47 | This report will list all of the Telephone Numbers that appear to be under-utilized and unassigned | -| Iris Account Number Utilization Report | 48 | This account report will provide insight into the current utilization and assignment data associated with the Bandwidth Dashboard TN inventory | -| Protected Phone Numbers Report | 50 | This report will provide a simple report that lists all of the protected TNs on an account, as well as their status | -| New Numbers | 59 | Phone number details for historic or current new number orders | -| International TN Inventory Summary | 64 | Summary of international telephone numbers | -| Telephone Number Route Plan Report | 65 | This report lists all of the route plans that are active for the indicated account | - -### Request a Report {#request-account-report} -Once the ID of the report you are looking to generate is ascertained, A POST request to `https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances` will trigger the generation of a new report and return a `201` response with a location header containing a URL used to query the status of the report. - -> Request - -```xml -POST https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instancess HTTP/1.1 -Content-Type: application/xml; charset=utf-8 -Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= - - - pdf - - - Account - 1 - - - Sub-account - 1 - - - MultiValueEnum - value1 - value2 - - - 2020-11-25 - - -``` - -> Response - -```http -HTTP/1.1 201 Created -Content-Type: application/xml; charset=utf-8 -Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/789 -``` -### Query Report Status {#status-account-report} -Using the URL received in the HTTP response from our first POST request, we can make a request to query the API for the status of our report's generation. - -> Request - -```http -GET https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/789 HTTP/1.1 -Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= -``` - -> Response - -```http -HTTP/1.1 200 OK -Content-Type: application/xml; charset=utf-8 - - - - - 100102 - 100020 - Sample Report - pdf - user - 2020-9-19 11:05:12 - - - AccountId - 1 - - - Ready - 2020-11-25 - - -``` - -### Download the Report {#download-account-report} -Once the report status query returns `Ready`, we are ready to download the requested report. This can be done by making a GET request to the URI received in the location header of the response to our original POST request, and appending it with `/file`. You can receive one of two successful responses: `200 OK` or `307 Temporary Redirect`. Ensure that your client is configured to omit the `Authorization` header when following cross-origin redirects returned by this endpoint, as the redirect URL includes auth in the query parameters. Requests to the redirect url that include multiple auth mechanisms will be rejected with `400 Bad Request`. - -> Request - -```http -GET https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/789/file HTTP/1.1 -Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= -``` - -> OK Response - -The 200 response will include a `Content-Disposition` header indicating the filename, and a download of the file will begin. - -```http -HTTP/1.1 200 OK -Content-Disposition: attachment; filename=output.pdf -``` - -> Temporary Redirect Response - -The 307 response will include a `Location` header that includes the link to the file. Follow the link in order to download the file. - -```http -HTTP/1.1 307 Temporary Redirect -Location: -``` - -## Billing Reports - -These reports return information about billable events that occured on your Bandwidth account and associated telephone numbers. - -| Report Type | Description | -|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| BDR | Billing Detail Records for Voice Services - per call information, available on day to day basis - may not reflect final invoice | -| MDR | Message Detail Records - per message information - may not reflect final invoice | -| INVOICE | A copy of the invoice file or files for the specified date range | -| STMTBDR | BDR records that are aligned with the invoice for Voice Services | -| DIDSNAP | A list of telephone numbers, aligned with invoice | -| DIDSNAP_MSG | A list of telephone numbers that are enabled for messaging, aligned with invoice | -| RECORDINGBDR | Billing Detail Records for Recording Services - per recording information, available on day to day basis | -| RECORDINGSTMTBDR | BDR records that are aligned with the invoice for Recording Services | -| TRANSCRIPTIONBDR | Billing Detail Records for Transcription Services - per call transcription information, available on day to day basis | -| TRANSCRIPTIONSTMTBDR | BDR records that are aligned with the invoice for Recording Services | -| CNAMBDR | Record of CNAM Subscribe and Notify queries/dips, available on day to day basis | -| CNAMSTMTBDR | Record of CNAM Subscribe and Notify queries/dips, aligns with invoices | -| CONFBDR | Billing Detail Records for Transcription Services - per conference information, available on day to day basis | -| CONFSTMTBDR | BDR records that are aligned with the invoice for Conferencing Services | -| UNPROVISIONED_CALLS_BDR | BDR for unprovisioned 911 calls that were routed to the ECC | - -### Request a Report {#request-billing-report} -Creating a report starts with a POST request to `https://dashboard.bandwidth.com/api/accounts/{accountId}/billingReports`, detailing the date range for the report as well as type of report you wish to download. A successful response will include a body and location header, which contains a URI with the report ID to be used in later requests. - -> Request - -```xml -POST https://dashboard.bandwidth.com/api/accounts/{accountId}/billingReports HTTP/1.1 -Content-Type: application/xml; charset=utf-8 -Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= - - - BDR - - 2020-05-21 - 2020-05-29 - - -``` -> Response - -```xml -HTTP/1.1 201 Created -Content-Type: application/xml; charset=utf-8 -Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2 - - - - RECEIVED - The report archive is currently being constructed. - -``` - -### Query Report Status {#status-billing-report} -Because of the asynchronous nature of the `/billingReports` endpoint, a POST request does not necessarily mean the report is ready to be consumed. A GET request to the URI received in the location header will return the report status, letting us know if it is ready to be downloaded or not. Expected responses in the `` element are `PROCESSING` and `COMPLETED`. - -> Request - -```http -GET https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2 HTTP/1.1 -Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= -``` -> Response - -```xml -HTTP/1.1 200 OK -Content-Type: application/xml; charset=utf-8 - - - - COMPLETED - The report archive is constructed. - -``` - -### Download the Report {#download-billing-report} -Once the report status query returns `COMPLETED`, we are ready to download the requested report. This can be done by making a GET request to the URI received in the location header of the response to our original POST request, and appending it with `/file` . The 200 response will include a `Content-Disposition` header indicating the filename, and a download of the .zip file will begin. - -> Request - -```http -GET https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2/file HTTP/1.1 -Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= -``` -> Response - -```http -HTTP/1.1 200 OK -Content-Type: application/xml; charset=utf-8 -Content-Disposition: attachment; filename=bdrs_2020-05-21_2020-05-29.zip -``` diff --git a/site/docs/numbers/setup-reports/accountReports.mdx b/site/docs/numbers/setup-reports/accountReports.mdx new file mode 100644 index 000000000..e90c2bb49 --- /dev/null +++ b/site/docs/numbers/setup-reports/accountReports.mdx @@ -0,0 +1,344 @@ +--- +id: accountReports +title: How to request account reports +slug: /numbers/guides/setup-reports/accountReports +description: How to request and download account reports using the Bandwidth APIs +keywords: + - bandwidth + - numbers + - reports + - account +image: '@site/static/img/bw-icon.svg' +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export const accountId = "{accountId}"; +export const reportId = "{reportId}"; +export const instanceId = "{instanceId}"; + +export const Highlight = ({children, color}) => ( + + {children} + + ); + +The Bandwidth numbers API allows you to automate the creation and download of certain reports related to account usage. + +## Available Account Reports + +To list all available account report types with their ID and description, make a GET request to our [List Reports API](../../../../../apis/numbers#tag/Reports/operation/ListReports) endpoint. +The report ID needs to be passed in to the URL of the API request to indicate with type of report to create. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/reports

+ + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports' +-U '{userName}:{password}' +``` + +> Response + +```xml + + + + Report 1 + 10 + Report 1 Description + + + Report 2 + 11 + Report 2 Description + + + +``` + + + + +### Report Details + +To retrieve details for a specific report, like a description and the parameters needed to define boundaries for the report, +make a GET request to our [Retrieve Report API](../../../../../apis/numbers#tag/Reports/operation/RetrieveReport) endpoint. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}

+ + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}' +-U '{userName}:{password}' +``` + +> Response + +```xml + + + 10 + Report 1 + + + Report Parameter + Enum + false + Value1;Value2; + + + Value1 + Display Value2 + + + Value2 + Value2 + + + Report Parameter Description + true + Report Parameter Help Text + + + + +``` + + + + +## Request a Report {#request-account-report} + +To generate a specific report, you must make a POST request to our [Create Report Instance API](../../../../../apis/numbers#tag/accounts/operation/CreateReportInstance) endpoint. +Response will contain a location header used to query the status of the report. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + + + + + +

POSThttps://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instancess

+ +```xml + + pdf + + + Account + 1 + + + Sub-account + 1 + + + MultiValueEnum + value1 + value2 + + + 2020-11-25 + +``` + + + + +```cURL +curl -X POST 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instancess' +-U '{userName}:{password}' +-H 'Content-Type: application/xml' +-d ' + pdf + + + Account + 1 + + + Sub-account + 1 + + + MultiValueEnum + value1 + value2 + + + 2020-11-25 + ' +``` + + + + +> Response + +```http +HTTP/1.1 201 Created +Content-Type: application/xml; charset=utf-8 +Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/789 +``` + +## Fetch Report Status + +Since the Account Report request generation is asynchronous, make a GET request to our [Retrieve Report Instance API](../../../../../apis/numbers#tag/Reports/operation/RetrieveReportInstance) endpoint to determine the status. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/{instanceId}

+ + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/{instanceId}' +-U '{userName}:{password}' +``` + +> Response + +```xml + + + 789 + 10 + Sample Report + pdf + user + 2022-9-16 11:05:12 + + + AccountId + 1 + + + Ready + 2022-10-16 + + +``` + + + + + +## Download the Report + +If the report status is `Ready`, then you are ready to download the requested report. +This can be done by making a GET request to our [Download Report Instance File API](../../../../../apis/numbers#tag/Reports/operation/DownloadReportInstanceFile) endpoint. +There are two possible successful responses: `200 OK` or `307 Temporary Redirect`. + +:::info +Ensure that your client is configured to omit the `Authorization` header when following cross-origin redirects returned by this endpoint, +as the redirect URL includes auth in the query parameters. Requests to the redirect url that include multiple auth mechanisms will be rejected with `400 Bad Request`. +::: + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/{instanceId}/file

+ + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances/{instanceId}/file' +-U '{userName}:{password}' +``` + + + + +#### Response types + + + + + +The `200` response will include a `Content-Disposition` header indicating the filename. Downloading of the file will begin. + +```http +HTTP/1.1 200 OK +Content-Disposition: attachment; filename=output.pdf +``` + + + + + +The 307 response will include a `Location` header that includes the link to the file. Follow the link in order to download the file. + +```http +HTTP/1.1 307 Temporary Redirect +Location: some_file_link +``` + + + + +## Where to next? +Now that you have learned how to request account reports, check out some of the other available actions in our guides: +- [How to request billing reports](/docs/numbers/guides/setup-reports/billingReports) + diff --git a/site/docs/numbers/setup-reports/billingReports.mdx b/site/docs/numbers/setup-reports/billingReports.mdx new file mode 100644 index 000000000..73c3e886f --- /dev/null +++ b/site/docs/numbers/setup-reports/billingReports.mdx @@ -0,0 +1,220 @@ +--- +id: billingReports +title: How to request billing reports +slug: /numbers/guides/setup-reports/billingReports +description: How to request and download billing reports using the Bandwidth APIs +keywords: + - bandwidth + - numbers + - reports +image: '@site/static/img/bw-icon.svg' +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export const accountId = "{accountId}"; +export const reportId = "{reportId}"; +export const instanceId = "{instanceId}"; + +export const Highlight = ({children, color}) => ( + + {children} + + ); + +The Bandwidth numbers API allows you to automate the creation and download of certain billing reports related to account usage. +These reports contain information about billable events that occured on your Bandwidth account and associated telephone numbers. + +## Retrieve Billing Reports + +To retrieve all account billing reports and view possible billing report types, make a GET request to our [List Billing Reports API](../../../../../apis/numbers/#tag/Reports/operation/GetBillingReportByType) endpoint. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports

+ + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports' +-U '{userName}:{password}' +``` + +> Response + +```xml + + + + 5f8734f0-d7c3-445c-b1e2-cdbb620e4ff7 + BDR + some_user + PROCESSING + The requested report archive is still being constructed, please check back later. + 2021-09-16 14:12:16 + + 2021-07-16 + 2021-09-16 + + + + +``` + + + + +## Request a Report {#request-billing-report} + +To generate a billing report with specific date range and type, you must make a POST request to our [Create Billing Report in Range API](../../../../../apis/numbers/#tag/Reports/operation/CreateBillingReport) endpoint. +A successful response will include a body and location header, which contains a URI with the report ID to be used in later requests. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + + + + + +

POSThttps://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports

+ +```xml + + BDR + + 2021-07-16 + 2021-09-16 + + +``` + + + + +```cURL +curl -X POST 'https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports' +-U '{userName}:{password}' +-H 'Content-Type: application/xml' +-d ' + BDR + + 2021-07-16 + 2021-09-16 + + ' +``` + + + + +> Response + +```xml +HTTP/1.1 201 Created +Content-Type: application/xml; charset=utf-8 +Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2 + + + RECEIVED + The report archive is currently being constructed. + +``` + +## Fetch Report Status + +Since the Billing Report request generation is asynchronous, make a GET request to our [Retrieve Report Instance API](../../../../../apis/numbers#tag/Reports/operation/GetBillingReportStatus) endpoint to determine the status. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/{reportId}

+ + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/{reportId}' +-U '{userName}:{password}' +``` + +> Response + +```xml + + COMPLETED + The report archive is constructed. + +``` + + + + +## Download the Report + +If the report status is `COMPLETED`, then you are ready to download the requested report. +This can be done by making a GET request to our [Download Billing Report File API](../../../../../apis/numbers#tag/Reports/operation/DownloadBillingReport) endpoint. +The 200 response will include a `Content-Disposition` header indicating the filename, and a download of the .zip file will begin. + +#### Request URL: + +

GET https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/{reportId}/file

+ + + + + + +```cURL +curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports/{reportId}/file' +-U '{userName}:{password}' +``` + +> Response + +```http +HTTP/1.1 200 OK +Content-Type: application/xml; charset=utf-8 +Content-Disposition: attachment; filename=bdrs_2021-07-16_2021-09-16.zip +``` + + + + + +## Where to next? +Now that you have learned how to request account billing reports, check out some of the other available actions in our guides: +- [How to apply options and features to numbers](/docs/numbers/guides/manage-inventory/applyTnOptionsAndFeatures) diff --git a/site/sidebar.js b/site/sidebar.js index f6f98f503..5f7af04b4 100644 --- a/site/sidebar.js +++ b/site/sidebar.js @@ -71,7 +71,14 @@ module.exports = { }, "numbers/disconnectNumbers", "numbers/lookupNumbers", - "numbers/downloadingReports", + { + type: "category", + label: "How to request Numbers reports", + items: [ + "numbers/setup-reports/accountReports", + "numbers/setup-reports/billingReports", + ] + }, "numbers/lsrOrders", ], }, diff --git a/site/specs-temp/numbers.json b/site/specs-temp/numbers.json index e38cd3e84..9774a647d 100644 --- a/site/specs-temp/numbers.json +++ b/site/specs-temp/numbers.json @@ -1453,7 +1453,7 @@ "tags": [ "Reports" ], - "description": "Retrieve billing report instances within the account scope and billing type. The valid Billing Types are...
  • BDR
  • MDR
  • INVOICE
  • STMTBDR
  • DIDSNAP
  • DIDSNAP_MSG
  • RECORDINGBDR
  • RECORDINGSTMTBDR
  • TRANSCRIPTIONBDR
  • TRANSCRIPTIONSTMTBDR
  • CNAMBDR
  • CNAMSTMTBDR
  • CONFBDR
  • CONFSTMTBDR
  • TFPEERINGSTMTBDR
  • TNLOOKUPBDR
  • TNLOOKUPSTMTBDR
  • MSG_CAMPAIGN_REGISTRY_BDR
  • MSG_CAMPAIGN_CARRIER_ACTIVATION_BDR
  • AMDBDR
  • AMDSTMTBDR
  • SIPURIBDR
  • SIPURISTMTBDR
", + "description": "Retrieve billing report instances within the account scope and billing type. The valid Billing Types are:
Report TypeDescription
BDRBilling Detail Records for Voice Services - per call information, available on day to day basis - may not reflect final invoice
MDRMessage Detail Records - per message information - may not reflect final invoice
INVOICEA copy of the invoice file or files for the specified date range
STMTBDRBDR records that are aligned with the invoice for Voice Services
DIDSNAPA list of telephone numbers, aligned with invoice
DIDSNAP_MSGA list of telephone numbers that are enabled for messaging, aligned with invoice
RECORDINGBDRBilling Detail Records for Recording Services - per recording information, available on day to day basis
RECORDINGSTMTBDRBDR records that are aligned with the invoice for Recording Services
TRANSCRIPTIONBDRBilling Detail Records for Transcription Services - per call transcription information, available on day to day basis
TRANSCRIPTIONSTMTBDRBDR records that are aligned with the invoice for Recording Services
CNAMBDRRecord of CNAM Subscribe and Notify queries/dips, available on day to day basis
CNAMSTMTBDRRecord of CNAM Subscribe and Notify queries/dips, aligns with invoices
CONFBDRBilling Detail Records for Transcription Services - per conference information, available on day to day basis
CONFSTMTBDRBDR records that are aligned with the invoice for Conferencing Services
UNPROVISIONED_CALLS_BDRBDR for unprovisioned 911 calls that were routed to the ECC
", "operationId": "GetBillingReportByType", "summary": "Retrieve billing report by billing type", "parameters": [ @@ -33765,7 +33765,7 @@ "name": "Reports", "externalDocs": { "description": "Reports guide", - "url": "/docs/numbers/guides/downloadingReports/" + "url": "/docs/numbers/guides/setup-reports/accountReports/" } }, { From 900ab49f10e1cb46363bb781ce7c5bcfc21caae1 Mon Sep 17 00:00:00 2001 From: msafronenko Date: Fri, 23 Sep 2022 15:48:56 +0300 Subject: [PATCH 2/2] How to request Numbers reports requested comments --- .../applyTnOptionsAndFeatures.mdx | 6 +++--- .../manage-inventory/searchingNumbers.mdx | 6 +++--- .../numbers/manage-inventory/setFailoverUri.mdx | 4 ++-- .../docs/numbers/searchingAndOrderingNumbers.mdx | 4 ++-- .../numbers/setup-reports/accountReports.mdx | 16 ++++++++-------- .../numbers/setup-reports/billingReports.mdx | 8 ++++---- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/site/docs/numbers/manage-inventory/applyTnOptionsAndFeatures.mdx b/site/docs/numbers/manage-inventory/applyTnOptionsAndFeatures.mdx index 476097a84..f6527a318 100644 --- a/site/docs/numbers/manage-inventory/applyTnOptionsAndFeatures.mdx +++ b/site/docs/numbers/manage-inventory/applyTnOptionsAndFeatures.mdx @@ -358,7 +358,7 @@ values={[ The TnOptions order type is used to apply number options described in the Create TN Options Order section of the API documentation. To create a TN Options Order, make a POST request to our [Create TN Option Order API](/apis/numbers#tag/accounts/operation/CreateTnOptionOrder) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Examples: @@ -471,7 +471,7 @@ curl -X POST 'https://dashboard.bandwidth.com/api/accounts/{accountId}/tnOptions The LIDB Order API allows the updating of CNAM Display (LIDB) information in the network for Bandwidth TNs managed within the customer’s account. This capability works within the same asynchronous work-order mechanism as is used for managing other delay-prone system interactions, where a “work-order” is created by the initial API call, and used as a reference for tracking and confirming the subsequent states, and the ultimate success and failure of the result. To create a LIDB Order, make a POST request to our [Create LIDB Order API](/apis/numbers#tag/accounts/operation/CreateLidbOrder) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Examples: @@ -595,7 +595,7 @@ curl -X POST 'https://dashboard.bandwidth.com/api/accounts/{accountId}/lidbs' The DL/DA API allows a telephone number or group of telephone numbers to be associated with a name and address used for Directory Listing and/or Directory Assistance information. To create a DL/DA Order, make a POST request to our [Create DL/DA Order API](/apis/numbers#tag/accounts/operation/CreateDldaOrder) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Examples: diff --git a/site/docs/numbers/manage-inventory/searchingNumbers.mdx b/site/docs/numbers/manage-inventory/searchingNumbers.mdx index 6ad3abd07..f3453a2c5 100644 --- a/site/docs/numbers/manage-inventory/searchingNumbers.mdx +++ b/site/docs/numbers/manage-inventory/searchingNumbers.mdx @@ -41,7 +41,7 @@ In this guide, we will show you how to search telephone numbers across your Band ## Search All Numbers To search telephone numbers and view possible search parameters, make a GET request to our [List Numbers API](/apis/numbers#tag/accounts/operation/ListTnsByGet) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. ### Search Types You can use a combination of these parameters for a more specific search. @@ -681,7 +681,7 @@ curl 'https://dashboard.bandwidth.com/api/tns?tier=1' ## Search for Specific Numbers To search for specific telephone numbers, make a POST request to our [List Numbers API](/apis/numbers#tag/accounts/operation/ListTnsByPost) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Request URL: @@ -768,7 +768,7 @@ curl -X POST 'https://dashboard.bandwidth.com/api/tns' To show specific number details, use one of our endpoints described in the list below. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. ### TN Details Requests diff --git a/site/docs/numbers/manage-inventory/setFailoverUri.mdx b/site/docs/numbers/manage-inventory/setFailoverUri.mdx index 76264df2a..151c1a9f6 100644 --- a/site/docs/numbers/manage-inventory/setFailoverUri.mdx +++ b/site/docs/numbers/manage-inventory/setFailoverUri.mdx @@ -60,7 +60,7 @@ values={[ To setup a failover for a location (sip-peer), make a PUT request to our [Update SipPeer API](/apis/numbers#tag/accounts/operation/UpdateSipPeer) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. :::danger This PUT request is idempotent - it will overwrite the existing location (sip-peer) settings when made so be sure to include any previous settings that must persist on the location or you risk replacing them with their default `null` values @@ -121,7 +121,7 @@ HTTP 200 OK To setup a failover for a Single Number/Group of Numbers, make a POST request to our [Create TN Option Order API](/apis/numbers#tag/accounts/operation/CreateTnOptionOrder) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. * Sip URI Format: `name@ip-address:port` * PSTN Format: `3332221111` diff --git a/site/docs/numbers/searchingAndOrderingNumbers.mdx b/site/docs/numbers/searchingAndOrderingNumbers.mdx index acbf25464..0c3c65ed1 100644 --- a/site/docs/numbers/searchingAndOrderingNumbers.mdx +++ b/site/docs/numbers/searchingAndOrderingNumbers.mdx @@ -38,7 +38,7 @@ Bandwidth's available number searches with local calling enabled by default. (Th ### Search Parameters To search for an available number and view possible search parameters, make a GET request to our [Available Numbers API](../../../../apis/numbers#tag/accounts/operation/GetAvailableTns) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. You can use a combination of path parameters for different type of search. @@ -718,7 +718,7 @@ You can also search and order numbers simultaneously by setting the `orderType` In this example, we will show how to create an order for numbers that were found using the search. To order numbers, you must make a POST request to our [Order Numbers API](../../../../apis/numbers#tag/accounts/operation/CreateOrder) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. ### Request URL diff --git a/site/docs/numbers/setup-reports/accountReports.mdx b/site/docs/numbers/setup-reports/accountReports.mdx index e90c2bb49..ba8210019 100644 --- a/site/docs/numbers/setup-reports/accountReports.mdx +++ b/site/docs/numbers/setup-reports/accountReports.mdx @@ -35,8 +35,8 @@ The Bandwidth numbers API allows you to automate the creation and download of ce ## Available Account Reports To list all available account report types with their ID and description, make a GET request to our [List Reports API](../../../../../apis/numbers#tag/Reports/operation/ListReports) endpoint. -The report ID needs to be passed in to the URL of the API request to indicate with type of report to create. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +The report ID needs to be passed in to the URL of the API request to indicate which type of report to create. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Request URL: @@ -83,7 +83,7 @@ curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports' To retrieve details for a specific report, like a description and the parameters needed to define boundaries for the report, make a GET request to our [Retrieve Report API](../../../../../apis/numbers#tag/Reports/operation/RetrieveReport) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Request URL: @@ -144,7 +144,7 @@ curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId To generate a specific report, you must make a POST request to our [Create Report Instance API](../../../../../apis/numbers#tag/accounts/operation/CreateReportInstance) endpoint. Response will contain a location header used to query the status of the report. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. -

POSThttps://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instancess

+

POSThttps://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances

```xml @@ -185,7 +185,7 @@ values={[ ```cURL -curl -X POST 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instancess' +curl -X POST 'https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{reportId}/instances' -U '{userName}:{password}' -H 'Content-Type: application/xml' -d ' @@ -222,8 +222,8 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/reports/{repo ## Fetch Report Status -Since the Account Report request generation is asynchronous, make a GET request to our [Retrieve Report Instance API](../../../../../apis/numbers#tag/Reports/operation/RetrieveReportInstance) endpoint to determine the status. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +Since the account report request generation is asynchronous, make a GET request to our [Retrieve Report Instance API](../../../../../apis/numbers#tag/Reports/operation/RetrieveReportInstance) endpoint to determine the status. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Request URL: diff --git a/site/docs/numbers/setup-reports/billingReports.mdx b/site/docs/numbers/setup-reports/billingReports.mdx index 73c3e886f..7f963bc05 100644 --- a/site/docs/numbers/setup-reports/billingReports.mdx +++ b/site/docs/numbers/setup-reports/billingReports.mdx @@ -35,7 +35,7 @@ These reports contain information about billable events that occured on your Ban ## Retrieve Billing Reports To retrieve all account billing reports and view possible billing report types, make a GET request to our [List Billing Reports API](../../../../../apis/numbers/#tag/Reports/operation/GetBillingReportByType) endpoint. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Request URL: @@ -84,7 +84,7 @@ curl 'https://dashboard.bandwidth.com/api/accounts/{accountId}/billingreports' To generate a billing report with specific date range and type, you must make a POST request to our [Create Billing Report in Range API](../../../../../apis/numbers/#tag/Reports/operation/CreateBillingReport) endpoint. A successful response will include a body and location header, which contains a URI with the report ID to be used in later requests. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. GET request to our [Retrieve Report Instance API](../../../../../apis/numbers#tag/Reports/operation/GetBillingReportStatus) endpoint to determine the status. -This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or in the cURL. +This can be done through tools like [Postman](https://github.com/Bandwidth/postman) or cURL. #### Request URL: @@ -217,4 +217,4 @@ Content-Disposition: attachment; filename=bdrs_2021-07-16_2021-09-16.zip ## Where to next? Now that you have learned how to request account billing reports, check out some of the other available actions in our guides: -- [How to apply options and features to numbers](/docs/numbers/guides/manage-inventory/applyTnOptionsAndFeatures) +- [How to port numbers](/docs/numbers/guides/porting/portingNumbers)