AT&T DevEx

MVNX API

Version 4.0.0 (latest)
  • Contact Us

    • createReservation

    Version 4.0.0
    download iconDownload spec

    Endpoint

    POST
    undefined/resourceReservation

    This operation creates a MSISDNReservation entity. Reserves subscriber numbers. (TMF 716)

    arrowSecurity

    oauth2

    Get a JWT Token from AT&T's Azure AD
    authorizationCode:
    scopes:
    tokenUrl:https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token
    authorizationUrl:https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token
    arrowRequest

    Query Parameters

      Header Parameters

            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
            curl --request POST \
     --url 'https://example.com/resourceReservation?@type=string' \
     --header 'accept: string' \
     --header 'authorization: string' \
     --header 'content-type: application/json' \
     --data '
{
  "value": {
    "@type": "MSISDNReservation_Create",
    "serviceArea": "123456789012",
    "relatedParty": [
      {
        "@type": "Commission",
        "dealerCode": "ABCDEF",
        "id": "",
        "role": "Commission",
        "secondaryCode": "GHIJKL"
      }
    ],
    "equipmentType": "G",
    "operationType": "QUERY",
    "marketServiceInfo": {
      "productType": "G",
      "serviceZipCode": "29201"
    },
    "billingAccountNumber": "123456789",
    "subscriberNumberTypeSelector": {
      "random": {
        "quantity": 2,
        "vanityNumber": {
          "npa": "630",
          "vanityPattern": "888"
        }
      }
    }
  },
  "description": "For a given vanityNumber object, this service provides the capability to request a list of available numbers that can be assigned to the subscriber",
  "displayName": "queryVanityRequest",
  "operationType": "QUERY"
}
'

            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
            {
  "value": {
    "@type": "MSISDNReservation",
    "serviceArea": "123456789012",
    "relatedParty": [
      {
        "@type": "Commission",
        "dealerCode": "ABCDEF",
        "id": "",
        "role": "Commission",
        "secondaryCode": "GHIJKL"
      }
    ],
    "equipmentType": "G",
    "reservationItem": [
      {
        "@type": "MSISDNReservationItem",
        "resource": {
          "@type": "MSISDN",
          "equipmentType": "G",
          "serviceArea": "123456789012",
          "value": "7068888080"
        }
      },
      {
        "@type": "MSISDNReservationItem",
        "resource": {
          "@type": "MSISDN",
          "equipmentType": "G",
          "serviceArea": "123456789012",
          "value": "7068880101"
        }
      }
    ],
    "marketServiceInfo": {
      "productType": "G",
      "serviceZipCode": "29201"
    },
    "billingAccountNumber": "123456789",
    "subscriberNumberTypeSelector": {
      "random": {
        "quantity": 2,
        "vanityNumber": {
          "npa": "630",
          "vanityPattern": "888"
        }
      }
    }
  },
  "description": "API response for above \"queryVanityRequest\"",
  "displayName": "queryVanityResponse",
  "operationType": "QUERY"
}