开始使用 API、Playground 和 webhook

找到 API 密钥,安全地发起首次请求,并在不泄露凭据的情况下连接事件通知。

使用最新 API 参考文档

登录后打开 API 文档。文档包含支持的接口、必填字段和示例。具体请求信息以文档为准;本指南介绍操作流程,不重复接口规范。

准备密钥

按照身份验证提示查看或复制密钥。验证后,文档允许在五分钟内查看密钥并使用 Playground;生成或重新生成密钥需要再次验证。像保护密码一样保护密钥:保存在应用服务器上,不要放进公开代码仓库、浏览器代码或截图。

安全地发起首次请求

  1. 打开 Playground,选择适合您账户的只读预设,例如列出 SIP 身份。
  2. 检查方法、路径和参数。使用自己账户返回的标识符,不要使用示例值。
  3. 选择 Run request,同时检查 HTTP 状态和响应内容。
  4. 在应用中使用文档中的请求示例,并安全存储凭据。

Playground 使用您的账户。发送消息、拨打电话或订购服务的请求可能执行真实操作并产生费用。不要将其视为免费沙箱。

添加 webhook 通知

在账户集成中添加 HTTPS 端点并选择所需事件。webhook 签名密钥与 API 密钥不同。验证签名,每个事件只处理一次,并及时确认接收。排查时查看投递日志。重试付费操作前,请阅读 API 的重试和重复请求规则;仅仅超时并不能证明操作失败。

相关指南

选择对应的服务参考文档

参考文档分为 Lookup、Pricing、SIP、SMS、Contacts、Speech API、Phone Numbers、Voice API 和 Calls & recordings。具体前提条件、字段和费用请查看相应接口文档。浏览器通话有单独的 Webphone SDK 指南,与服务器端 Voice API 通话控制不同。

代理有权阅读 API 文档,并不代表能访问账户所有者的密钥或以密钥在 Playground 中执行请求。请让账户所有者管理集成凭据,不要共享其登录信息。

使用返回的引用和分页

将公开通话引用视为不可自行解析或拼造的值:复制自己响应中完整的 CALL- 引用,不要手动构造,也不要使用电话系统内部标识符。历史通话和活动通话属于不同列表。控制操作还要求通话处于支持的状态;历史记录不一定能被控制。

查询通话历史时,只要 pagination.has_more 为真,就继续使用 pagination.next_cursor。保持原来的 days、limit 和 SIP 身份筛选条件不变。不要解码或修改游标。游标过期后重新查询,并按公开通话引用核对结果。文档标明为 UTC 的 API 时间戳需要主动转换后显示,不会自动成为浏览器本地时间。

处理错误,避免重复付费操作

结合 HTTP 状态和结构化错误阅读结果。重试前先修正验证或授权错误。遇到频率限制时遵守文档中的等待时间。付费操作超时或临时出错时,先查看操作状态和接口的重复请求规则,再决定是否重新提交;更改请求标识符可能会产生新操作。向支持团队提供公开请求编号或引用、时间以及已去除敏感数据的错误信息,切勿提供 API 密钥。