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

Csrs, Disconnects #702

Merged
merged 8 commits into from
Sep 16, 2022
Merged

Csrs, Disconnects #702

merged 8 commits into from
Sep 16, 2022

Conversation

pisaychuk
Copy link
Contributor

⚠️Please do not make any changes to spec files in this repository!⚠️

All spec changes should be done in the api-specs repository.

Please follow the Guide for contributing to our developer documentation.

@pisaychuk pisaychuk requested a review from a team September 7, 2022 12:30
@ajrice6713 ajrice6713 requested a review from rjamesq September 8, 2022 13:27
@gocab-bw gocab-bw self-requested a review September 8, 2022 19:28
@@ -32,19 +32,11 @@ export const Highlight = ({children, color}) => (
Disconnecting a phone number leaves it in all applicable inventories, but makes it available for activation with a new subscriber.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ajrice6713 can you confirm this is correct please :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rjamesq That is correct 😄

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pisaychuk can you update this first sentence please :) it looks like it didn't make it in the updates

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, ok, sorry, didn't get it - for some reason I thought the question was about the original sentence :|

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

Disconnects are asynchronous which means the orders are processed and the order status is updated asynchronously. As times can vary and are not guaranteed 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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Disconnects are asynchronous which means the orders are processed and the order status is updated asynchronously. As times can vary and are not guaranteed 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.
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.

This is a webhook that bandwidth sends to _your_ server upon order completion/failure - there is no need to poll the resource if using this recommended method.
:::

```xml
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The POST request is a little confusing and is inside the response section. We link the guide for subscriptions on other guides, so we should remove the subscriptions example for consistency

@@ -1,7 +1,7 @@
---
id: csrLookupTool
title: CSR Lookup Tool
slug: /numbers/guides/csrLookupTool
slug: /numbers/guides/porting/csrLookupTool
description: How to lookup CSR records using the Bandwidth API
keywords:
- bandwidth
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"This guide will walk you through how to programmatically lookup Customer Service Records (CSRs) for Phone Numbers before porting into your Bandwidth account."

@@ -32,47 +32,18 @@ This walks through how to programmatically lookup Customer Service Records (CSRs

## Polling vs. Webhooks

CSR Orders in the Bandwidth Dashboard are asynchronous when creating an "order". The orders are then processed and the order status is updated asynchronously. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`.
CSR Orders in the Bandwidth Dashboard are asynchronous when creating an "order". The orders are then processed and the order status is updated asynchronously. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
CSR Orders in the Bandwidth Dashboard are asynchronous when creating an "order". The orders are then processed and the order status is updated asynchronously. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`.
CSR Orders in the Bandwidth Dashboard are asynchronous when creating an "order". The orders are then processed and the order status is updated. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`.

@@ -32,47 +32,18 @@ This walks through how to programmatically lookup Customer Service Records (CSRs

## Polling vs. Webhooks

CSR Orders in the Bandwidth Dashboard are asynchronous when creating an "order". The orders are then processed and the order status is updated asynchronously. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`.
CSR Orders in the Bandwidth Dashboard are asynchronous when creating an "order". The orders are then processed and the order status is updated asynchronously. Bandwidth recommends configuring your account with a subscription instead of polling the order resource for `<OrderStatus>`.

Order processing times can vary and are not guaranteed, so bandwidth does __not__ recommend setting a timeout on waiting for an order to show either `COMPLETE` or `FAILED` status, but instead relying on a webhook from a CSR Orders subscription.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Order processing times can vary and are not guaranteed, so bandwidth does __not__ recommend setting a timeout on waiting for an order to show either `COMPLETE` or `FAILED` status, but instead relying on a webhook from a CSR Orders subscription.
Order processing times can vary, so bandwidth does __not__ recommend setting a timeout on waiting for an order to show either `COMPLETE` or `FAILED` status, but instead relying on a webhook from a CSR Orders subscription.

gocab-bw
gocab-bw previously approved these changes Sep 12, 2022
@@ -32,19 +32,11 @@ export const Highlight = ({children, color}) => (
Disconnecting a phone number leaves it in all applicable inventories, but makes it available for activation with a new subscriber.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pisaychuk can you update this first sentence please :) it looks like it didn't make it in the updates

@@ -132,3 +119,6 @@ Content-Type: application/xml; charset=utf-8
</DisconnectTelephoneNumberOrderResponse>

```

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a section at the bottom and link them to "How to search and order a number"

@ajrice6713 ajrice6713 merged commit 558dc2d into Bandwidth:main Sep 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants