Bulk Modify Subscriber MSISDN
The Bulk Modify Subscriber MSISDN API is used to modify existing MSISDN identifiers of multiple Subscribers in the platform in a single call. It can be used to replace existing MSISDNs or add MSISDN values where an IMSI does not have a paired MSISDN.
NOTE: Only users with a deciated role and permissions are eligible to use this API.
| HTTP URL | |
|---|---|
| PUT | api/v2/bulk/subscriber/msisdn |
Eligibility
The Requestor is eligible to request a status change for his own subscribers or for his sub-customer subscribers.
API Request
Request Structure
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| bulk | Object | M | Array of main request body object. |
Bulk
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| subscriberIdentifiers | Object | M | Subscriber unique keys object, define 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: ENUM is: IMSI |
| value | String | M | Type value. IMSI |
Content
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| msisdn | String | M | Specify the new MSISDN |
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 detailed description. |
| requestId | UUID | CM |
Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or 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: ENUM is IMSI |
| value | String | M | Type value is IMSI |
Content data objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| msisdn | String | O | New requested MSISDN |
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_1061 | MSISDN does not belong to the account |
| SUBSCRIBER_1062 | New MSISDN already in use |
Examples
Request Body
{
"bulk": [
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090963830"
},
"content": {
"msisdn": "7778043830"
}
},
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961866"
},
"content": {
"msisdn": "7778041866"
}
}
]
}
Response Body: Full Success ACK
{
"bulk": [
{
"errorCode": "",
"errorMessage": "",
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090963830"
},
"content": {
"msisdn": "7778043830"
}
},
{
"errorCode": "",
"errorMessage": "",
"requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961866"
},
"content": {
"msisdn": "7778041866"
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}
Response Body: Includes Failure(s) (NAK)
{
"bulk": [
{
"errorCode": "SUBSCRIBER_1062",
"errorMessage": "New MSISDN already in use",
"requestId": "",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090963830"
},
"content": {
"msisdn": "7778043830"
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}