The article includes:
Service types: KORE GN, KORE T-USA, KORE T-USA R, KORE T-USA W.
The request queries the carrier for real-time information on the SIM.
URLs
| Request URL (production) | https://prismproapi.koretelematics.com/4/TransactionalAPI.svc/json/QueryHlr |
| Request URL (sandbox) | https://prismproapi.sandbox.koretelematics.com/4/TransactionalAPI.svc/json/QueryHlr |
| Request method | Post |
Request
| Field | Data type | Mandatory | Min length | Max length | Description |
| deviceNumber | string | Y | 20 | The SIM number or ICCID. |
JSON request example
{
"deviceNumber":"1234567891234567891"
}
Response
| Parameter name | Data type | Min length | Max length | Description |
| requestStatus | int | Request status code (if unsuccessful) | ||
| Description | string | Error message if unsuccessful. | ||
| Result | string | SUCCESS (if successful). | ||
| Apns | string | Null. | ||
| DataServicesAvailability | string | Null. | ||
| DeviceOutOfMemory | string | Null. | ||
| DeviceSTatusData | string | Null. | ||
| DeviceStatusGsm | string | Null. | ||
| Imei | string | 20 | IMEI | |
| Imsi | string | 50 | IMSI | |
| Location | string | Null. | ||
| LocationUpdateFailure | string | Null. | ||
| MsStatus | string | IDLE, NOT_REGISTERED, or PURGED. | ||
| Msisdn | string | 50 | MSISDN. | |
| PrevVlrNmb | string | Null. | ||
| PreviousImsi | string | Null. | ||
| PreviousLocation | string | Null (feature no longer available). | ||
| RegisteredDate | string | Null. | ||
| RestrictedAreaData | string | Null. | ||
| RestrictedAreaGsm | string | Null. | ||
| RestrictedRoamingData | string | Null. | ||
| RestrictedRoamingGsm | string | Null. | ||
| RestrictedRoamingData | string | Null. | ||
| SimNumber | string | SIM number or ICCID. | ||
| SimStatus | string | INUSE. | ||
| Socs | string | Null. | ||
| VLRPurgedData | string | Null. | ||
| VLRPurgedGsm | string | Null. | ||
| VlrNmb | string | Null. |
JSON response example
{
"d": {
"__type": "QueryHlrResponse:#TMobileProxyService",
"Description": "Error: Request received an invalid response.",
"Result": "SUCCESS",
"Apns": null,
"DataServicesAvailability": null,
"DeviceOutOfMemory": null,
"DeviceSTatusData": null,
"DeviceStatusGsm": null,
"Imei": "",
"Imsi": "123456789123456",
"Location": null,
"LocationUpdateFailure": null,
"MsStatus": "NOT_REGISTERED",
"Msisdn": "7022440224",
"PrevVlrNmb": null,
"PreviousImsi": null,
"PreviousLocation": null,
"RegisteredDate": null,
"RestrictedAreaData": null,
"RestrictedAreaGsm": null,
"RestrictedRoamingData": null,
"RestrictedRoamingGsm": null,
"SimNumber": "1234567891234567891",
"SimStatus": "INUSE",
"Socs": null,
"VLRPurgedData": null,
"VLRPurgedGsm": null,
"VlrNmb": null
}
}