AT&T MVNX API

Quickstart

In this Quickstart, you’ll learn how to make your first authenticated MVNX API request and examine the response data.

1

Access

The MVNX APIs are considered secured controlled services, which are not available through an open internet connection.  When registering to use these APIs, AT&T will work with your network team to provide dedicated line or VPN access between your and AT&T's networks - and these APIs will be accessible via that connection.

2

Security credentials

Upon registering for the MVNX API with AT&T, you will be provided with userName and userPassword security credentials. 

Any API requests should include these credentials within the MessageHeader, SecurityMessageHeader JSON sections to authorize your requests' access. You will see the structure of all API request headers, including the SecurityMessageHeader section, in each API page. This is an example: 

1
2
3
4
5
"SecurityMessageHeader": {
    "userName": "MVNXuser",
    "userPassword": "MVNXpassword"
},
3

Sample request

The InquireMarketServiceArea API request retrieves details about the market service area. This example retrieves details based on zip code 75248, for both CPW and TLG (Care and Telegence) market types.

1
2
3
4
5
6
7
8
9
10
"InquireMarketServiceAreasRequest": {
  "ServiceAreasSelector": {
    "SelectorsWithMarketType": {
      "zipCode": 75248,
      "marketType": "Both"
    }
  },
  "requestType": "Activation"
}
4

Examine the response

The response contains an array of service areas with their details. This is an example of a response showing one service area:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
"Body": {
    "InquireMarketServiceAreasResponse": {
        "city": "DALLAS",
        "state": "TX",
        "region": "WEST",
        "legacyWirelineFootprint": "SBC",
        "zipcode": "75248",
        "county": {
            "countyName": "Dal"
        },
        "ServiceAreas": [
            {
                "localMarketType": "TLG",
                "matchType": "C",
                "distance": "0.0",
                "serviceAreaDescription": "GRANDPRARI",
                "Location": [
                    {
                        "locationMarketType": "NBI",
                        "serviceAreaCode": "008458004066",
                        "market": {
                            "billingMarket": "DLS",
                            "billingSubMarket": "DFW",
                            "marketName": "DALLAS TX",
                            "subMarketName": "DALLAS"
                        }
                    },
                    {
                        "locationMarketType": "Local",
                        "serviceAreaCode": "008458004066",
                        "market": {
                            "billingMarket": "DLS",
                            "billingSubMarket": "DFW",
                            "marketName": "DALLAS TX",
                            "subMarketName": "DALLAS"
                        }
                    }
                ],
                "NumberBlock": [
                    {
                        "npa": "214"
                    },
                    {
                        "npa": "469"
                    },
                    {
                        "npa": "972"
                    }
                ],
                "technology": "GSM"
            }

The details returned in the response will be used in other requests, such as reserving a subscriber number.