用途
该技能面向使用 Telnyx 平台的开发者,用于管理号码被携出(port-out)时的相关请求。当号码从 Telnyx 转移至其他运营商时,可通过该技能的 Java SDK 示例列出、查看和更新携出状态。
主要能力
- 列出携出请求(GET /portouts),支持按过滤条件返回结果。
- 获取单个携出请求详情(GET /portouts/{id})。
- 列出全部携出事件(GET /portouts/events),查看指定事件(GET /portouts/events/{id}),并重新发布事件(POST /portouts/events/{id}/republish)。
- 针对指定携出订单列出可用的拒绝代码(GET /portouts/rejections/{portout_id})。
- 列出携出相关报告(GET /portouts/reports),创建报告(POST /portouts/reports,报告类型为 export_portouts_csv),并获取指定报告(GET /portouts/reports/{id})。
- 列出携出请求的评论(GET /portouts/{id}/comments)并创建评论(POST /portouts/{id}/comments)。
- 列出携出请求的支持文档(GET /portouts/{id}/supporting_documents)并创建支持文档列表(POST /portouts/{id}/supporting_documents,文档类型为 loa 或 invoice)。
- 授权或拒绝携出请求并更新状态(PATCH /portouts/{id}/{status}),必填参数为 reason,可选参数为 host_messaging。
使用方式
安装:通过 Maven 引入依赖 groupId 为 com.telnyx.sdk、artifactId 为 telnyx、版本 6.89.0,或在 Gradle 中使用 implementation("com.telnyx.sdk:telnyx:6.89.0")。
初始化:导入 com.telnyx.sdk.client.TelnyxClient 与 com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient,使用 TelnyxOkHttpClient.fromEnv() 创建客户端。
错误处理:所有 API 调用可能因网络错误、限流(429)、验证错误(422)或认证错误(401)而失败。示例中通过捕获 TelnyxServiceException 并检查 statusCode() 进行处理;422 时提示检查必填字段与格式,429 时等待并采用指数退避重试。常见错误码:401 无效 API 密钥,403 权限不足,404 资源未找到,422 验证错误,429 限流。
分页:列表方法返回一页数据,可使用 .autoPager() 自动迭代,例如 for (var item : page.autoPager()) { ... };也可使用 .hasNextPage() 与 .nextPage() 手动控制。
适用场景
适用于需要在 Telnyx 平台上以编程方式跟踪和处理号码携出流程的场景,包括查询携出请求与事件、准备或生成携出报告、补充支持文档与评论,以及对携出请求进行授权或拒绝操作。
限制
使用前需具备 Telnyx 平台访问资格并配置 API 密钥(通过环境变量加载)。各接口返回字段为固定结构,实际业务规则与平台侧限制暂未提供。该资料未说明收费、价格或其他使用条件。