Skip to main content
GET
/
ota_updates
/
{id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const otaUpdate = await client.otaUpdates.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(otaUpdate.data);
{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "ota_update",
    "settings": {
      "mobile_network_operators_preferences": [
        {
          "mobile_network_operator_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
          "mobile_network_operator_name": "AT&T Mobility (USACG)",
          "priority": 0
        }
      ]
    },
    "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "status": "in-progress",
    "type": "sim_card_network_preferences",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Response

Successful response

​
data
OTAUpdate · object

This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card.

Example:
{
  "created_at": "2018-02-02T22:25:27.521Z",
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "ota_update",
  "settings": {
    "mobile_network_operators_preferences": [
      {
        "mobile_network_operator_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
        "mobile_network_operator_name": "AT&T Mobility (USACG)",
        "priority": 0
      }
    ]
  },
  "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "status": "in-progress",
  "type": "sim_card_network_preferences",
  "updated_at": "2018-02-02T22:25:27.521Z"
}