AT&T MVNX API

Confirm HLR Registration

Version 1.0.0
download iconDownload spec
View Use Cases

Endpoint

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

Enables Resellers to query the Home Location Register (HLR) for the phone registration information through Snooper Subscriber Object.

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
curl --request POST \
     --url https://lgw.att.com/ConfirmHLRRegistration \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "string",
      "messageId": "string",
      "returnURL": "string",
      "responseTo": "string",
      "timeToLive": 0,
      "originatorId": "string",
      "dateTimeStamp": "2025-04-01T12:11:05.863Z",
      "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
  }
}
'

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
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "string",
      "messageId": "string",
      "returnURL": "string",
      "responseTo": "string",
      "timeToLive": 0,
      "originatorId": "string",
      "dateTimeStamp": "2025-04-01T12:11:05.820Z",
      "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-01T12:11:05.820Z",
      "reRegistrationRequired": false,
      "intialRegistrationIndicator": false,
      "adminDeregistrationSubWithdrawn": false
    }
  }
}