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

Commit 558dc2d

Browse files
authored
Csrs, Disconnects (#702)
* Csrs, Disconnect * Address PR comments * Address PR comments * Address PR comments * Address review comments
1 parent 7d08d73 commit 558dc2d

File tree

6 files changed

+342
-364
lines changed

6 files changed

+342
-364
lines changed

site/docs/numbers/csrLookupTool.mdx

Lines changed: 0 additions & 260 deletions
This file was deleted.

site/docs/numbers/disconnectNumbers.mdx

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: disconnectNumbers
3-
title: Disconnecting Numbers
3+
title: How to disconnect phone numbers
44
slug: /numbers/guides/disconnectNumbers
55
description: How to disconnect numbers from account using the Bandwidth API
66
keywords:
@@ -10,9 +10,6 @@ keywords:
1010
image: '@site/static/img/bw-icon.svg'
1111
---
1212

13-
import Tabs from '@theme/Tabs';
14-
import TabItem from '@theme/TabItem';
15-
1613
export const accountId = "{accountId}";
1714
export const orderId = "{orderId}";
1815
export const disconnectId = "{disconnectId}";
@@ -29,22 +26,14 @@ export const Highlight = ({children, color}) => (
2926
</span>
3027
);
3128

32-
Disconnecting a phone number leaves it in all applicable inventories, but makes it available for activation with a new subscriber.
29+
To remove a number from your account, disconnect it using the /disconnects endpoint.
3330

3431
## Create a Disconnect Order
32+
To create a disconnect order, you must make a <Highlight color="#079CEE">POST</Highlight> request to our [/disconnects API](/apis/numbers/#operation/CreateDisconnectOrder) endpoint.
3533

3634
### Request URL
3735
<Highlight color="#079CEE">POST</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/disconnects</code>
3836

39-
### Request Parameters
40-
41-
| Parameter | Required | Description |
42-
|:----------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------|
43-
| `Name` | Yes | The name of the order. Max length restricted to 50 characters |
44-
| `TelephoneNumberList` | Yes | A list of telephone numbers to disconnect. |
45-
| `DisconnectMode` | No | The severity of disconnect order. Typically `Normal`. |
46-
| `Protected` | No | Change protected status of telephones during disconnection. Possible values: `TRUE`, `FALSE`, `UNCHANGED`. Typically `UNCHANGED`. |
47-
4837
### Example
4938
> Request
5039
@@ -89,14 +78,12 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/disconnects/d
8978
</DisconnectTelephoneNumberOrderResponse>
9079
```
9180

92-
## Fetching Disconnect Order Status {#get-disconnect-info}
93-
A GET Request to an existing disconnect will return it's status as well as any information originally used to create the disconnect.
81+
## Checking Disconnect Order Status {#get-disconnect-info}
9482

95-
### Request URL
96-
<Highlight color="#00bf8c">GET</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/disconnects/{disconnectId}</code>
83+
Disconnects are asynchronous which means the orders are processed and the order status is updated at a later time. As times can vary, Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`. Please follow the [How to setup Notification Webhook](/docs/numbers/webhooks/orderWebhook) guide.
84+
If you want to poll, you can still use a [GET /disconnects/{disconnectId} request](/apis/numbers/#operation/ReadDisconnectOrder).
9785

98-
### Example
99-
> Request
86+
<Highlight color="#00bf8c">GET</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/disconnects/{disconnectId}</code>
10087

10188
```http
10289
GET https://dashboard.bandwidth.com/api/accounts/{accountId}/disconnects/df2gc2e2-653d-466c-945d-8f292f09ce55 HTTP/1.1
@@ -132,3 +119,9 @@ Content-Type: application/xml; charset=utf-8
132119
</DisconnectTelephoneNumberOrderResponse>
133120

134121
```
122+
123+
## Where to next?
124+
Now that you have learned how to disconnect numbers, check out some of the other available actions in our guides:
125+
- [How to search and order a number](/docs/numbers/guides/searchingForNumbers)
126+
127+

0 commit comments

Comments
 (0)