Get Customer Subscribers

This API is used to retrieve a list of all subscribers attached to their parent customer. Result set includes a single level of hierarchy.

HTTP URL  
GET /api/v2/customer/{id}/subscriber

Eligibility

The Requester is eligible to request and receive a list of own subscribers and own sub-customer subscribers.

API Request

This API has no request structure.

API Response

Response Structure

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

Content data objects

Element Type M/O/CM Description
subscriberId UUID M Subscriber Universal Unique ID
imsiMsisdnPairs Object M Array of IMSI and MSISDN pairs object; only one can be marked as active (at the most).
iccid String M SIM card serial number
status String M

Life Cycle Policy (LCP) status. ENUM: ACTIVE, SUSPEND, INACTIVE, TERMINATED
imei String O Device ID registered on the subscriber
imeisv String O Device ID including software version registered on the subscriber
customerId UUID O Indicates the customer ID that the subscriber is connected to.
customerName String O Indicates the customer name that the subscriber is connected to.

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

imsiMsisdnPairs objects

Element Type M/O/CM Description
imsi String M IMSI registered on the SIM card
msisdn String O Subscriber mobile number: MSISDN. Format: International E.164
isLastActive Boolean M

Last known IMSI as active indication; only one can be active at a time.

  • True = Last Active IMSI

  • False = Inactive IMSI

Error Codes

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

Code Message
CUSTOMER_1002 Customer does not exist
CUSTOMER_1006 Failed to retrieve customer details
GLOBAL_1001 Service unavailable. Please try again

Examples

Request Body

Copy 
{
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
      "imsiMsisdnPairs": [
        {
          "imsi": "222013090961859",
          "msisdn": "999013090961859",
          "isLastActive": true
        },
        {
          "imsi": "310380501118337",
          "msisdn": "134044411258337",
          "isLastActive": false
        }
      ],
      "iccid": "8935711001000034535",
      "status": "ACTIVE",
      "imei": "354306110218529",
      "imeisv": "3543061102185201"
      "customerId": "3bd92beb-0367-4e68-b50d-72c0fb08beab",
      "customerName": "Gualas LTD"
    },
    {
      "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
      "imsiMsisdnPairs": [
        {
          "imsi": "222013090961859",
          "msisdn": "999013090961859",
          "isLastActive": true
        },
        {
          "imsi": "310380501118337",
          "msisdn": "134044411258337",
          "isLastActive": false
        }
      ],
      "iccid": "8935711001000034536",
      "status": "ACTIVE",
      "imei": "354306110218530",
      "imeisv": "3543061102185301"
      "customerId": "3bd92beb-0367-4e68-b50d-72c0fb08beab",
      "customerName": "Gualas LTD"
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 1,
    "totalElements": 2
  }
}

Response Body: Failure NAK:

Copy 
{
  "errorCode": "CUSTOMER_1006",
  "errorMessage": "Failed to retrieve customer details",
  "content": "",
  "pageable": ""
}