Get All Customer Subscriber Details

This API is used to retrieve a full list of all subscribers that attached to their customer regardless of their amount including very specific piece of information such as latest subscriber’s location, usage summary etc.

HTTP URL
POST	api/v2/customer/{id}/subscriber-all-details

Eligibility

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

API Request

Parameter	Type	M/O/CM	Description
pitId	String	O	Point in Time identity used to identify a fetching process. User should send this element empty in the first API call, parse the pitId from the response and then populate this element in any other request. If sent empty, then a new search and a new pitId will be created.
pitKeepAlive	Numeric	O	Determines the max duration of a fetching session in minutes. Once exceeding this time, the fetching process will be terminated. This element is mandatory in the first API call when pitId is sent blank. If pitId was sent populated, pitKeepAlive will be ignored. If pitId was sent empty and pitKeepAlive is empty as well, the system will apply the default (1 minute). The maximum allowed time is 30 minutes. Example: 5 (5 minutes)
size	Numeric	O	Determines response record amount. Number of requested records per API call. Maximum allowed 10,000 records. Valid range 1-10,000. Default if not sent = 1,000. Example: 1000 (1,000 records per API call within pitId session)

API Response

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure detailed description.
content	Object	O	Array of main response body object. Displayed when an API call was successful. For a failure, it will be empty.
pitId	String	M	Point in Time identity used to identify a fetching process session. User should parse this element and then populate the value in any other request relevant to the current session.
recordAmount	Numeric	M	Number of records in the current chunk (response).
totalRecordAmount	Numeric	M	Total amount of records in query.
pageable	Object	O	Paging information object. Displayed when an API call was successful. For a failure it will be empty. Note: This is not supported for this API. Object exists for response uniformity purposes only.

Content data objects

Parameter	Type	M/O/CM	Description
subscriberId	UUID	M	Subscriber Universal Unique ID.
eId	String	O	Embedded Identity Document. Filled in when multiple ICCIDs (profiles) exist for a single SIM.
profile	Object	M	Array of profiles. For a single EID, embedded identity document, there might be several SIM entities (ICCIDs).
status	String	M	Life Cycle Policy (LCP) status. ENUM: ACTIVE, SUSPEND, INACTIVE, TERMINATED.
imei	String	O	Device ID registered on the subscriber.
meisv	String	O	Device ID including software version registered on the subscriber
customerId	UUID	O	Indicates the customer ID which the subscriber is connected to.
customerName	String	O	Indicates the customer’s name which the subscriber is connected to.
dailySmsUsage	Decimal	O	Near real-time value of the daily accumulative SMS usage.
dailyDataUsage	Decimal	O	Near real-time value of the daily accumulative data usage. Unit displayed in MB.
weeklySmsUsage	Decimal	O	Near real-time value of the weekly accumulative SMS usage.
weeklyDataUsage	Decimal	O	Near real-time value of the weekly accumulative data usage. Unit displayed in MB.
monthlySmsUsage	Decimal	O	Near real-time value of the monthly accumulative SMS usage.
monthlyDataUsage	Decimal	O	Near real-time value of the monthly accumulative data usage. Unit displayed in MB.
lastConnectedNetwork	Object	O	Last known SIM connected network.
lastUsageLocation	Object	O	Last known SIM usage consumption location.
lastIp	String	O	Last IP Address.
lastRatType	String	O	Last connected RAT type id
lastRatTypeLabel	String	O	Last connected RAT type name (label)
lastDataRatType	String	O	Last connected Data RAT type id for data session
astDataRatTypeLabel	String	O	Last connected Data RAT type name (label) for data session
lastApn	String	O	Last connected Access Point Name
lastDataSession	DateTime	O	Last closed recorded data session date and time (End Time).
firstActivatedTime	DateTime	O	Date and time of the first activation signal received from the SIM

Profile

Parameter	Type	M/O/CM	Description
iccid	String	M	SIM card serial number.
imsiMsisdnPairs	Object	M	Array of IMSI and MSISDN pairs object. Only one can be marked as active (at the most).

imsiMsisdnPairs

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

Element

Type

M/O/CM

Description

imsi

String

IMSI registered on the SIM card

msisdn

String

Subscriber mobile number: MSISDN

Format: International E.164

isLastActive

Boolean

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

True = Last Active IMSI
False = Inactive IMSI

Last connected network data objects

Element	Type	M/O/CM	Description
mcc	String	O	Last connected MCC
mnc	String	O	Last connected MNC
plmn	String	O	Public Land Mobile Network. MCCMNC representation
countryCode	String	O	ISO alpha-3 Country Code

lastUsageLocation

Parameter	Type	M/O/CM	Description
mcc	String	O	Last connected Mobile Country Code.
mnc	String	O	Last connected Mobile Network Code.
lac	String	O	Last connected Location Area Code. See note below.
tac	String	O	Last connected Tracking Area Code. See note below.
cid	String	O	Last connected Cell ID. See note below.
sac	String	O	Last connected Service Area Code. See note below.
rac	String	O	Last connected Routing Area Code. See note below.
enb	String	O	Last connected eNode-B. See note below.

NOTE: Pair of the following attributes (lac, tac, rac, sac, cid, enb) will be filled in based on the last consumed usage location RAT Type.

IMPORTANT: ‘lastUsageLocation’ MCC&MNC values might be different than ‘lastConnectedNetwork’ MCC&MNC values. It may occur if a subscriber was consuming service (data or SMS) from a given operator/country and then roamed to a different country, registered to the new operator network but didn’t yet consumed any service.

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
CUSTOMER_1002	Customer does not exist.
CUSTOMER_1006	Failed to retrieve customer details.
GLOBAL_1001	Service unavailable. Please try again.
GLOBAL_1018	Invalid point in time ID.

Examples

Request Body

Copy

{
  "pitId": "46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==",
  "pitKeepAlive": 5,
  "size": 1000
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
      "eId": "00909231222999923581290365443",
      "profile": [
        {
          "iccid": "8935711001000034535",
          "imsiMsisdnPairs": [
            {
              "imsi": "222013090961859",
              "msisdn": "999013090961859",
              "isLastActive": true
            },
            {
              "imsi": "310380501118337",
              "msisdn": "134044411258337",
              "isLastActive": false
            }
          ]
        },
        {
          "iccid": "8935711009990036598",
          "imsiMsisdnPairs": [
            {
              "imsi": "223013090962020",
              "msisdn": "991013090962020",
              "isLastActive": true
            },
            {
              "imsi": "410380501118987",
              "msisdn": "43404441125987",
              "isLastActive": false
            }
          ]
        }
      ],
      "status": "ACTIVE",
      "imei": "354306110218529",
      "imeisv": "3543061102185201",
      "customerId": "3bd92beb-0367-4e68-b50d-72c0fb08beab",
      "customerName": "Gualas LTD",
      "dailySmsUsage": 23,
      "dailyDataUsage": 54.3,
      "weeklySmsUsage": 11,
      "weeklyDataUsage": 1.5,
      "monthlySmsUsage": 45,
      "monthlyDataUsage": 19.4,
      "lastConnectedNetwork": {
        "mcc": "724",
        "mnc": "05",
        "plmn": "BRACL",
        "countryCode": "BRA"
      },
      "lastUsageLocation": {
        "mcc": "734",
        "mnc": "04",
        "lac": "",
        "tac": "",
        "cid": "",
        "sac": "",
        "rac": "",
        "enb": ""
      },
      "lastIp": "10.84.8.208",
      "lastRatType": "1",
      "lastRatTypeLabel": "3G (UTRAN 1)",
      "lastDataRatType": "6",
      "lastDataRatTypeLabel": "4G (WB-EUTRAN 6)",
      "lastApn": "gigsky-02",
      "isInDataSession": false,
      "lastDataSession": "2020-11-10 09:47:46.668866",
      "lastDataSessionRecord": "2020-11-10 09:48:42.365876",
      "firstActivatedTime": "2020-07-11 09:48:42.365876"
    },
    {
      "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
      "eId": "00909231222999923651290300432",
      "profile": [
        {
          "iccid": "8935711001000034539",
          "imsiMsisdnPairs": [
            {
              "imsi": "222013090961860",
              "msisdn": "999013090961860",
              "isLastActive": true
            },
            {
              "imsi": "310380501118338",
              "msisdn": "134044411258338",
              "isLastActive": false
            }
          ]
        },
        {
          "iccid": "8935711009990036800",
          "imsiMsisdnPairs": [
            {
              "imsi": "223013090969991",
              "msisdn": "991013090969991",
              "isLastActive": true
            },
            {
              "imsi": "410380501118988",
              "msisdn": "43404441125988",
              "isLastActive": false
            }
          ]
        }
      ],
      "status": "ACTIVE",
      "imei": "354306110218530",
      "imeisv": "3543061102185301",
      "customerId": "3bd92beb-0367-4e68-b50d-72c0fb08beab",
      "customerName": "Gualas LTD",
      "dailySmsUsage": 2,
      "dailyDataUsage": 14.3,
      "weeklySmsUsage": 17,
      "weeklyDataUsage": 1.6,
      "monthlySmsUsage": 5,
      "monthlyDataUsage": 39.4,
      "lastConnectedNetwork": {
        "mcc": "724",
        "mnc": "04",
        "plmn": "BRACS",
        "countryCode": "BRA"
      },
      "lastUsageLocation": {
        "mcc": "724",
        "mnc": "04",
        "lac": "",
        "tac": "",
        "cid": "",
        "sac": "",
        "rac": "",
        "enb": ""
      },
      "lastIp": "10.84.8.208",
      "lastRatType": "1",
      "lastRatTypeLabel": "3G (UTRAN 1)",
      "lastDataRatType": "6",
      "lastDataRatTypeLabel": "4G (WB-EUTRAN 6)",
      "lastApn": "flolive.net",
      "isInDataSession": false,
      "lastDataSession": "2020-11-10 09:47:46.668866",
      "lastDataSessionRecord": "2020-11-10 09:48:42.365876",
      "firstActivatedTime": "2020-04-11 09:18:41.115176"
    }
  ],
  "pitId": "46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==",
  "recordAmount": 1000,
  "totalRecordAmount": 20000,
  "pageable": ""
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1018",
  "errorMessage": "Invalid point in time ID",
  "content": "",
  "pageable": ""
}