Skip to main content

Get OTA update

GET 
/ota_updates/:id

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

Request ​

Path Parameters

    id uuidrequired

    Identifies the resource.

Responses ​

200: Successful response

Schema

    data

    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.

    id uuid

    Identifies the resource.

    record_type string
    sim_card_id uuid

    The identification UUID of the related SIM card resource.

    type string

    Possible values: [sim_card_network_preferences]

    Represents the type of the operation requested. This will relate directly to the source of the request.

    status string

    Possible values: [in-progress, completed, failed]

    settings

    object

    A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.

    mobile_network_operators_preferences

    object[]

    A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.

  • Array [

    • mobile_network_operator_id uuid

    The mobile network operator resource identification UUID.

    mobile_network_operator_name string

    The mobile network operator resource name.

    priority integer

    It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.

  • ]

    • A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.

    A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.

    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

401: Unauthorized

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/ota_updates/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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"
  }
}