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

Commit

Permalink
Merge pull request #651 from pisaychuk/Porting_guides
Browse files Browse the repository at this point in the history
Porting guides
  • Loading branch information
brianluisgomez authored Sep 6, 2022
2 parents e899047 + 10ffa68 commit b507061
Show file tree
Hide file tree
Showing 18 changed files with 2,435 additions and 865 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
## Update Campaign TN Relationship

### Assumption
This endpoint assumes that TN(s) have already been ordered or ported into our system. For more info, please see [our number ordering](/docs/numbers/guides/searchingForNumbers) or [number porting](/docs/numbers/guides/portingNumbers) guides.
This endpoint assumes that TN(s) have already been ordered or ported into our system. For more info, please see [our number ordering](/docs/numbers/guides/searchingForNumbers) or [number porting](/docs/numbers/guides/porting/portingNumbers) guides.

### Request URL
<Highlight color="#079CEE">POST</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/tnoptions</code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
## Update Campaign TN Relationship

### Assumption
This endpoint assumes that TN(s) have already been ordered or ported into our system. For more info, please see [our number ordering](/docs/numbers/guides/searchingForNumbers) or [number porting](/docs/numbers/guides/portingNumbers) guides.
This endpoint assumes that TN(s) have already been ordered or ported into our system. For more info, please see [our number ordering](/docs/numbers/guides/searchingForNumbers) or [number porting](/docs/numbers/guides/porting/portingNumbers) guides.

#### Request URL
<Highlight color="#079CEE">POST</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/tnoptions</code>
Expand Down
84 changes: 0 additions & 84 deletions site/docs/numbers/bulkportins.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion site/docs/numbers/eventWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ image: '@site/static/img/bw-icon.svg'

The notification webhook API is used to notify customers of events and changes that occur with various feature and service orders that are being processed by the Bandwidth Numbers API on their behalf. In general this notification webhook will be called whenever an **event** occurs.

The event notifications occur when TNs in your account are impacted due to orders outside of your account. For example, a `MESSAGING_LOST` event is reported on a TN with hosted messaging service in your account when a port in order placed by another account on the same TN is executed.
The event notifications occur when TNs in your account are impacted due to orders outside of your account. For example, a `MESSAGING_LOST` event is reported on a TN with hosted messaging service in your account when a port-in order placed by another account on the same TN is executed.

An order placed in your account to remove the TN will NOT report a `MESSAGING_LOST` event. Please see the subscription documentation to understand how to register the notification webhook API with the Bandwidth Numbers API.

Expand Down
6 changes: 3 additions & 3 deletions site/docs/numbers/lsrOrders.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ The payload fields are described below:

| Field | Description |
|:--------------------------|:-------------------------------------|
| `Pon` | The Pon is customer specified order indentifier field. Allowed alphanumeric and "#","-","_". Up to 25 characters long. (required) |
| `CustomerOrderId` | The CustomerOrderId is customer specified order indentifier field. Allowed alphanumeric, spaces and dashes. Up to 40 characters long. (optional) |
| `SPID` | Identifier used in porting process. If account is no multi-SPID option - default with account value, otherwise value is required. Up to 4 characters long. (required |
| `Pon` | The Pon is customer specified order identifier field. Allowed alphanumeric and "#","-","_". Up to 25 characters long. (required) |
| `CustomerOrderId` | The CustomerOrderId is customer specified order identifier field. Allowed alphanumeric, spaces and dashes. Up to 40 characters long. (optional) |
| `SPID` | Identifier used in porting process. If account is no multi-SPID option - default with account value, otherwise value is required. Up to 4 characters long. (required) |
| `BillingTelephoneNumber` | Non-tollfree 10 digit phone number (optional) |
| `RequestedFocDate` | optional (next day if not specified) |
| `SubscriberType` | Subscriber type. BUSINESS | RESEDENTIAL (optional) (RESEDENTIAL if not specified) |
Expand Down
2 changes: 1 addition & 1 deletion site/docs/numbers/orderWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ image: '@site/static/img/bw-icon.svg'

The notification webhook API is used to notify customers of events and changes that occur with various feature and service orders that are being processed by the Bandwidth Numbers API on their behalf. In general this notification webhook will be called whenever an order that is in-scope changes state or has a note added to it. Alternatively, notification webhook will be called whenever a subscribed event occurs

When an order changes OR when numbers in customer account are impacted due to orders placed outside of their account the Bandwidth Dashboard API will POST a pre-defined payload to our customer at the URL that they have defined by use of the `/accounts/{{accountId}}/subscriptions` API call. Please see the subscription documentation to understand how to register the notification webhook API with the Bandwidth Numbers API.
When an order changes OR when numbers in customer account are impacted due to orders placed outside of their account, the Bandwidth Dashboard API will POST a pre-defined payload to our customer at the URL that they have defined by use of the [`/accounts/{accountId}/subscriptions`](/apis/numbers/#operation/CreateSubscriptions) API call. Please see the subscription documentation to understand how to register the notification webhook API with the Bandwidth Numbers API.

### Order Types

Expand Down
Loading

0 comments on commit b507061

Please sign in to comment.