Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const simCardOrder = await client.simCardOrders.create({ address_id: '1293384261075731499', quantity: 23 }); console.log(simCardOrder.data);

{ "data": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "sim_card_order", "quantity": 21, "cost": { "amount": "2.52", "currency": "USD" }, "order_address": { "id": "1293384261075731499", "street_address": "600 Congress Avenue", "extended_address": "14th Floor", "locality": "Austin", "administrative_area": "TX", "country_code": "US", "postal_code": "78701" }, "tracking_url": "http://www.example.com/", "status": "pending", "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.

Body

application/json

address_id

string

required

Uniquely identifies the address for the order.

Example:

"1293384261075731499"

quantity

integer

required

The amount of SIM cards to order.

Required range: x >= 1

Example:

23

Response

Successful Response

data

SIMCardOrder · object

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

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

data.record_type

string

Identifies the type of the resource.

Example:

"sim_card_order"

data.quantity

integer

The amount of SIM cards requested in the SIM card order.

Required range: x >= 1

Example:

21

data.cost

object

An object representing the total cost of the order.

Show child attributes

data.cost.amount

string

A string representing the cost amount.

Example:

"2.32"

data.cost.currency

string

Filter by ISO 4217 currency string.

Example:

"USD"

Example:

{ "amount": "2.52", "currency": "USD" }

data.order_address

object

An object representing the address information from when the order was submitted.

Show child attributes

data.order_address.id

string

Uniquely identifies the address for the order.

Example:

"1293384261075731499"

data.order_address.first_name

string

The first name of the shipping recipient.

Example:

"John"

data.order_address.last_name

string

The last name of the shipping recipient.

Example:

"Smith"

data.order_address.business_name

string

The name of the business where the address is located.

Example:

"Telnyx LLC"

data.order_address.street_address

string

The name of the street where the address is located.

Example:

"600 Congress Avenue"

data.order_address.extended_address

string

Supplemental field for address information.

Example:

"14th Floor"

data.order_address.locality

string

The name of the city where the address is located.

Example:

"Austin"

data.order_address.administrative_area

string

State or province where the address is located.

Example:

"TX"

data.order_address.country_code

string

The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.

Example:

"US"

data.order_address.postal_code

string

Postal code for the address.

Example:

"78701"

Example:

{
  "id": "1293384261075731499",
  "street_address": "600 Congress Avenue",
  "extended_address": "14th Floor",
  "locality": "Austin",
  "administrative_area": "TX",
  "country_code": "US",
  "postal_code": "78701"
}

data.tracking_url

string<uri>

The URL used to get tracking information about the order.

Example:

"http://www.example.com/"

data.status

enum<string>

The current status of the SIM Card order.<ul> <li><code>pending</code> - the order is waiting to be processed.</li> <li><code>processing</code> - the order is currently being processed.</li> <li><code>ready_to_ship</code> - the order is ready to be shipped to the specified address.</li> <li><code>shipped</code> - the order was shipped and is on its way to be delivered to the specified address.</li> <li><code>delivered</code> - the order was delivered to the specified address.</li> <li><code>canceled</code> - the order was canceled.</li> </ul>

Available options:

pending,

processing,

ready_to_ship,

shipped,

delivered,

canceled

Example:

"pending"

data.created_at

string

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

Example:

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

data.updated_at

string

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

Example:

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

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup