AT&T DevEx

Omni APIs Central | Wireless Solutions | Add a Line | Digital PoS

Version 1.0.0 (latest)

Inquire Account Profile

Version 1.0.0
download iconDownload spec

Endpoint

GET
https://eidp-test.att.com/msapi/v1/customer

Retreive Account Profile by subscriber number or billingaccountnumber.

arrowRequest

Header Parameters

              Body Parameters

              Responses

              Successful response with individual data

              arrowBody

              application/json

              REQUEST

              1
2
3
4
5
6
7
8
9
              curl --request GET \
     --url https://eidp-test.att.com/msapi/v1/customer \
     --header 'accept: application/json' \
     --header 'accountNumber: string' \
     --header 'idp-trace-id: string' \
     --header 'idpctx-session-id: string' \
     --header 'serviceType: string' \
     --header 'subscriberNumber: string' \
     --header 'topics: 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
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
              {
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "languageAbility": [
    {
      "languageCode": "string",
      "languageName": "string"
    }
  ],
  "status": "string",
  "contactMedium": [
    {
      "mediumType": "string",
      "isPreferred": false,
      "characteristic": {
        "contactType": "string",
        "phoneNumber": "string",
        "emailAddress": "string",
        "place": {
          "id": "string"
        }
      }
    }
  ],
  "accounts": [
    {
      "id": "string",
      "accountType": "string",
      "accountSubType": "string",
      "liabilityType": "string",
      "businessType": "string",
      "ratingType": "string",
      "serviceType": "string",
      "firstNetIndicator": "string",
      "subscribersCount": 0,
      "accountState": {
        "state": "string"
      },
      "accountLocked": false,
      "extraSecurityCode": "string",
      "fanDetails": {
        "fanId": "string",
        "fanDescription": "string"
      },
      "contact": [
        {
          "contactMedium": [
            {
              "mediumType": "string",
              "isPreferred": false,
              "characteristic": {
                "contactType": "string",
                "phoneNumber": "string",
                "emailAddress": "string",
                "place": {
                  "id": "string"
                }
              }
            }
          ]
        }
      ],
      "bill": {
        "billStructure": {
          "presentationMedia": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "cycleSpecification": {
            "id": "string",
            "name": "string",
            "frequency": "string"
          }
        }
      },
      "subscribers": [
        {
          "status": {
            "status": "string"
          },
          "subscriberType": "string",
          "phoneNumber": "string",
          "isPreferredCTN": false,
          "isFirstNetSubscriber": false,
          "contactMedium": [
            {
              "mediumType": "string",
              "isPreferred": false,
              "characteristic": {
                "contactType": "string",
                "phoneNumber": "string",
                "emailAddress": "string",
                "place": {
                  "id": "string"
                }
              }
            }
          ],
          "profile": {
            "individualId": "string",
            "firstName": "string",
            "lastName": "string"
          },
          "serviceCharacteristic": {
            "devices": [
              {
                "type": "string",
                "imei": "string",
                "imeiType": "string",
                "sim": {
                  "iccid": "string",
                  "imsi": "string"
                }
              }
            ]
          },
          "products": [
            {
              "productOfferingTypeGroup": "string",
              "id": "string",
              "rootProductId": "string",
              "productOfferingId": "string",
              "name": "string",
              "description": "string",
              "status": {
                "status": "string"
              },
              "productCharacteristic": [
                {
                  "name": "string",
                  "value": "string",
                  "valueType": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}