Get IMEI (Coming Soon)
Read the IMEI of the device's cellular communication module for device identification, asset registration, and communication troubleshooting.
Capability preview
This endpoint is not yet available. The content below introduces the planned use case. The documentation published with the endpoint will define the final contract.
Planned Usage
A caller will be able to query the IMEI of a device that the account is authorized to access. The platform will return a standardized result.
An IMEI is generally a relatively stable device identity value. The final response will include the collection time so the caller can assess the source and freshness of the data.
Planned Response Fields
The endpoint will use the standard response envelope. The fields below are inside data.
| Field | Type | Required | Description |
|---|---|---|---|
deviceId | string | Yes | Device ID |
imei | string | Yes | Cellular module IMEI as a fixed 15-digit decimal string |
collectedAt | string | Yes | Data collection time in RFC3339 UTC |
imei is returned as a string to avoid precision or formatting changes caused by numeric types. The platform accepts only a value explicitly returned by the cellular module that matches the 15-digit format. An invalid value will not overwrite a previously confirmed IMEI.
Data Protection
- IMEI is returned only to an API Client authorized to access the device.
- Callers should not output the complete IMEI in public logs, browser URLs, or frontend error messages.
- If the device or cellular module does not support this information, the endpoint will return an explicit capability-unavailable or data-unavailable result.
Field Basis
The IMEI format is based on the official SIMCom A76XX device-serial-number query definition. OpenAPI returns only a validated standard field and does not expose cellular-module communication details to callers.
After Release
The released endpoint documentation will provide the request path, permission requirements, freshness rules, and response behavior when a device is offline, unsupported, or has not yet provided an IMEI.