AT&T MVNX API

Cancel Port

Version 1.0.0
download iconDownload spec
View Use Cases

Endpoint

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

Cancels a previously submitted request to port in an existing subscriber from another service provider.

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
curl --request POST \
     --url https://lgw.att.com/CancelPort \
     --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:10:34.700Z",
      "conversationId": "string",
      "applicationName": "string",
      "originalVersion": "string",
      "uniqueTransactionId": "string",
      "infrastructureVersion": "string",
      "originalInfrastructureVersion": "string"
    },
    "SecurityMessageHeader": {
      "userName": "string",
      "userPassword": "string"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "string",
      "totalInSequence": "string"
    }
  },
  "CancelPortRequest": {
    "CancelTypes": {
      "CancelPortDetails": {
        "reasonCode": "CC",
        "initiatorId": "string",
        "MarketService": {
          "productType": "C",
          "billingMarket": {
            "localMarket": "string",
            "billingMarket": "string",
            "billingSubMarket": "string"
          },
          "serviceZipCode": "string",
          "billingSystemId": "string"
        },
        "PortingSelector": {
          "PortingLocator": {
            "portRequestNumber": "string",
            "portRequestVersion": "string",
            "teleportPortRecordId": "string"
          },
          "SubscriberNumber": "string",
          "PortOutListDateRange": {
            "toDate": "2025-04-01",
            "fromDate": "2025-04-01"
          }
        },
        "portCancellationRemarks": "string"
      },
      "CricketCancelPortDetails": {
        "mdn": "string",
        "externalRequestNumber": "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
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "v185",
      "messageId": "",
      "timeToLive": 300000,
      "dateTimeStamp": "2023-08-23T01:14:12Z",
      "conversationId": "XXXXXXXXXXXXXX~CNG-CSI~adb22f13-f967-44b7-9be3-700dbdbff5f8",
      "uniqueTransactionId": "ServiceGateway213542@q100csg107c3_a582dbac-962a-4ece-b860-c13f90759494"
    },
    "SecurityMessageHeader": {
      "userName": "[userName]",
      "userPassword": "[userPassword]"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "1",
      "totalInSequence": "1"
    }
  },
  "CancelPortResponse": {
    "Response": {
      "code": "0",
      "description": "Success"
    }
  }
}