SettingsUpdates Resource
A SettingsUpdate instance represents a single update to the configuration of a single physical SIM or eSIM profile. Settings updates are either applied at the time of manufacturing or via over-the-air updates. Updates to the SIM may include modifying the standard elementary files (EFs) found on all SIMs or resources specific to Super SIM, such as the multi-IMSI applet, that may impact how a SIM behaves.
Pending over-the-air updates that are waiting to for the corresponding SIM to connect, download, and install the update can be read using this resource.
This resource can be found at the following URL:
_10https://supersim.twilio.com/v1/SettingsUpdates
Property nameTypePIIDescription
The unique identifier of this Settings Update.
Pattern: ^OB[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the Super SIM to which this Settings Update was applied.
Pattern: ^HS[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The Status of this Settings Update. One of scheduled
, in-progress
, successful
or failed
.
Possible values: scheduled
in-progress
successful
failed
Array containing the different Settings Packages that will be applied to the SIM after the update completes. Each object within the array indicates the name and the version of the Settings Package that will be on the SIM if the update is successful.
date_completedstring<date-time>
date_createdstring<date-time>
date_updatedstring<date-time>
The table below describes the available status
values of a SettingsUpdate instance:
Status | Description |
---|
scheduled | The update is waiting for the SIM and has not started. |
in-progress | The update is in progress but may require multiple update stages to complete. |
successful | The update is complete and the settings described in the packages array are what is now being used by the SIM. |
failed | The update did not complete all stages successfully and the update is no longer being retried. |
An update may add, remove, or update one or more settings packages. Each settings package represents a collection of configuration values that are set on the SIM that influence how it behaves. Some settings packages may override others. For example, all SIMs will have a base-settings
package which represents the default settings used by all SIMs. If an additional settings package is loaded onto a SIM, the subset of settings controlled by package will override those set by the base-settings
package.
name | The string identifier of the settings package. |
---|
version | The version of the settings package. SIMs using the same version of a settings package should behave identically. When a change is made to a settings package that alters the behavior, the version of the settings package will be incremented. When comparing two versions of a settings package, a higher version indicates a newer version. The value will be a string. Example: "1.0.0". |
more_info | URL of the dedicated docs page for the settings package. Will be null if there is no additional public documentation for the settings package. |
GET https://supersim.twilio.com/v1/SettingsUpdates
Property nameTypeRequiredPIIDescription
Filter the Settings Updates by a Super SIM's SID or UniqueName.
Statusenum<string>Optional Filter the Settings Updates by status. Can be scheduled
, in-progress
, successful
, or failed
.
Possible values: scheduled
in-progress
successful
failed
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1
Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function listSettingsUpdate() {
_18 const settingsUpdates = await client.supersim.v1.settingsUpdates.list({
_18 settingsUpdates.forEach((s) => console.log(s.sid));
_29 "settings_updates": [
_29 "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "iccid": "89883070000123456789",
_29 "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "status": "scheduled",
_29 "name": "base-settings",
_29 "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
_29 "date_completed": null,
_29 "date_created": "2015-07-30T20:00:00Z",
_29 "date_updated": "2015-07-30T20:00:00Z"
_29 "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
_29 "previous_page_url": null,
_29 "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
_29 "next_page_url": null,
_29 "key": "settings_updates"
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function listSettingsUpdate() {
_19 const settingsUpdates = await client.supersim.v1.settingsUpdates.list({
_19 sim: "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 settingsUpdates.forEach((s) => console.log(s.sid));
_29 "settings_updates": [
_29 "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "iccid": "89883070000123456789",
_29 "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "status": "successful",
_29 "name": "base-settings",
_29 "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
_29 "date_completed": "2015-07-30T20:00:00Z",
_29 "date_created": "2015-07-30T20:00:00Z",
_29 "date_updated": "2015-07-30T20:00:00Z"
_29 "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
_29 "previous_page_url": null,
_29 "url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
_29 "next_page_url": null,
_29 "key": "settings_updates"
Can be used to identify SIMs with pending SettingsUpdates
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function listSettingsUpdate() {
_19 const settingsUpdates = await client.supersim.v1.settingsUpdates.list({
_19 settingsUpdates.forEach((s) => console.log(s.status));
_29 "settings_updates": [
_29 "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "iccid": "89883070000123456789",
_29 "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "status": "scheduled",
_29 "name": "base-settings",
_29 "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
_29 "date_completed": null,
_29 "date_created": "2015-07-30T20:00:00Z",
_29 "date_updated": "2015-07-30T20:00:00Z"
_29 "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0",
_29 "previous_page_url": null,
_29 "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0",
_29 "next_page_url": null,
_29 "key": "settings_updates"
You can determine what Settings Packages and their respective versions that are currently installed on a SIM by looking at a SIM's most recent successful Settings Update. Records are returned in in reverse chronological order with the most recent Settings Update returned first. Use the SIM's SID or Unique Name and the successful
status as filters and the look at the first record. The Settings Packages listed in the record's settings_packages
are what your SIM is currently using.
The most recent successful update shows the Settings Packages currently installed on the SIM. This will be the first record.
_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20async function listSettingsUpdate() {
_20 const settingsUpdates = await client.supersim.v1.settingsUpdates.list({
_20 sim: "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 status: "successful",
_20 settingsUpdates.forEach((s) => console.log(s.status));
_29 "settings_updates": [
_29 "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "iccid": "89883070000123456789",
_29 "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "status": "successful",
_29 "name": "base-settings",
_29 "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
_29 "date_completed": "2015-07-30T20:00:00Z",
_29 "date_created": "2015-07-30T20:00:00Z",
_29 "date_updated": "2015-07-30T20:00:00Z"
_29 "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
_29 "previous_page_url": null,
_29 "url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
_29 "next_page_url": null,
_29 "key": "settings_updates"