Bulk Modify Subscriber Status

This API is used to change the LCP status of multiple Subscribers in the platform with a single API call.

The request should contain only elements that require modification. Empty elements denote overriding of the existing value with a NULL value.

HTTP URL  
PUT /api/v2/bulk/subscriber/status

Eligibility

The Requester is eligible to request a status change for its own subscribers or for its sub-customers’ subscribers.

API Request

Request Structure

Parameter Type M/O/CM Description
bulk Object M Array of main request body object.

Bulk data objects

Element Type M/O/CM Description
subscriberIdentifiers Object M  
content Object M Main elements container objectSubscriber unique keys object, defines the search criteria.

subscriberidentifiers data objects

Element Type M/O/CM Description
type String M Define the search criteria: ENUMs: IMSI, ICCID, MSISDN, IMEI
value String M Type value. IMSI or ICCID or MSISDN or IMEI number.

Content data objects

Parameter Type M/O/CM Description
status String M Request to change the subscriber’s current status to a new status value. ENUM valid values: ACTIVE, SUSPEND, INACTIVE, TERMINATED

API Response

Response Structure

Parameter Type M/O/CM Description
bulk Object M Array of main response body object.
pageable Object O Paging information object displayed when an API call was successful. For a failure, it will be empty.

Bulk data objects

Parameter Type M/O/CM Description
errorCode String O Failure code.
errorMessage String O Failure message.
requestId UUID CM

Request instance ID. To be used by external systems to query the call (operation) status:

  • In progress

  • Successful

  • Failed.

Displayed when an API call was successful. For a failure, it will be empty.
subscriberIdentifiers Object M Subscriber unique keys object, defines the search criteria.
content Object O Main response body object that reflects a single node of the original request.

subscriberidentifiers data objects

Parameter Type M/O/CM Description
type String M Define the search criteria: ENUMs: IMSI, ICCID, MSISDN, IMEI
value String M Type value. IMSI or ICCID or MSISDN or IMEI number.

Content data objects

Element Type M/O/CM Description
status String M Newly requested status

Pageable data objects

Element Type M/O/CM Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code Message
GLOBAL_1001 Service unavailable. Please try again
SUBSCRIBER_1002 Subscriber does not exist
SUBSCRIBER_1008 Failed to update subscriber status

Examples

Request Body

Copy 
{
  "bulk": [
    {
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "status": "ACTIVE"
      }
    },
    {
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        "status": "SUSPEND"
      }
    }
  ]
}

Response Body: Full Success ACK

Copy 
{
  "bulk": [
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "status": "ACTIVE"
      }
    },
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        "status": "SUSPEND"
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Includes Failure(s) (NAK)

Copy 
{
  "bulk": [
    {
      "errorCode": "SUBSCRIBER_1008",
      "errorMessage": "Failed to update subscriber status",
      "requestId": "",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "status": "ACTIVE"
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}