AT&T MVNX API

Basic Activation Tutorial

This tutorial will guide you through the steps of activating a new subscriber.

1

Find out which services we can offer to this subscriber

In this step, we will determine the types of services available to a subscriber based on their location. To do this, we will be using the InquireMarketServiceAreas API endpoint. The objective of this step is to ensure that we only offer relevant services to the subscriber that are available in their area.

To call the InquireMarketServiceAreas API, we will send a request with an activation payload that includes the subscriber's location information and the desired market type.

Example Request Data:

Request type
Activation
Zip code
75248
Market type
Both
Filter to local market
True
2

Add this subscriber and device to the billing system

In this step, we will activate the new subscriber by adding the new subscriber and their device to the billing system. To do this, we will be using the ActivateSubscriberReseller API endpoint. The information about the market service area and device type correspond to the supported services returned in the InquireMarketServiceAreas response.

To call the ActivateSubscriberReseller API, we will send a request with an activation payload that includes subscriber’s device information and contract conditions.

Example Request Data:

Billing market
GAC
Billing sub market
708
Subscriber number
8035612236
Service area
005801001439
Contract term
12
Dealer code
ZG6YD
Term condition
N
Price plan code
P8DN
Offering code
NC001
Equipment type
G
Technology type
LTE
IMEI
353038060000002
SIM
89014104178003620000
Suspend immediate
False
3

Resend the subscriber activation information

This step would be used if a subscriber needs to reactivate their service, for example if they experience network issues, or have a new device. To do this, we will be using the ResendSubscriberActivation API endpoint. For the purposes of this tutorial, the objective of this step is to reactivate this new customer’s service with a new device.

To call the ResendSubscriberActivation API, we will send a request with an activation payload that includes subscriber’s number, which should match the number in the previous step.

Example Request Data:

Subscriber number
8035612236
4

Cancel a subscriber

In this final stage of the API tutorial, we will ensure that the sample subscriber data added in previous steps is properly cleaned up. To accomplish this, we will execute the UpdateSubscriberStatus function in Cancel mode, which effectively removes the newly added subscriber from the system. This step is important as it keeps the tutorial environment clean and organized.

To call the UpdateSubscriberStatus API, we will send a request with an activation payload that includes the sample subscriber number, cancellation mode and reason for the cancellation.

Example Request Data:

Subscriber number
8035612236
Mode
C
Reason code
data cleanup