用途:通过 Telnyx 官方 JavaScript SDK 管理 Telnyx 账户相关数据,涵盖余额查询、消费明细与汇总、发票、支付自动充值偏好、Webhook 投递调试以及审计日志等账户运维场景。
安装与初始化:使用 npm install telnyx 安装;通过 import Telnyx from 'telnyx' 引入,并以 new Telnyx({ apiKey: process.env['TELNYX_API_KEY'] }) 初始化客户端,apiKey 为默认参数可省略。
主要能力:审计日志使用 client.auditEvents.list() 迭代获取;余额使用 client.balance.retrieve();月度费用明细和汇总分别使用 client.chargesBreakdown.retrieve({ start_date }) 与 client.chargesSummary.retrieve({ end_date, start_date }),日期范围均不能超过 31 天;明细记录使用 client.detailRecords.list();发票使用 client.invoices.list() 或 client.invoices.retrieve(id);自动充值偏好使用 client.payment.autoRechargePrefs.list() 与 .update();存储支付交易使用 client.payment.createStoredPaymentTransaction({ amount });用户标签使用 client.userTags.list();Webhook 投递使用 client.webhookDeliveries.list() 与 .retrieve(id)。
分页与错误处理:列表方法返回可自动分页的迭代器,可用 for await 遍历全部页面。所有调用都可能失败,建议区分 APIConnectionError(网络错误)、RateLimitError(429,可用 retry-after 配合指数退避重试)和 APIError(如 401、403、404、422)。审计日志为尽力而为且最终一致的记录。
限制:资料未给出价格、配额或具体业务开通条件,需以 Telnyx 官方文档为准。