Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 1876af3

Browse files
authored
SWI-1920 Add trailing slashes to relative links (#965)
* Add trailing slashes to relative links * replace leading slashes * fix duplicate slashes and accidental leading slashes * leading slashes * remove ruby guide * fix relative links
1 parent 95b91f6 commit 1876af3

File tree

114 files changed

+627
-628
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+627
-628
lines changed

site/docs/account/about.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Your Bandwidth account is your entrypoint into using Bandwidth's products and se
1919

2020
| Guide | Description |
2121
|:------|:------------|
22-
| [Credentials](./credentials) | How to properly configure API credentials |
23-
| [Structure](./structure) | An overview of Bandwidth's account structure |
24-
| [Setup](./dashboard-setup) | How to set up your Bandwidth Dashboard account |
25-
| [Applications](./applications) | How to configure Applications to receive messaging and voice event webhooks |
26-
| [Subscriptions](./subscriptions) | How to configure Subscriptions to receive number management and porting event webhooks |
22+
| [Credentials](/docs/account/credentials/) | How to properly configure API credentials |
23+
| [Structure](/docs/account/structure/) | An overview of Bandwidth's account structure |
24+
| [Setup](/docs/account/dashboard-setup/) | How to set up your Bandwidth Dashboard account |
25+
| [Applications](/docs/account/applications/) | How to configure Applications to receive messaging and voice event webhooks |
26+
| [Subscriptions](/docs/account/subscriptions/) | How to configure Subscriptions to receive number management and porting event webhooks |
2727

site/docs/account/applications.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ export const Highlight = ({children, color}) => (
3030

3131
Bandwidth uses HTTP webhooks to send message & voice events to any publicly addressable url.
3232

33-
In order to successfully use the Voice & Messaging APIs, you need to configure an `Application` for **both** the [Voice](../../voice) & the [Messaging](../../messaging) APIs.
33+
In order to successfully use the Voice & Messaging APIs, you need to configure an `Application` for **both** the [Voice](/docs/voice/) & the [Messaging](/docs/messaging/) APIs.
3434

3535
Applications are where you configure webhook URLs for Bandwidth to send either message or voice events to your service.
3636

3737
Each application can be assigned to as many Locations (Sip-Peers) as needed. However, each **Location** can only be associated with a single **Application** per service type (Voice or Messaging).
3838

39-
The remainder of this guide covers how to create applications via the API. For a detailed guide to using the UI, please see our [account setup guide](/docs/account/dashboard-setup).
39+
The remainder of this guide covers how to create applications via the API. For a detailed guide to using the UI, please see our [account setup guide](/docs/account/dashboard-setup/).
4040

4141
## Create an Application
4242

@@ -62,9 +62,9 @@ This operation will create an active application.
6262
| `OutboundCallbackCreds.Password` | Messaging | No, but highly recommended | Basic auth `Password`|
6363
| `RequestedCallbackTypes` | Messaging | No | List containing the `CallbackTypes` you wish to receive at the `OutboundCallbackUrl`. |
6464
| `RequestedCallbackTypes.CallbackType` | Messaging | No | `message-delivered`, `message-sending`, `message-failed` |
65-
| `CallInitiatedCallbackUrl` | Voice | Yes, for `Voice-V2` | Url to receive [initiate events](../voice/webhooks/initiate.mdx) for inbound calls |
65+
| `CallInitiatedCallbackUrl` | Voice | Yes, for `Voice-V2` | Url to receive [initiate events](/docs/voice/webhooks/initiate/) for inbound calls |
6666
| `CallInitiatedMethod` | Voice | No | HTTP method for events sent to the `CallInitiatedCallbackUrl`.<br/> <Highlight color="#079CEE">POST</Highlight> or <Highlight color="#00bf8c">GET</Highlight><br/><br/>Default is <Highlight color="#079CEE">POST</Highlight> |
67-
| `CallStatusCallbackUrl` | Voice | No | Url to receive [disconnect events](../voice/webhooks/disconnect.mdx) for inbound calls |
67+
| `CallStatusCallbackUrl` | Voice | No | Url to receive [disconnect events](/docs/voice/webhooks/disconnect/) for inbound calls |
6868
| `CallStatusMethod` | Voice | No | HTTP method for events sent to the `CallStatusCallbackUrl`.<br/> <Highlight color="#079CEE">POST</Highlight> or <Highlight color="#00bf8c">GET</Highlight><br/><br/>Default is <Highlight color="#079CEE">POST</Highlight> |
6969
| `CallbackCreds` | Voice | No, but highly recommended | Basic auth credentials to apply to your message & voice events |
7070
| `CallbackCreds.UserId` | Voice | No, but highly recommended | Basic auth `UserId` |

site/docs/account/dashboard-setup.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ keywords:
1515
image: '@site/static/img/bw-icon.svg'
1616
---
1717

18-
This walks through how to setup and configure your Bandwidth account through the [Bandwidth Dashboard](https://dashboard.bandwidth.com) for use with our [Number Management](../../numbers), [HTTP Voice](../../voice), and [HTTP Messaging](../../messaging) APIs.
18+
This walks through how to setup and configure your Bandwidth account through the [Bandwidth Dashboard](https://dashboard.bandwidth.com) for use with our [Number Management](/docs/numbers/), [HTTP Voice](/docs/voice/), and [HTTP Messaging](/docs/messaging/) APIs.
1919

2020
Now that we’ve covered the [hierarchical structure](structure.md) of your Bandwidth Dashboard account, let’s talk about how to complete your set-up.
2121

2222
Bandwidth recommends that all new users complete their account set-up using the Bandwidth Dashboard user interface to best get acquainted with our unique account structure.
2323

24-
After you’ve familiarized yourself with these concepts, you may want to automate your set-up and [programmatically configure](../programmatic-setup) your Sub-Accounts, Locations & Applications.
24+
After you’ve familiarized yourself with these concepts, you may want to automate your set-up and [programmatically configure](/docs/account/programmatic-setup/) your Sub-Accounts, Locations & Applications.
2525

2626
## Assumptions
2727
* You have been contracted and given access to your Bandwidth Dashboard Account
@@ -85,7 +85,7 @@ For a self-guided training tutorial, click on **Learning Lab & Support** in the
8585
![Account Setup 2](@site/static/img/docs-diagrams/account/setup-2.png)
8686

8787
:::info
88-
For more information about our applications API, check out our [Applications Guide](../applications).
88+
For more information about our applications API, check out our [Applications Guide](/docs/account/applications/).
8989
:::
9090

9191
### Create a Voice Application
@@ -212,11 +212,11 @@ Now that your Account is set up, you’re ready to order a phone number and begi
212212

213213
For a guide on ordering phone numbers in the Bandwidth Dashboard, [click here](https://support.bandwidth.com/hc/en-us/articles/360011094753-How-do-I-search-and-order-phone-numbers-)!
214214

215-
For a guide on ordering phone numbers via the Bandwidth Dashboard API, [click here](/docs/numbers/guides/searchingForNumbers)!
215+
For a guide on ordering phone numbers via the Bandwidth Dashboard API, [click here](/docs/numbers/guides/searchingForNumbers/)!
216216

217217
## Next steps
218218
### Create an API-only User
219-
Create an [API-only user](../credentials) to validate your API calls. Unlike user accounts that can access the Bandwidth Dashboard User Interface, users restricted to API only access won’t require periodic password resets.
219+
Create an [API-only user](/docs/account/credentials/) to validate your API calls. Unlike user accounts that can access the Bandwidth Dashboard User Interface, users restricted to API only access won’t require periodic password resets.
220220

221221

222222
### Start Developing to Our Voice and Messaging APIs

site/docs/account/programmatic-setup.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ export const Highlight = ({children, color}) => (
3535
);
3636

3737

38-
This walks through how to setup and configure your Bandwidth account via Bandwidth's [Number Management API](../../numbers) for use with our [HTTP Voice](../../voice), and [HTTP Messaging](../../messaging) APIs.
39-
Unless you are already comfortable with our Number Management API and Bandwidth account structures, it is recommended that you follow our [Dashboard UI Setup Guide](../dashboard-setup) for the Bandwidth Dashboard instead of using this programmatic guide.
38+
This walks through how to setup and configure your Bandwidth account via Bandwidth's [Number Management API](/docs/numbers/) for use with our [HTTP Voice](/docs/voice/), and [HTTP Messaging](/docs/messaging/) APIs.
39+
Unless you are already comfortable with our Number Management API and Bandwidth account structures, it is recommended that you follow our [Dashboard UI Setup Guide](/docs/account/dashboard-setup/) for the Bandwidth Dashboard instead of using this programmatic guide.
4040

4141
## Assumptions
4242
* You have been contracted and given access to your Bandwidth Dashboard Account
@@ -376,14 +376,14 @@ Ordering a phone number and assigning it to a location is necessary to get an ap
376376

377377
For a guide on ordering phone numbers in the Bandwidth Dashboard, [click here](https://support.bandwidth.com/hc/en-us/articles/360011094753-How-do-I-search-and-order-phone-numbers-)!
378378

379-
For a guide on ordering phone numbers via the Bandwidth Dashboard API, [click here](/docs/numbers/guides/searchingForNumbers)!
379+
For a guide on ordering phone numbers via the Bandwidth Dashboard API, [click here](/docs/numbers/guides/searchingForNumbers/)!
380380

381381

382382

383383
## Create an Application
384384
After assigning the phone number you've ordered to a location, you must create a messaging or voice application and assign it to the location that has the phone number you would like to use.
385385
:::info
386-
For more information about our applications API, check out our [Applications Guide](../applications).
386+
For more information about our applications API, check out our [Applications Guide](/docs/account/applications/).
387387
:::
388388

389389
### Create a Messaging Application
@@ -663,4 +663,4 @@ Content-Type: application/xml
663663
```
664664

665665
</TabItem>
666-
</Tabs>
666+
</Tabs>

site/docs/emergency/about.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Please be sure to select the correct APIs & login for the services for which you
3131

3232
| Guide | Description |
3333
|:------|:------------|
34-
| [About Emergency Notifications](/docs/emergency/dashboard/notifications) | Learn about Emergency Notifications |
34+
| [About Emergency Notifications](/docs/emergency/dashboard/notifications/) | Learn about Emergency Notifications |
3535

3636
## 911 Access Dashboard (DASH)
3737

@@ -43,5 +43,5 @@ Please be sure to select the correct APIs & login for the services for which you
4343

4444
| API Reference | Description |
4545
|:------|:------------|
46-
| [DASH API Reference](/apis/dash) | DASH Emergency API Reference |
47-
| [DASH Notifications API Reference](/apis/dash-notifications) | DASH Emergency Notifications API Reference |
46+
| [DASH API Reference](/apis/dash/) | DASH Emergency API Reference |
47+
| [DASH Notifications API Reference](/apis/dash-notifications/) | DASH Emergency Notifications API Reference |

site/docs/emergency/dash/about.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ The [911 Access Dashboard](https://dashboard.dashcs.com/) allows you to easily p
2121
## 911 Access Dashboard Overview
2222
| Guide | Description |
2323
|:------|:------------|
24-
| [DASH API Reference](/apis/dash) | The 911 Access Dashboard API Reference |
25-
| [Emergency Notifications API Reference](/apis/dash-notifications) | The 911 Access Dashboard Emergency Notifications API Reference |
26-
| [SOAP Overview](/docs/emergency/dash/soap) | The SOAP reference for the 911 Access Dashboard |
24+
| [DASH API Reference](/apis/dash/) | The 911 Access Dashboard API Reference |
25+
| [Emergency Notifications API Reference](/apis/dash-notifications/) | The 911 Access Dashboard Emergency Notifications API Reference |
26+
| [SOAP Overview](/docs/emergency/dash/soap/) | The SOAP reference for the 911 Access Dashboard |
2727

2828
Bandwidth’s API is a set of programming instructions and standards for accessing Bandwidth’s web-based application – the [911 Access Dashboard](http://dashboard.dashcs.com/). The API provides a quick and efficient way to manage endpoint configuration.
2929

site/docs/emergency/dash/errors.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Unable to provision DID. Contact Bandwidth Support for assistance.
3434

3535
We ask our customers to self-limit requests to 3 per second. By default, Bandwidth will automatically limit requests for some resource-intensive API operations to 5 requests per second so that the activities of one customer don't impact other customers. The operations that are throttled are:
3636

37-
* [validateLocation](/apis/dash#operation/validateLocation)
38-
* [addLocation](/apis/dash#operation/addLocation)
39-
* [provisionLocation](/apis/dash#operation/provisionLocation)
40-
* [removeLocation](/apis/dash#operation/removeLocation)
41-
* [removeUri](/apis/dash#operation/removeUri)
37+
* [validateLocation](/apis/dash#operation/validateLocation/)
38+
* [addLocation](/apis/dash#operation/addLocation/)
39+
* [provisionLocation](/apis/dash#operation/provisionLocation/)
40+
* [removeLocation](/apis/dash#operation/removeLocation/)
41+
* [removeUri](/apis/dash#operation/removeUri/)
4242

4343
Both SOAP and REST versions of these operations are rate-limited.
4444

site/docs/emergency/dash/usage.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ image: '@site/static/img/bw-icon.svg'
1616

1717
The sequence diagram below shows a hypothetical usage scenario.
1818

19-
* Add some locations by calling the [addLocation](/apis/dash#operation/addLocation) method. You can have multiple locations for one URI. The maximum number of locations for one URI is configured in the system. Contact Bandwidth Support if you need to add more locations than the default three. Each call to [addLocation](/apis/dash#operation/addLocation) returns a Location that has status information so you can see if the location was GEOCODED, and an ID (locationId) that can be used later to uniquely provision or remove the location.
20-
* After calling [addLocation](/apis/dash#operation/addLocation) a few times, use [provisionLocation](/apis/dash#operation/provisionLocation) to set the active location. Send in the locationId to specify what location to provision out of the locations added to the URI. The [provisionLocation](/apis/dash#operation/provisionLocation) call will return another status. A successful call will return PROVISIONED status.
19+
* Add some locations by calling the [addLocation](/apis/dash#operation/addLocation/) method. You can have multiple locations for one URI. The maximum number of locations for one URI is configured in the system. Contact Bandwidth Support if you need to add more locations than the default three. Each call to [addLocation](/apis/dash#operation/addLocation/) returns a Location that has status information so you can see if the location was GEOCODED, and an ID (locationId) that can be used later to uniquely provision or remove the location.
20+
* After calling [addLocation](/apis/dash#operation/addLocation/) a few times, use [provisionLocation](/apis/dash#operation/provisionLocation/) to set the active location. Send in the locationId to specify what location to provision out of the locations added to the URI. The [provisionLocation](/apis/dash#operation/provisionLocation/) call will return another status. A successful call will return PROVISIONED status.
2121
* From this point, at any time you can ask the system what locations are associated with a URI, and the API will send back a collection of locations. If one of them is provisioned, it will have the status of PROVISIONED.
22-
* In this example, we remove a location by sending the locationId to [removeLocation](/apis/dash#operation/removeLocation). The results will come back with a status of REMOVED.
22+
* In this example, we remove a location by sending the locationId to [removeLocation](/apis/dash#operation/removeLocation/). The results will come back with a status of REMOVED.
2323
* Next another location is provisioned. If the locationId is different than what was used before then the system automatically handles unprovisioning the original location.
24-
* Finally, if the number is no longer used, call [removeURI](/apis/dash#operation/removeLocation) to unprovision any active location that is associated with the URI. The method will remove all the locations and the URI from the system.
24+
* Finally, if the number is no longer used, call [removeURI](/apis/dash#operation/removeLocation/) to unprovision any active location that is associated with the URI. The method will remove all the locations and the URI from the system.
2525

2626
![Account Setup 1](@site/static/img/docs-diagrams/emergency/dash-usage-scenario.png)
2727

site/docs/emergency/dashboard/about.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ The [Bandwidth Dashboard](Https://dashboard.bandwidth.com), used for many functi
2222

2323
| Guide | Description |
2424
|:------|:------------|
25-
| [Dynamic Location Routing](/docs/emergency/dashboard/dlr) | 911 Dynamic Location Routing Integration Guide |
26-
| [Emergency Notifications](/docs/emergency/dashboard/notifications) | Configure Emergency Notifications |
25+
| [Dynamic Location Routing](/docs/emergency/dashboard/dlr/) | 911 Dynamic Location Routing Integration Guide |
26+
| [Emergency Notifications](/docs/emergency/dashboard/notifications/) | Configure Emergency Notifications |

site/docs/emergency/dashboard/dlr.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Address validation happens asynchronously and usually takes just a few seconds.
236236
Order Processing times can vary and are not guaranteed, please account for this if you choose to poll the `/e911s/{orderId}` endpoint for status.
237237
:::
238238

239-
If you don’t want to poll for order status, you can set up an HTTP endpoint on your own servers and [subscribe](/docs/account/subscriptions) to `e911s` order status changes. Once that’s done, Bandwidth will send order events to the endpoint you specify. This removes the pain of rechecking an order to see if it’s been updated, although it does require you to run a web service. Please see “/accounts /{accountId}/subscriptions” in our dev docs for more information.
239+
If you don’t want to poll for order status, you can set up an HTTP endpoint on your own servers and [subscribe](/docs/account/subscriptions/) to `e911s` order status changes. Once that’s done, Bandwidth will send order events to the endpoint you specify. This removes the pain of rechecking an order to see if it’s been updated, although it does require you to run a web service. Please see “/accounts /{accountId}/subscriptions” in our dev docs for more information.
240240

241241
For any addresses that were determined to be invalid, please refer to the ErrorList section in the response body of the GET request. If no ErrorList is present, then all addresses are valid in the order. For any valid address, Bandwidth may adjust the address you passed and convert it to a standardized version. If this happens, the response body in the GET request will indicate for each address whether it was adjusted or not. If you expect to pass the address as location-by-value in the SIP INVITE (see the Making a 933 call with a location value section below), you must use Bandwidth’s version of the standardized address in the SIP INVITE.
242242

0 commit comments

Comments
 (0)