<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Account - JavaScript

Installation

npm install [email protected]

Setup

import Telnyx from 'telnyx';

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

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

List Audit Logs

Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes.

GET /audit_events

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

Returns: alternateresourceid (string | null), changemadeby (enum: telnyx, accountmanager, accountowner, organizationmember), changetype (string), changes (array | null), createdat (date-time), id (uuid), organizationid (uuid), recordtype (string), resourceid (string), user_id (uuid)

Get user balance details

GET /balance

const balance = await client.balance.retrieve();

console.log(balance.data);

Returns: availablecredit (string), balance (string), creditlimit (string), currency (string), pending (string), record_type (enum: balance)

Get monthly charges breakdown

Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days.

GET /charges_breakdown

const chargesBreakdown = await client.chargesBreakdown.retrieve({ start_date: '2025-05-01' });

console.log(chargesBreakdown.data);

Returns: currency (string), enddate (date), results (array[object]), startdate (date), useremail (email), userid (string)

Get monthly charges summary

Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days.

GET /charges_summary

const chargesSummary = await client.chargesSummary.retrieve({
  end_date: '2025-06-01',
  start_date: '2025-05-01',
});

console.log(chargesSummary.data);

Returns: currency (string), enddate (date), startdate (date), summary (object), total (object), useremail (email), userid (string)

Search detail records

Search for any detail record across the Telnyx Platform

GET /detail_records

// Automatically fetches more pages as needed.
for await (const detailRecordListResponse of client.detailRecords.list()) {
  console.log(detailRecordListResponse);
}

Returns: carrier (string), carrierfee (string), cld (string), cli (string), completedat (date-time), cost (string), countrycode (string), createdat (date-time), currency (string), deliverystatus (string), deliverystatusfailoverurl (string), deliverystatuswebhookurl (string), direction (enum: inbound, outbound), errors (array[string]), fteu (boolean), mcc (string), messagetype (enum: SMS, MMS, RCS), mnc (string), onnet (boolean), parts (integer), profileid (string), profilename (string), rate (string), recordtype (string), sentat (date-time), sourcecountrycode (string), status (enum: gwtimeout, delivered, dlrunconfirmed, dlrtimeout, received, gwreject, failed), tags (string), updatedat (date-time), user_id (string), uuid (string)

List invoices

Retrieve a paginated list of invoices.

GET /invoices

// Automatically fetches more pages as needed.
for await (const invoiceListResponse of client.invoices.list()) {
  console.log(invoiceListResponse.file_id);
}

Returns: fileid (uuid), invoiceid (uuid), paid (boolean), periodend (date), periodstart (date), url (uri)

Get invoice by ID

Retrieve a single invoice by its unique identifier.

GET /invoices/{id}

const invoice = await client.invoices.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(invoice.data);

Returns: downloadurl (uri), fileid (uuid), invoiceid (uuid), paid (boolean), periodend (date), period_start (date), url (uri)

List auto recharge preferences

Returns the payment auto recharge preferences.

GET /payment/autorechargeprefs

const autoRechargePrefs = await client.payment.autoRechargePrefs.list();

console.log(autoRechargePrefs.data);

Returns: enabled (boolean), id (string), invoiceenabled (boolean), preference (enum: creditpaypal, ach), rechargeamount (string), recordtype (string), threshold_amount (string)

Update auto recharge preferences

Update payment auto recharge preferences.

PATCH /payment/autorechargeprefs

Optional: enabled (boolean), invoiceenabled (boolean), preference (enum: creditpaypal, ach), rechargeamount (string), thresholdamount (string)

const autoRechargePref = await client.payment.autoRechargePrefs.update();

console.log(autoRechargePref.data);

Returns: enabled (boolean), id (string), invoiceenabled (boolean), preference (enum: creditpaypal, ach), rechargeamount (string), recordtype (string), threshold_amount (string)

List User Tags

List all user tags.

GET /user_tags

const userTags = await client.userTags.list();

console.log(userTags.data);

Returns: numbertags (array[string]), outboundprofile_tags (array[string])

Create a stored payment transaction

POST /v2/payment/storedpaymenttransactions — Required: amount

const response = await client.payment.createStoredPaymentTransaction({ amount: '120.00' });

console.log(response.data);

Returns: amountcents (integer), amountcurrency (string), autorecharge (boolean), createdat (date-time), id (string), processorstatus (string), recordtype (enum: transaction), transactionprocessingtype (enum: stored_payment)

List webhook deliveries

Lists webhook_deliveries for the authenticated user

GET /webhook_deliveries

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

Returns: attempts (array[object]), finishedat (date-time), id (uuid), recordtype (string), startedat (date-time), status (enum: delivered, failed), userid (uuid), webhook (object)

Find webhook_delivery details by ID

Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.

GET /webhook_deliveries/{id}

const webhookDelivery = await client.webhookDeliveries.retrieve(
  'C9C0797E-901D-4349-A33C-C2C8F31A92C2',
);

console.log(webhookDelivery.data);

Returns: attempts (array[object]), finishedat (date-time), id (uuid), recordtype (string), startedat (date-time), status (enum: delivered, failed), userid (uuid), webhook (object)