Telnyx CLI 是 Telnyx 提供的命令行工具,用于在终端中管理电话相关资源并访问 Telnyx API。根据资料,它把每个 API 端点映射为一条 CLI 命令,共包含 946 条命令,覆盖消息、语音、电话号码、IoT、AI 等方向。
用途方面,该工具面向需要通过命令行操作 Telnyx 服务的场景,例如管理电话号码、发送消息、拨打电话,以及访问 Telnyx 各类 API。
主要能力包括:发送短信、列出电话号码、搜索可用号码、订购电话号码、发起外呼、列出 SIM 卡、创建 AI 助手、查询账户余额。命令结构统一为 telnyx <resource> <action> [--flag value ...],其中 resource 对应 API 路径,action 包括 list、create、get、update、delete 以及资源特有的动词。CLI 具备自文档能力,可在任意层级使用 --help 查看帮助,例如 telnyx --help、telnyx messages --help、telnyx messages create --help。
安装方式提供三种:Homebrew(macOS/Linux)执行 brew install telnyx/tap/telnyx;Go install 执行 go install github.com/team-telnyx/telnyx-go/cmd/telnyx@latest;或从 GitHub Releases 下载二进制文件,地址为 https://github.com/team-telnyx/telnyx-go/releases。
认证方式为设置环境变量 TELNYX_API_KEY,CLI 会从环境中读取该变量,建议在 shell 配置文件中设置一次。
使用方式上,常见操作示例包括:发送短信 telnyx messages create --from +15551234567 --to +15559876543 --text "Hello from the CLI";列出电话号码 telnyx phone-numbers list --page-size 25;搜索可用号码 telnyx available-phone-numbers list --country-code US --state CA --features sms;订购号码 telnyx number-orders create --phone-numbers +15551234567;发起外呼 telnyx calls create --connection-id 1234567890 --from +15551234567 --to +15559876543;列出 SIM 卡 telnyx sim-cards list --page-size 10;创建 AI 助手 telnyx assistants create --name "Support Agent" --model telnyx_ai;查询账户余额 telnyx balance get。
输出格式支持默认的人类可读表格,以及通过 --format json 输出 JSON,便于脚本处理,例如 telnyx phone-numbers list --format json | jq '.data[].phone_number'。
适用场景方面,资料给出的建议是:快速一次性操作、Shell 脚本与自动化、交互式探索、CI/CD 流水线适合使用 CLI;应用代码和复杂业务逻辑建议使用 SDK(Python、JS、Go、Java、Ruby)。
限制方面,资料未提供关于收费、价格、平台兼容性细节、速率限制或具体错误处理的信息,这些内容暂未提供。