Porting Tutorial
This tutorial will guide you through the steps of porting in a subscriber from another carrier.
Inquire port eligibility
In this step, we will determine whether an existing subscriber is eligible to port in their current subscriber number from another service provider. To do this, we will be using the InquirePortEligibilityBySubscriberNumber API endpoint. The objective of this step is to make sure that a subscriber number is eligible for porting before beginning the porting process.
To call the InquirePortEligibilityBySubscriberNumber API, we will send a request with an activation payload that includes the billing market information, subscriber number, and equipment (phone) type.
Example Request Data:
Initiate the porting process
In this step, we will request to port the subscriber number from another service provider. To do this, we will be using the AddPort API endpoint. The objective of this step is to allow the subscriber’s number from a different provider to be used for activating a new subscriber on our system. The information about the subscriber and device correspond to the subscriber that we verified for portability in the previous step.
To call the AddPort API, we will send a request with an activation payload that includes subscriber’s information, device, and porting information. The “npaNxx” and “From line” values together form the subscriber number.
Example Request Data:
Check the submitted port request
This step would be used to check the port request status and confirm that the add port succeeded before they proceed with other subscriber activation step. To do this, we will be using the InquirePort API endpoint. For the purposes of this tutorial, the objective of this step is to illustrate the workflow where you obtain all the data necessary to analyze a current request and attempt to resolve any issues.
To call the InquirePort API, we will send a request with an activation payload that includes subscriber number and billing market, which should match the information in the previous step.
Example Request Data:
Cancel a port request
In this final stage of the API tutorial, we will cancel the previous porting request, since there was a problem with the pin. To do this, we will be using the CancelPort endpoint. Note that you could also try to fix the pin using UpdatePort, and try again, but for the purpose of this tutorial we will cancel the request.
To call the CancelPort API, we will send a request with an activation payload that includes the subscriber number, billing market information, and cancellation information.