AT&T MVNX API

Reserve Subscriber Number

Version 1.0.0
download iconDownload spec
View Use Cases

Endpoint

POST
https://lgw.att.com/ReserveSubscriberNumber

Reserve a subscriber number or block of subscriber numbers for a predetermined time period.

arrowRequest

Body Parameters

Responses

success

arrowBody

application/json

REQUEST

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
curl --request POST \
     --url https://lgw.att.com/ReserveSubscriberNumber \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "221",
      "messageId": "string",
      "returnURL": "string",
      "responseTo": "string",
      "timeToLive": 0,
      "originatorId": "string",
      "dateTimeStamp": "2025-07-01T13:54:58.412Z",
      "conversationId": "string",
      "applicationName": "NMPhysical",
      "originalVersion": "string",
      "uniqueTransactionId": "string",
      "infrastructureVersion": "86",
      "originalInfrastructureVersion": "string"
    },
    "SecurityMessageHeader": {
      "userName": "string",
      "userPassword": "string"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "string",
      "totalInSequence": "string"
    }
  },
  "ReserveSubscriberNumberRequest": {
    "storeId": "string",
    "Subscriber": [
      {
        "Commission": {
          "dealer": {
            "code": "string",
            "secondaryCode": "string"
          },
          "location": "string",
          "customerCode": "string",
          "DualCommission": {
            "creditCheckAgent": "string",
            "creditCheckAgentLocation": "string"
          },
          "salesRepresentative": "string",
          "affiliateSalesRepCode": "string",
          "billingTelephoneNumber": "string"
        },
        "serviceArea": "string",
        "equipmentType": "C",
        "ContactInformation": {
          "Address": {
            "Zip": {
              "zipCode": "string",
              "zipGeoCode": "string",
              "zipCodeExtension": "string"
            },
            "Unit": {
              "unitNumber": "string",
              "unitDesignator": "APT"
            },
            "City": "string",
            "State": "JA",
            "Street": {
              "streetName": "string",
              "streetType": "ALY",
              "streetNumber": "string",
              "streetDirection": "E",
              "streetTrailingDirection": "E"
            },
            "County": {
              "countyName": "string",
              "countyType": "string"
            },
            "Country": "string",
            "Attention": "string",
            "RuralRoute": {
              "ruralRouteBoxNumber": "string",
              "ruralRouteCenterNumber": "string"
            },
            "lastUpdate": "2025-07-01T13:54:58.412Z",
            "addressType": "S",
            "AddressLine1": "string",
            "AddressLine2": "string",
            "PostOfficeBox": "string",
            "fieldIndicator": false,
            "addressSubType": "S",
            "UrbanizationCode": "string",
            "internationalZip": "string",
            "incorporatedIndicator": false,
            "ruralAddressAttention": "string",
            "internationalAddressLine": "string"
          },
          "NameOrBusinessNameSelector": {
            "Name": {
              "lastName": "string",
              "firstName": "string",
              "namePrefix": "string",
              "middleName": "string",
              "nameSuffix": "string",
              "additionalTitle": "string"
            },
            "BusinessName": {
              "contact": {
                "lastName": "string",
                "firstName": "string",
                "namePrefix": "string",
                "middleName": "string",
                "nameSuffix": "string",
                "additionalTitle": "string"
              },
              "businessName": "string"
            }
          }
        },
        "SubscriberNumberOrRandomSelector": {
          "Random": {
            "VanityNumber": {
              "npa": "string",
              "vanityPattern": "string"
            },
            "quantityOfRandomSubscriberNumbers": 0
          },
          "subscriberNumber": "string"
        }
      }
    ],
    "commonOrderId": "string",
    "subscriptionClass": "string",
    "marketServiceDetails": {
      "productType": "C",
      "billingMarket": {
        "localMarket": "string",
        "billingMarket": "string",
        "billingSubMarket": "string"
      },
      "serviceZipCode": "string",
      "billingSystemId": "string"
    },
    "billingAccountNumber": "string"
  }
}
'

RESPONSE

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
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "221",
      "messageId": "",
      "timeToLive": 300000,
      "dateTimeStamp": "2023-08-23T01:14:12Z",
      "conversationId": "XXXXXXXXXXXXXX~CNG-CSI~b1f695c9-6a33-4e4c-90ed-afb67f2325de",
      "applicationName": "NMPhysical",
      "uniqueTransactionId": "ServiceGateway213542@q100csg107c3_cdfcf226-2901-4589-9d8e-6707bc684d06",
      "infrastructureVersion": "86"
    },
    "SecurityMessageHeader": {
      "userName": "[userName]",
      "userPassword": "[userPassword]"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "1",
      "totalInSequence": "1"
    }
  },
  "ReserveSubscriberNumberResponse": {
    "Response": {
      "code": "0",
      "description": "Success"
    },
    "Subscriber": [
      {
        "subscriberNumber": "8036263107",
        "equipmentType": "G",
        "serviceArea": "006901001589",
        "depositAmount": 0,
        "reserved": true
      }
    ]
  }
}