Modify Subscriber MSISDN
The Modify Subscriber MSISDN API is used to modify an existing MSISDN identifier of a given subscriber. It can be used to replace an existing MSISDN or add MSISDN value where an IMSI does not have paired MSISDN.
NOTE: Only users with a dedicated role and permissions are eligible to use this API.
|
HTTP URL |
|
|---|---|
|
PUT |
api/v2/subscriber/imsi/{value}/msisdn |
Eligibility
The Requestor is eligible to request an MSISDN change for his own subscribers or for his sub-customer subscribers.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
msisdn |
String |
M |
Specify the new MSISDN |
API Response
Response Structure
|
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. |
|
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 |
|---|---|---|---|
|
requestId |
UUID |
M |
Request instance ID. To be used by external systems to query the call (operation) 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_1061 | MSISDN does not belong to the account |
| SUBSCRIBER_1062 | New MSISDN already in use |
Examples
Request Body
{
"msisdn": "442071838750"
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": null
}
Response Body: Failure NAK
{
"errorCode": "SUBSCRIBER_1062",
"errorMessage": "New MSISDN already in use",
"content": "",
"pageable": null
}