Telnyx

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const simCardAction of client.simCards.actions.list()) {
  console.log(simCardAction.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_action",
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "action_type": "enable",
      "status": {
        "value": "completed",
        "reason": "The data limit was exceeded."
      },
      "settings": {},
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

sim_card_actions

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const simCardAction of client.simCards.actions.list()) {
  console.log(simCardAction.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_action",
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "action_type": "enable",
      "status": {
        "value": "completed",
        "reason": "The data limit was exceeded."
      },
      "settings": {},
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

Consolidated filter parameter for SIM card actions (deepObject style). Originally: filter[sim_card_id], filter[status], filter[bulk_sim_card_action_id], filter[action_type]

Show child attributes

filter[sim_card_id]

string<uuid>

A valid SIM card ID.

Example:

"47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"

filter[status]

enum<string>

Filter by a specific status of the resource's lifecycle.

Available options:

in-progress,

completed,

failed

Example:

"in-progress"

filter[bulk_sim_card_action_id]

string<uuid>

Filter by a bulk SIM card action ID.

Example:

"47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"

filter[action_type]

enum<string>

Filter by action type.

Available options:

enable,

enable_standby_sim_card,

disable,

set_standby,

remove_public_ip,

set_public_ip

Example:

"disable"

page

object

Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

page[number]

integer

default:1

The page number to load.

Required range: x >= 1

page[size]

integer

default:20

The size of the page.

Required range: 1 <= x <= 250

Response

Successful Response

data

SIMCardAction · object[]

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

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

data.record_type

string

Example:

"sim_card_action"

data.sim_card_id

string<uuid>

The related SIM card identifier.

Example:

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

data.action_type

enum<string>

The operation type. It can be one of the following:

enable - move the SIM card to the enabled status
enable_standby_sim_card - move a SIM card previously on the standby status to the enabled status after it consumes data.
disable - move the SIM card to the disabled status
set_standby - move the SIM card to the standby status

Available options:

enable,

enable_standby_sim_card,

disable,

set_standby

Example:

"enable"

data.status

object

Show child attributes

data.status.value

enum<string>

The current status of the SIM card action.

Available options:

in-progress,

completed,

failed,

interrupted

Example:

"completed"

data.status.reason

string

It describes why the SIM card action is in the current status. This will be null for self-explanatory statuses, such as in-progress and completed but will include further information on statuses like interrupted and failed.

Example:

"The data limit was exceeded."

data.settings

object

A JSON object representation of the action params.

Example:

{}

data.created_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

IoT

Networking

List SIM card actions

Authorizations

Query Parameters

Response