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 purchase = await client.actions.purchase.create({ amount: 10 });

console.log(purchase.data);

{
  "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"
      ]
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

POST

actions

purchase_esims

JavaScript

import Telnyx from 'telnyx';

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

const purchase = await client.actions.purchase.create({ amount: 10 });

console.log(purchase.data);

{
  "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"
      ]
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

amount

integer

required

The amount of eSIMs to be purchased.

Required range: x >= 1

Example:

10

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"

Response

Successful response

data

SIMCard · object[]

Successfully registered SIM cards.

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"
]

errors

object[]

Show child attributes

errors.code

string

required

errors.title

string

required

errors.detail

string

errors.source

object

Show child attributes

errors.source.pointer

string

JSON pointer (RFC6901) to the offending entity.

errors.source.parameter

string

Indicates which query parameter caused the error.

errors.meta

object

Updates information for a SIM Card Data Usage Notification Register SIM cards

⌘I

IoT

Networking

Purchase eSIMs

Authorizations

Body

Response