Bulk Create Subscriber Labels

This API is used to create user labels for multiple subscribers in a single call.

HTTP URL
POST	/api/v2/bulk/subscriber/label

Eligibility

The Requester is eligible to request creating User-labels for its own (single) subscriber or one of its sub-customers’ (sub-accounts) 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	Subscriber unique keys object, defines the search criteria.
content	Object	M	Main elements container object.

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
name	String	M	List (array) of label names to be created. If more than one label is provided, then all must have been created successfully to earn Success status; if even one fails, then the result status is Failure for all labels.

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
name	String	M	List (array) of label names to be created.

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_1030	Failed to create subscriber label\s

Examples

Request Body

Copy

{
  "bulk": [
    {
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "name": [
          "label1",
          "label2"
        ]
      }
    },
    {
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        "name": [
          "label1",
          "label2"
        ]
      }
    }
  ]
}

Response Body: Full Success ACK

Copy

{
  "bulk": [
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "name": [
          "label1",
          "label2"
        ]
      }
    },
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000035687"
      },
      "content": {
        "name": [
          "label1",
          "label2"
        ]
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Includes Failure(s) (NAK)

Copy

{
  "bulk": [
    {
      "errorCode": "SUBSCRIBER_1030",
      "errorMessage": "Failed to create subscriber label\\s",
      "requestId": "",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "name": [
          "label1",
          "label2"
        ]
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}