AT&T APEX

Mobility APIs Overview

AT&T Partner Exchange Distributors and Solution Providers are now offered the opportunity to integrate their proprietary sales infrastructure with AT&T via the Mobility APIs. These APIs will energize different stages of the sales process by automating a series of tasks. The Mobility APIs enable near-instant data transmission, improving efficiency in processing Mobility Line Configuration, getting Mobility line details, service activation, creating billing accounts, looking up the equipment catalog, port management, and assisting in number change.

Following are the Mobility APIs and their functionalities that are being offered:

Subscriber List API 

The AT&T Mobility Subscriber List API provides the capability for solution providers to help manage the status of their wireless lines by end customer. Solution providers can retrieve a list of subscribers based on specific identifiers and statuses, providing flexible list access and data management. Results can be based on the following parameters: 

  • Foundation Account Number 
  • Billing Account Number 
  • Subscriber Number 
  • Subscriber Status 
Service Activation API

This API provides a mechanism for solution providers to activate a new mobility service. Features include:

  • Activate new mobility services
  • Retrieve information about a service activation request and status
Port Management API 

This API provides the capability for Solution Providers to initiate and manage a phone number port-in request. This process allows subscribers to retain their telephone numbers when switching from another carrier to AT&T.

  • Request a Port-In: Initiates the process of transferring a subscriber’s number from their current carrier to AT&T.
  • Update a Port-In Request: Allows correcting information on the requested port-in.
  • Check the Status of the Port-In Request: Allows for real-time tracking of the request’s status.
  • Cancel a Port-In Request: Allows a port-in request to be canceled.
Billing Account API

The API provides a mechanism for solution providers to create and manage billing accounts to be associated with wireless subscribers. Billing accounts will be used in future requests among other APIs. Some functions include:

  • Create a new billing account.
  • Update information on an existing billing account.
  • Retrieve information regarding a billing account.
Status Change API 

This API provides the capability for Solution Providers to change the subscriber status. It allows Solution Providers to programmatically change the status of a subscriber’s account based on various triggers or criteria, such as non-payment or customer request.

  • Suspend an Active Subscriber: Temporarily disables the subscriber’s access to the service without terminating the account.
  • Resume a Suspended Subscriber: Reactivates and restores access without the need for re-registration or account setup.
  • Cancel an Active Subscriber: Terminates the service in response to prolonged non-payment or breach of terms of service.
  • Restore a Cancelled Subscriber: Re-establishes the subscriber’s account and restores the service (if cancelled within 60 days).
Number Change API 

This API allows a wireless subscriber to change their mobile number based on the service zip code. The options available for this number change include:

  • System Assigned NPA-NXX: The system will automatically assign a new number prefix (NPA-NXX) based on the service area. NPA (Numbering Plan Area) is the area code, and NXX is the central office code.
  • User Selected NPA-NXX: Gives the user the freedom to choose their own area code and central office code within the service zip code.
  • NPA-NXX-Line (Vanity Number): A customizable phone number, often referred to as a ‘vanity’ number. If available, the user can choose a specific number sequence for the last four digits of their number.
Line Configuration API

The AT&T Mobility Line Configuration API provides the capability for solution providers to manage wireless subscriber line configurations efficiently. The features offered by this API are: 

  • Device Update  • Update the device IMEI on record.  • Enforces any device restrictions that may apply.  • Facilitates upgrades to eSIM devices. 
  • Transfer of Billing Responsibility (TOBR)  • Move a subscriber to another billing account.  • Allows for rate plan changes during the transfer process.  • Applies rate plan change restrictions and checks contract term eligibility.  • Financial Implications: Applies any relevant early termination fees. 
  • Update Subscriber Information  • Update the contact’s name on record.  • Modify the primary place of use address of the subscriber. 
  • Voicemail Reset  • Reset the voicemail for a subscriber. 
  • Over-The-Air (OTA) Profile Resend  • Force resends the OTA profile if the device has encountered issues receiving updates.  These options provide flexibility to the subscriber when it comes to changing their phone number. Whether they let the system decide, choose their own, or opt for a vanity number, it all depends on their personal preference and availability within the service zip code.
    Rate Plan Change API 

    This API provides the capability for solution providers to change the subscriber’s rate plan and/or feature codes that is currently on the subscriber’s profile. The features offered by this API are:

    • Switch the primary rate plan:  Switch the primary rate plan on the subscriber’s wireless service line. 
    • Add/Remove auxiliary features: Add/Remove any additional features to the subscriber’s rate plan. 

    Line Details API 

    This API provides the capability for solution providers to retrieve wireless subscriber profile and device details. This includes the current status of the line - whether it’s active, suspended, or cancelled, the associated rate plans and their effective dates, as well as any additional features. These details can be retrieved using one of the following parameters: 

    • Subscriber Number 
    • Subscriber Status 
    • SIM Number 
    • IMEI Number 

    PDP Provisioning API 

    The AT&T Mobility PDP Provisioning API provides the capability for solution providers to provision a custom APN and static IP address on the subscriber’s mobile Packet Data Protocol profile. This API supports bulk tasks so that each request can support provisioning for up to 10 subscribers. The features offered by this API are: 

    • Retrieve available static IP addresses for the packet data profile 
    • Submit IP for provisioning on the packet data profile 
    • Retrieve the provisioning status and result 
    • Remove a static IP from a subscriber’s packet data profile