Modify Subscriber Device Lock
This API is used for handling lock (pairing) of a SIM to a Device (IMEI). Specifically, it is used to:
Enable the ‘Locking SIM to Device’ feature.
Disable the ‘Locking SIM to Device’ feature.
Reset, which breaks the pairing between a SIM and its locked device.
Turning this feature on or off, or resetting the lock, is done on the subscriber for all levels.
|
HTTP URL |
|
|---|---|
| POST | /api/v2/subscriber/{type}/{value}/device-sim-lock |
NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.
Eligibility
The Requestor can enable or disable this feature for its own subscriber.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
action |
String |
M |
Enable or disable the lock SIM to device feature, or reset the current locked device. ENUM valid values: ENABLE, DISABLE, RESET Developer Notes: For RESET, follow: Lock SIM to Device (IMEI lock) – Reset IMEI For ENABLE/DISABLE, follow: Lock SIM to Device (IMEI lock) – Enabling/Disabling |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. See list below, under ‘Error Codes’ section. |
|
errorMessage |
String |
O |
Failure detailed description. See list below, under ‘Error Codes’ section. |
|
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, whether in progress, successful or failed. |
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 |
Examples
Request Body
{
"action": "RESET"
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Failure NAK
{
"errorCode": "GLOBAL_1001",
"errorMessage": "Service unavailable. Please try again",
"content": "",
"pageable": null
}