Request Subscription Status

For checking for subscription status for a particular MSISDN, Service Providers need to invoke the request subscription status API.

Request

HTTP Method
POST
POST <AOC_SERVER>/api/subscriptionStatus
HTTP/1.1
Content type: application/x-www-form-urlencoded


{
  "apiKey":"Ofa3M7zS2c3",
  "username":"test",
  "msisdn":"+60191234567",
  "operator":"operator1",
  "subscriptionID":"WeeklyGame1"
}

Request Parameter

Parameter NameDescriptionUsage
usernameThis will be the username provided to the Service Provider by BOOSTCONNECT.(STRING) Mandatory
apiKeyThis will be API Key to access AOC. Will be provided by BOOSTCONNECT.(STRING) Mandatory
msisdnThe MSISDN of the subscriber. The user’s MSISDN includes the country code, e.g. 60191234567.(STRING) Mandatory
operatorThe operator code provided by Axiata.(STRING) Mandatory
subscriptionIDThis is a unique subscription id for each different subscription package/service.(STRING) Mandatory

Response

HTTP/1.1 200 OK 
Content-Type: application/json 
Date: Tue, 01 Nov 2016 12:00:00 GMT


{ "data": 
{ 
	"subscriptionID":"s00001", 
	"subscriptionName":"100", 
	"status":"unsubscribed", 
	"msisdn":"+60109226185", 
	"expiryDate":"30-05-2018", 
	"errorCode":"00", 
	"errorMessage":"" 
} 
}

Response Parameter

Parameter NameDescriptionUsage
subscriptionIDThis is a unique subscription id for each different subscription package/service.(STRING)
subscriptionNameThis is the subscription name for the subscription id.(STRING)
statusThis is the status of the subscription. There will be 2 values which is

1. subscribed
2. unsubscribed
(STRING)
msisdnThe MSISDN of the subscriber. The user’s MSISDN includes the country code, e.g. 60191234567.(STRING)
expiryDateThis is the expiry date of the subscription in the format dd-mm-yyyy.(STRING)
errorCodePlease check the error code list.(STRING)
errorMessageExplanation of the error.(STRING)