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 simpleSimCard of client.simCards.list()) {
  console.log(simpleSimCard.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card",
      "status": {
        "value": "enabled",
        "reason": "The SIM card is active, ready to connect to networks and consume data."
      },
      "type": "physical",
      "iccid": "89310410106543789301",
      "imsi": "081932214823362973",
      "msisdn": "+13109976224",
      "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "tags": [
        "personal",
        "customers",
        "active-customers"
      ],
      "data_limit": {
        "amount": "2048.0",
        "unit": "MB"
      },
      "current_billing_period_consumed_data": {
        "amount": "2049.0",
        "unit": "MB"
      },
      "actions_in_progress": true,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "esim_installation_status": "released",
      "version": "4.3",
      "resources_with_in_progress_actions": [],
      "eid": null,
      "authorized_imeis": [
        "106516771852751",
        "534051870479563",
        "508821468377961"
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

sim_cards

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 simpleSimCard of client.simCards.list()) {
  console.log(simpleSimCard.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card",
      "status": {
        "value": "enabled",
        "reason": "The SIM card is active, ready to connect to networks and consume data."
      },
      "type": "physical",
      "iccid": "89310410106543789301",
      "imsi": "081932214823362973",
      "msisdn": "+13109976224",
      "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "tags": [
        "personal",
        "customers",
        "active-customers"
      ],
      "data_limit": {
        "amount": "2048.0",
        "unit": "MB"
      },
      "current_billing_period_consumed_data": {
        "amount": "2049.0",
        "unit": "MB"
      },
      "actions_in_progress": true,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "esim_installation_status": "released",
      "version": "4.3",
      "resources_with_in_progress_actions": [],
      "eid": null,
      "authorized_imeis": [
        "106516771852751",
        "534051870479563",
        "508821468377961"
      ]
    }
  ],
  "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 cards (deepObject style). Originally: filter[tags], filter[iccid], filter[status]

Show child attributes

filter[tags]

string[]

A list of SIM card tags to filter on.

If the SIM card contains all of the given tags they will be found.

For example, if the SIM cards have the following tags:

['customers', 'staff', 'test']
['test']
['customers']

Searching for ['customers', 'test'] returns only the first because it's the only one with both tags.
Searching for test returns the first two SIMs, because both of them have such tag.
Searching for customers returns the first and last SIMs.

Example:

["personal", "customers", "active-customers"]

filter[iccid]

string

A search string to partially match for the SIM card's ICCID.

Example:

"89310410106543789301"

filter[status]

enum<string>[]

Filter by a SIM card's status.

Available options:

enabled,

disabled,

standby,

data_limit_exceeded,

unauthorized_imei

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

include_sim_card_group

boolean

default:false

It includes the associated SIM card group object in the response when present.

Example:

true

filter[sim_card_group_id]

string<uuid>

A valid SIM card group ID.

Example:

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

sort

enum<string>

Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign.

Available options:

current_billing_period_consumed_data.amount,

-current_billing_period_consumed_data.amount

Response

Successful response

data

SIMCard · object[]

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

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

data.record_type

string

Example:

"sim_card"

data.status

object

Show child attributes

data.status.value

enum<string>

The current status of the SIM card. It will be one of the following:

registering - the card is being registered
enabling - the card is being enabled
enabled - the card is enabled and ready for use
disabling - the card is being disabled
disabled - the card has been disabled and cannot be used
data_limit_exceeded - the card has exceeded its data consumption limit
setting_standby - the process to set the card in stand by is in progress
standby - the card is in stand by

Transitioning between the enabled and disabled states may take a period of time.

Available options:

registering,

enabling,

enabled,

disabling,

disabled,

data_limit_exceeded,

setting_standby,

standby

Example:

"enabled"

data.status.reason

string

It describes why the SIM card is in the current status.

Example:

"The SIM card is active, ready to connect to networks and consume data."

data.type

enum<string>

The type of SIM card

Available options:

physical,

esim

Example:

"physical"

data.iccid

string

The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.

Example:

"89310410106543789301"

data.imsi

string

SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI).
Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).

Example:

"081932214823362973"

data.msisdn

string

Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.

Example:

"+13109976224"

data.sim_card_group_id

string<uuid>

The group SIMCardGroup identification. This attribute can be null when it's present in an associated resource.

Example:

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

data.tags

string[]

Searchable tags associated with the SIM card

Example:

["personal", "customers", "active-customers"]

data.data_limit

object

The SIM card individual data limit configuration.

Show child attributes

data.data_limit.amount

string

Example:

"2048.0"

data.data_limit.unit

enum<string>

Available options:

MB,

GB

Example:

"MB"

data.current_billing_period_consumed_data

object

The SIM card consumption so far in the current billing cycle.

Show child attributes

data.current_billing_period_consumed_data.amount

string

Example:

"2049.0"

data.current_billing_period_consumed_data.unit

string

default:MB

Example:

"MB"

data.actions_in_progress

boolean

default:false

Indicate whether the SIM card has any pending (in-progress) actions.

Example:

true

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"

data.esim_installation_status

enum<string> | null

The installation status of the eSIM. Only applicable for eSIM cards.

Available options:

released,

disabled

Example:

"released"

data.version

string

The version of the SIM card.

Example:

"4.3"

data.resources_with_in_progress_actions

object[]

List of resources with actions in progress.

Example:

[]

data.eid

string | null

The Embedded Identity Document (eID) for eSIM cards.

Example:

null

data.authorized_imeis

string[] | null

List of IMEIs authorized to use a given SIM card.

Example:

[
  "106516771852751",
  "534051870479563",
  "508821468377961"
]

IoT

Networking

Get all SIM cards

Authorizations

Query Parameters

Response