Telnyx

JavaScript

import Telnyx from 'telnyx';

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

const action = await client.simCards.actions.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(action.data);

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

GET

sim_card_actions

{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 action = await client.simCards.actions.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(action.data);

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Identifies the resource.

Example:

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

Response

Successful Response

data

SIMCardAction · object

This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.

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"

List SIM card actions List bulk SIM card actions

⌘I

IoT

Networking

Get SIM card action details

Authorizations

Path Parameters

Response