Reporting IMEIs

This page explains how to report and manage IMEIs using nRF Cloud, using either the nRF Cloud portal or REST API endpoints.

A report must contain either a reel code or a list of individual IMEIs, but not both. You must also specify the network operator. You can also optionally include a model name for the end product containing a Nordic Semiconductor chip.

Access

You must be an admin or owner of a Pro or Enterprise team to access the IMEI Management interface and APIs.

If you do not see the IMEI Management page in the left sidebar of the nRF Cloud portal, check that your team has the correct plan and that you have the correct role within that team.

Reporting IMEIs through the nRF Cloud portal

This section explains IMEI operations in the nRF Cloud portal. Click to expand each section for more information.

Managing models

Click to expand

To add a new model or delete an existing one:

1. Select IMEI Management in the left sidebar.

   A panel opens to the right.

2. Select View Models.

3. Click Create Model:

   • If you have previously created models, the button is in the upper right corner. You can view or delete existing models under the Models card.
   • If you have not yet created any models, there is also a Create Model button under the Models card.

   A pop-up opens.

4. Enter a model name in the text box (up to 100 characters).

5. Click Create Model.

   The new model appears under the Models card. Each team can have up to 100 models.

Once you have created a model, you can optionally include it in an IMEI report.

Getting IMEIs by reel code

Click to expand

To get a list of IMEIs associated with a reel code:

1. Select IMEI Management in the left sidebar.

   A panel opens to the right.

2. Select Fetch IMEIs.

3. Enter a reel code into the text box.

4. Click Get IMEIs.

   nRF Cloud returns a list of IMEIs. You can download this list as a CSV file.

note

If you download and open a CSV file in a spreadsheet application, IMEI values might display by default in scientific notation.

Viewing and submitting IMEI reports

Click to expand

An IMEI report requires the operator name and either a reel code or list of individual IMEIs. You can optionally include a model name in the report.

To submit IMEIs or view existing reports:

1. Select IMEI Management in the left sidebar.

   A panel opens to the right.

2. Select View Reports.

3. Click Create Report:

   • If you have previously created reports, the button is in the upper right corner. You can view or delete existing reports under the Report History card.
   • If you have not yet created any reports, there is there is also a Create Report button under the Report History card.

   A pop-up opens.

4. Select the report type.

5. Enter the following information:

   • Either the reel code, or a list of up to 100 individual IMEIs separated by commas.
   • Model (optional)
   • Operator

6. Click Create Report to submit the report.

The report appears in the Report History card.

Report entries contain a link in the Reel code column. Clicking this link opens a pop-up with the IMEIs included in that report.

Reporting IMEIs through the REST API

This section explains the REST endpoints related to IMEIs.

Click to expand each section for more information.

note

GET endpoints use path and query parameters. Some of these parameters require URL encoding, such as operator names.

Example

When getting IMEIs by reel code, include the reel code as a path parameter, not in the message body. For example, for a reel code of F01-234567:

curl --request GET 'https://api.imei.nrfcloud.com/v1/imei-management/reels/F01-234567' --header 'Authorization: Bearer $API_KEY'

Fetching information

Click to expand

The following endpoints return information about existing IMEI reports and mobile network operators:

• Use the ListImeiReports endpoint to list any previously created IMEI reports, with optional filter parameters.
• Use the GetImeiReport endpoint to fetch details for a specific report.
• Use the ListOperators endpoint to list known mobile network operators.

Managing models

Click to expand

• Use the AddModel endpoint to create a new model. Limit 100 characters per model name. Limit 100 models per team.
• Use the DeleteModel endpoint to delete an existing model. Deleting a model does not remove it from existing IMEI reports.
• Use the ListModels endpoint to list the previously created model names of your end products using a Nordic Semiconductor chip.

Getting IMEIs by reel code

Click to expand

Use the ListImeisByReelCode endpoint to list IMEI numbers belonging to the given reel code.

Reporting IMEIs by reel code

Click to expand

Use the ReportImeis endpoint to generate an IMEI report using a reel code.

Required parameters:

• reelCode: A reel code that represents a batch of IMEI numbers.
• operator: The name of the operator your devices use.

Do not include individual IMEIs when reporting by reel code.

Reporting individual IMEIs

Click to expand

Use the ReportImeis endpoint to generate a report for up to 100 individual IMEIs. The endpoint is the same as for bulk reporting, and depends on the parameters you specify.

Required parameters:

• imeis: A list of IMEIs in JSON format.
• operator: The name of the operator your devices use.

Optional parameter:

• model: A name you have defined for the end product.

Do not include a reel code when reporting individual IMEIs.

Deleting an IMEI report

Click to expand

Use the DeleteImeiReport endpoint to delete a submitted IMEI report.

note

You can delete a report up to 15 minutes after submitting it.

If you have submitted a report with an error (for example, with the wrong model name or operator) and can no longer delete it, create and submit a new report.