用途
Telnyx Account Access - curl 是一个面向 Telnyx 平台的账户访问管理技能,通过 REST API 与 curl 命令完成账户级配置操作。它覆盖账户地址、SSO 认证提供商、访问 IP 地址、计费组和集成密钥等资源的增删改查,适合在命令行或脚本中直接调用。
安装与认证
curl 在 macOS、Linux 和 Windows 10+ 上已预装,无需额外安装。使用前需设置 API 密钥环境变量:
export TELNYX_API_KEY="YOUR_API_KEY_HERE"
所有示例均使用 $TELNYX_API_KEY 进行认证,请求头为 Authorization: Bearer $TELNYX_API_KEY。
主要能力
访问 IP 地址(Access IP Address)
- 列出所有访问 IP 地址:GET /access_ip_address
- 创建:POST /access_ip_address,必填 ip_address,可选 description
- 查询单个:GET /access_ip_address/{access_ip_address_id}
- 删除:DELETE /access_ip_address/{access_ip_address_id}
返回字段包括 created_at、description、id、ip_address、source、status(枚举:pending、added)、updated_at、user_id。
账户地址(Addresses)
- 列出所有地址:GET /addresses,支持 sort 参数(如 sort=street_address)
- 创建地址:POST /addresses,必填 first_name、last_name、business_name、street_address、locality、country_code;可选 address_book、administrative_area、borough、customer_reference、extended_address、neighborhood、phone_number、postal_code、validate_address
- 验证地址(用于紧急服务):POST /addresses/actions/validate,必填 country_code、street_address、postal_code;可选 administrative_area、extended_address、locality。返回 errors、record_type、result(枚举:valid、invalid)、suggested
- 查询地址:GET /addresses/{id}
- 删除地址:DELETE /addresses/{id}
- 接受地址建议:POST /addresses/{id}/actions/accept_suggestions,用于 Operator Connect 的新紧急地址并完成关联号码向 Microsoft 的上传,返回 accepted、id、record_type(枚举:address_suggestion)
SSO 认证提供商(Authentication Providers)
- 列出所有:GET /authentication_providers,支持 sort=name
- 创建:POST /authentication_providers,必填 name、short_name、settings;可选 active、settings_url
- 查询:GET /authentication_providers/{id}
- 更新:PATCH /authentication_providers/{id},可选 active、name、settings、settings_url、short_name。示例 settings 包含 idp_entity_id、idp_sso_target_url、idp_cert_fingerprint、idp_cert_fingerprint_algorithm
- 删除:DELETE /authentication_providers/{id}
返回字段包括 activated_at、active、created_at、id、name、organization_id、record_type、settings、short_name、updated_at。
计费组(Billing Groups)
- 列出所有:GET /billing_groups
- 创建:POST /billing_groups,可选 name
- 查询:GET /billing_groups/{id}
- 更新:PATCH /billing_groups/{id},可选 name
- 删除:DELETE /billing_groups/{id}
返回字段包括 created_at、deleted_at、id、name、organization_id、record_type(枚举:billing_group)、updated_at。
集成密钥(Integration Secrets)
- 列出所有:GET /integration_secrets
- 创建:POST /integration_secrets,必填 identifier、type;可选 password、token、username
- 删除:DELETE /integration_secrets/{id}
返回字段包括 created_at、id、identifier、record_type、updated_at。
访问令牌(Access Token)
- 为凭证创建访问令牌(JWT):POST /telephony_credentials/{id}/token
使用方式
所有请求发送至 https://api.telnyx.com/v2/ 下的对应端点,使用 curl 的 -X 指定方法、-H 设置请求头、-d 传递 JSON 请求体。示例:
curl -X POST -H "Authorization: Bearer $TELNYX_API_KEY" -H "Content-Type: application/json" -d '{"ip_address": "203.0.113.10"}' "https://api.telnyx.com/v2/access_ip_address"
错误处理
API 调用可能因网络错误、速率限制(429)、验证错误(422)或认证错误(401)而失败,生产代码中应始终处理错误。示例通过 -w "\n%{http_code}" 获取 HTTP 状态码并分支处理:2* 成功、422 验证错误、429 速率限制(延迟后重试)、401 认证失败。常见错误码:401 无效 API 密钥、403 权限不足、404 资源未找到、422 验证错误(检查字段格式)、429 速率限制(使用指数退避重试)。
分页
列表端点返回分页结果,使用 page[number] 和 page[size] 查询参数翻页,并检查响应中的 meta.total_pages。
适用场景
适用于需要通过命令行或自动化脚本管理 Telnyx 账户访问配置的场景,例如批量维护 IP 白名单、配置企业 SSO 登录、管理计费分组、创建集成密钥,以及为 Operator Connect 处理紧急地址验证与建议接受。
限制
资料未提供该技能的收费、价格、平台兼容性细节、速率限制具体阈值或性能数据,暂未提供。使用前需自行准备有效的 Telnyx API 密钥。