Wireless API Reference: OTA updates

List OTA updates

get https://api.telnyx.com/v2/ota_updates

List OTA updates

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/ota_updates?page[number]=1&page[size]=20"

Parameters

In query

page[number]

integer (1)

optional

The page number to load

Default: 1

page[size]

integer (1 - 250)

optional

The size of the page

Default: 20

filter[sim_card_id]

string

optional

The SIM card identification UUID.

filter[status]

string

optional

Filter by possible OTA updates statuses.

Example: "in-progress"

Options: [ "in-progress", "completed", "failed" ]

filter[type]

string

optional

Filter by type.

Example: "sim_card_network_preferences"

Options: [ "sim_card_network_preferences" ]

Responses

200

Successful response

default

Unexpected error

Success Response

JSON
Schema

{
  "data": [
    {
      "created_at": "2018-02-02T22:25:27.521Z",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "ota_update",
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "status": "in-progress",
      "type": "sim_card_network_preferences",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Get OTA update

get https://api.telnyx.com/v2/ota_updates/{id}

This API returns the details of an Over the Air (OTA) update.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/ota_updates/6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Parameters

In path

string (uuid)

required

Identifies the resource.

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

Responses

200

Successful response

default

Unexpected error

Success Response

JSON
Schema

{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "ota_update",
    "settings": {
      "mobile_operator_networks_preferences": [
        {
          "mobile_operator_network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
          "mobile_operator_network_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"
  }
}

Previous: Mobile Operator Networks

Next: Reporting

In query

In path

Was this section helpful?