AT&T MVNX API

Provide tailored mobile solutions with our MVNX API

Use our APIs to create unique, customized mobile services that cater to your consumer market .
Get Started

Endpoints

Request

const url = 'https://lgw.att.com/ConfirmHLRRegistration';
const options = {
  method: 'POST',
  headers: {accept: 'application/json', 'content-type': 'application/json'},
  body: JSON.stringify({
    MessageHeader: {
      TrackingMessageHeader: {
        version: 'string',
        messageId: 'string',
        returnURL: 'string',
        responseTo: 'string',
        timeToLive: 0,
        originatorId: 'string',
        dateTimeStamp: '2025-04-16T14:26:54.664Z',
        conversationId: 'string',
        applicationName: 'string',
        originalVersion: 'string',
        uniqueTransactionId: 'string',
        infrastructureVersion: 'string',
        originalInfrastructureVersion: 'string'
      },
      SecurityMessageHeader: {userName: 'string', userPassword: 'string'},
      SequenceMessageHeader: {sequenceNumber: 'string', totalInSequence: 'string'}
    },
    ConfirmHLRRegistrationRequest: {
      QueryTypes: {
        HlrQuery: {hlrId: 'string', hlrIndicator: false},
        UdmQuery: {udmIndicator: false},
        EpcHssQuery: {epcHssId: 'string', epcHssIndicator: false},
        ImsHssQuery: {imsHssId: 'string', imsHssIndicator: false}
      },
      RequestTypes: {imsi: 'string', subscriberNumber: 'string'},
      BillingMarket: {localMarket: 'string', billingMarket: 'string', billingSubMarket: 'string'},
      wirelessLocalLoopIndicator: false
    }
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response

{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "string",
      "messageId": "string",
      "returnURL": "string",
      "responseTo": "string",
      "timeToLive": 0,
      "originatorId": "string",
      "dateTimeStamp": "2025-04-16T14:26:54.659Z",
      "conversationId": "string",
      "applicationName": "string",
      "originalVersion": "string",
      "uniqueTransactionId": "string",
      "infrastructureVersion": "string",
      "routingRegionOverride": [
        {}
      ],
      "originalInfrastructureVersion": "string"
    },
    "SecurityMessageHeader": {
      "userName": "string",
      "userPassword": "string"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "string",
      "totalInSequence": "string"
    }
  },
  "ConfirmHLRRegistrationResponse": {
    "LTE": {
      "dataEnabledIndicator": false,
      "voiceEnabledIndicator": false
    },
    "HSPA": {
      "dataEnabledIndicator": false,
      "voiceEnabledIndicator": false
    },
    "Response": {
      "code": "string",
      "description": "string"
    },
    "HLRProfile": {
      "imsi": "string",
      "Gprs": {
        "netAccess": 0,
        "PDPContext": [
          {
            "ipAddress": "string",
            "qosCOSName": "string",
            "ipAddressType": "string",
            "extendedIpType": "string",
            "extendedIPAddress": "string",
            "packetDataProtocolName": "string"
          }
        ]
      },
      "msisdn": "string",
      "Barring": {
        "incoming": "string",
        "outgoing": "string"
      },
      "MSCDetails": {
        "e164Address": "string",
        "e164Location": "string",
        "mscStateChangeRecord": "string",
        "prevServingMscAddress": "string"
      },
      "VLRDetails": {
        "e164Address": "string",
        "e164Location": "string",
        "currentVLRAttached": "TRUE",
        "prevServingVlrAddress": "string"
      },
      "SGSNDetails": {
        "e164Address": "string",
        "e164Location": "string",
        "currentSGSNAttached": "TRUE",
        "prevServingSgsnAddress": "string"
      },
      "CallingFeatures": {
        "CallerId": [
          {
            "type": "ID",
            "blockMode": 0,
            "activeIndicator": false,
            "overrideIndicator": false,
            "provisionedIndicator": false
          }
        ],
        "CallWaiting": {
          "activeIndicator": false,
          "provisionedIndicator": false
        },
        "CallForwarding": [
          {
            "type": "BUSY",
            "forwardingTN": "string",
            "activeIndicator": false,
            "forwardingRingTime": "string",
            "provisionedIndicator": false
          }
        ],
        "SmsRestrictions": {
          "OriginatingRestriction": {
            "activeIndicator": false,
            "provisionedIndicator": false
          },
          "TerminatingRestriction": {
            "activeIndicator": false,
            "provisionedIndicator": false
          }
        },
        "MultiPartyCalling": {
          "activeIndicator": false,
          "provisionedIndicator": false
        }
      },
      "roamEntitlement": "string",
      "dataRoamEntitlement": "string",
      "camelClassOfServiceName": "string"
    },
    "QueryStatus": {
      "HLR": {
        "messageCode": "string",
        "messageText": "string"
      },
      "UDM": {
        "messageCode": "string",
        "messageText": "string"
      },
      "EPCHSS": {
        "messageCode": "string",
        "messageText": "string"
      },
      "IMSHSS": {
        "messageCode": "string",
        "messageText": "string"
      }
    },
    "IMSHSSProfile": {
      "UserServiceProfile": {
        "initialFilterCriteria": [
          {}
        ],
        "globalServiceProfileId": "string"
      },
      "IPMutimediaDetails": {
        "PublicIdentity": [
          {
            "id": "string",
            "barringIndicator": false,
            "defaultIdIndicator": false,
            "unregisteredServiceIndicator": false
          }
        ],
        "privateIdentity": [
          {}
        ],
        "PrivatePublicIdentity": [
          {
            "id": [
              {}
            ],
            "pairRegistrationStatus": [
              {}
            ]
          }
        ]
      },
      "ImplicitRegistrationSet": {
        "scscfName": [
          {}
        ],
        "impiRefStatus": [
          {}
        ],
        "registrationStatus": [
          {}
        ]
      }
    },
    "EPCHSSProfile": {
      "imsi": "string",
      "imei": "string",
      "msisdn": "string",
      "maxUploadSpeed": "string",
      "maxDownloadSpeed": "string",
      "sgsnAttachStatus": "string",
      "roamingRestrictionsClass": "string",
      "PacketDataProtocolDetails": {
        "defaultName": "string",
        "operatorIdReplacement": "string",
        "AccessPointConfigEntry": [
          {
            "name": "string",
            "serviceClass": "string"
          }
        ]
      },
      "mmeRegistrationAttachStatus": "string",
      "MobilityManagementEntityDetails": {
        "attachStatus": "string",
        "servingMMEName": "string",
        "imsVoiceOverPSS": "string",
        "attachedTimeStamp": "string",
        "servingMMEDestRealm": "string",
        "purgedInMMEIndicator": false,
        "previousServingMMEName": "string"
      }
    },
    "AMFRegistrationProfile": {
      "imsi": "string",
      "imei": "string",
      "msisdn": "string",
      "purgeFlag": false,
      "amfInstanceId": "string",
      "servingAMFName": "string",
      "amfAttachStatus": false,
      "amfRegistrationTime": "2025-04-16T14:26:54.659Z",
      "reRegistrationRequired": false,
      "intialRegistrationIndicator": false,
      "adminDeregistrationSubWithdrawn": false
    }
  }
}

Tailored plans

Target niche markets with tailored plans and services to cater to specific needs. Tailored plans can target consumer groups such as families, students, seniors or travelers.

Tailored plans
Bundled services

Bundled services

Bundle your mobile services with other products such as home internet or home security, to provide your customers with a full range of networking solutions.

Bring your own device (BYOD)

Allow your customers to use their existing devices and phone numbers while using your enhanced carrier services.

BYOD

MVNX APIs

Our RESTful APIs make creating customer solutions a snap. With our APIs you can hand-tailor a wide range of business offerings.

icon-data.svg

Data-only plans

Help customers who primarily use their devices for internet access
icon-emergency-services.svg

Emergency services

Offer a network dedicated to emergency services such as alerts and public safety notifications
icon-niche-market.svg

Niche markets

Provide services and plans tailored to the senior market

Case Studies

“AT&T's MVNX APIs allow us to offer tailored plans for our mobile advertising services.”

James Grant, Chief Information Officer at Fullbridge, providing platforms for creative wireless marketing campaigns.

image-4.jpeg

Get started with AT&T MVNX APIs

With our APIs you can hand-tailor a wide range of business offerings.