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

Commit c662c06

Browse files
ajrice6713DX-Bandwidthbandwidthjonadarkbandwidthnirmitpatel
authored
DX-3333 Add Skeleton for new Porting Guides (#956)
* Rename `porting` directory to `porting-old` * DX-3333 Add Skeleton for new Porting Docs * DX-3333 @jgilmore Changes (#964) * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * MV-8384 add campaign vetting status and denial reason to campaign response examples * MV-8384 rename one field * MV-8384 vary responses * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * add porting docs * Format + cleanup to fit DX-3333 structure --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: bandwidthjon <[email protected]> Co-authored-by: adark <[email protected]> Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: Nirmit Patel <[email protected]> Co-authored-by: jgilmore-bw <[email protected]> * Fix broken HTML * Fixing doc links * More doc link fixes * Still fixing doc link issues * Update about.mdx * Update about.mdx * lots of markdown formatting updates * Update site/docs/numbers/porting/about.mdx Co-authored-by: Josh Dunster <[email protected]> * Updates to address Josh's comments. * Update site/docs/numbers/porting/port-ins/about.mdx Co-authored-by: Josh Dunster <[email protected]> * Update site/docs/numbers/porting/port-ins/about.mdx Co-authored-by: Josh Dunster <[email protected]> * remove old porting guides * fix broken links --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: bandwidthjon <[email protected]> Co-authored-by: adark <[email protected]> Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: Nirmit Patel <[email protected]> Co-authored-by: jgilmore-bw <[email protected]> Co-authored-by: jgilmore-bw <[email protected]> Co-authored-by: ckoegel <[email protected]> Co-authored-by: Cameron Koegel <[email protected]> Co-authored-by: Josh Dunster <[email protected]>
1 parent 5e47547 commit c662c06

30 files changed

+2257
-2407
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,8 @@ some_file
2525

2626
# NPM build files for /site since yarn is being used
2727
site/package-lock.json
28+
29+
# Ignore vim files
30+
*.swp
31+
*.swo
32+
~*

site/docs/messaging/campaign-management/csp/campaign-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -800,7 +800,7 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
800800
## Update Campaign TN Relationship
801801

802802
### Assumption
803-
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.
803+
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/porting/port-ins/) guides.
804804

805805
### Request URL
806806
<Highlight color="#079CEE">POST</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/tnoptions</code>

site/docs/messaging/campaign-management/imports/imports-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
290290
## Update Campaign TN Relationship
291291

292292
### Assumption
293-
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.
293+
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/porting/port-ins/) guides.
294294

295295
#### Request URL
296296
<Highlight color="#079CEE">POST</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/tnoptions</code>

site/docs/numbers/porting/about.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
id: about
3+
title: Porting
4+
sidebar_label: Overview
5+
slug: /numbers/porting
6+
description: A general overview of Bandwidth's porting services
7+
keywords:
8+
- bandwidth
9+
- numbers
10+
- porting
11+
hide_title: false
12+
image: "@site/static/img/bw-icon.svg"
13+
---
14+
15+
# Bandwidth Porting Overview
16+
17+
Telephone number porting is the process by which a telephone number is moved from one service provider to another. Bandwidth provides a number of tools and services to make porting telephone numbers as easy as possible.
18+
19+
This section summarizes the Bandwidth tools available for porting automation and provides links that can be used to drill down for more detailed information.
20+
21+
At a high level, Bandwidth provides porting tools in two broad categories: **Port-in** and **Port-out**.
22+
23+
Bandwidth asynchronous APIs like porting use a common pattern that we refer to as “**orders**”. With orders, you can either poll to check the progress, or you can subscribe for **notifications **as the order progresses.
24+
25+
## Port-in
26+
27+
From the Bandwidth perspective, port-in means moving a telephone number from another service provider to Bandwidth, or to one of Bandwidth's off-net partners. It could also mean porting a number from one of Bandwidth’s service provider customers to another of Bandwidth’s service provider customers.
28+
29+
For more detailed information about porting numbers in, please see [Port-ins Overview](/docs/numbers/porting/port-ins/).
30+
31+
## Port-out
32+
33+
Porting out is moving telephone numbers from Bandwidth to another service provider, or to another of Bandwidth’s service provider customers. Port-outs are of interest to the service provider that is porting the number in, or away from Bandwidth, and to Bandwidth customers who want to know which numbers are porting out of their account.
34+
35+
For detailed information about port-out requests (called LSRs) and port-out notifications, please refer to [Port-outs Overview](/docs/numbers/porting/port-outs/).
36+
37+
## Orders
38+
39+
For APIs that can take longer than around 30 seconds, Bandwidth creates an order to track the progress of the API. There are many types of orders, but they all work in basically the same way. The `POST` operation creates the order and returns a unique order-id by which you can refer to the order. Using the order-id, you can `GET`, `PUT`, `PATCH` (in some cases), or `DELETE` the order.
40+
41+
For more information about Orders, please refer to [Order Model](/docs/numbers/porting/orderModel/).
42+
43+
## Notifications
44+
45+
Since orders are asynchronous and can take time to progress through the various states to completion, you have two options for tracking progress. You can either use the `GET` operation with the order-id to poll for the current state of the order, or you can subscribe to notifications about order state changes, or notes. You may subscribe to email notifications, or webhook notifications.
46+
47+
For detailed information about how to subscribe for order notifications, please see [Subscribe/Notify](/apis/numbers/#tag/Subscriptions/operation/CreateSubscriptions/).
48+
49+
## Porting Terminology
50+
51+
For a table of porting terms, please refer to [Porting Terminology](/docs/numbers/porting/terminology/).

site/docs/numbers/porting/createBulkPortins.mdx

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

0 commit comments

Comments
 (0)