Ringflow REST API · v2
一个API用于调用， 短信、人工智能 — 专为现代团队打造。
Ringflow 的 REST API 使您能够以编程方式控制通信堆栈的每个部分 - 出站呼叫、批量短信、双通道录音、AI 接待代理和实时事件 Webhooks - 所有这些都位于单个经过身份验证的端点后面。
免费永久沙箱距第一次实时通话 5 分钟服务水平协议支持的API层
POST https://api.ringflow.com/v2/calls
curl -X POST https://api.ringflow.com/v2/calls \
-H "Authorization: Bearer $RINGFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+14155550199",
"from": "+19172544289",
"recordDualChannel": true,
"aiReceptionistId": "agent_rfw_support"
}'
# 201 Created
{
"id": "call_rfw_2Kj8mNpQ",
"status": "ringing",
"to": "+14155550199",
"recording": true,
"ai": true
}服务水平协议-支持的API·企业安全·可用的 BAA·通话录音编辑·HMAC 事件签名·欧盟和美国数据驻留
语音通话
- POST/v2/calls— 拨打任意号码
- GET/v2/calls/:id— 获取实时状态、持续时间和录音
- POST/v2/calls/:id/transfer— 通话中热转或冷转
- DELETE/v2/calls/:id— 立即终止当前通话
短信和彩信
- POST/v2/messages— 向单个收件人发送短信或彩信
- POST/v2/messages/bulk— 每个请求最多可批量处理 1000 条消息
- GET/v2/messages/:id— 轮询递送状态和承运人收据
录音
- POST/v2/calls/:id/record— 启动双通道通话录音
- DELETE/v2/calls/:id/record— 停止录音并触发存储
- POST/v2/recordings/:id/transcribe— 请求异步 AI 转录
AI Receptionist
- POST/v2/ai/agents— 配备新的人工智能接待员
- PUT/v2/ai/agents/:id/knowledge— 推送常见问题解答、文档和升级规则
- GET/v2/ai/sessions/:id/summary— 检索通话后 AI 摘要
活动
- POST/v2/events/subscriptions— 订阅任意平台活动
- GET/v2/events/subscriptions— 列出并过滤您的订阅
- DELETE/v2/events/subscriptions/:id— 删除事件订阅
身份验证和密钥
- POST/v2/auth/tokens— 发行短期不记名代币
- POST/v2/auth/keys— 创建作用域工作区 API 密钥
- PUT/v2/auth/keys/:id/rotate— 零停机密钥轮换
客户端 SDK
您的堆栈的惯用客户端。
每个 Ringflow SDK 都是代码优先构建的 - 不是根据规范生成的。重试、分页光标和 webhook 验证都是一流的，而不是事后的想法。
npm i @ringflow/sdk
import { Ringflow } from "@ringflow/sdk"
const client = new Ringflow({
apiKey: process.env.RINGFLOW_API_KEY,
region: "us-east-1",
})
// Place a call and stream status updates
const call = await client.calls.create({
to: "+14155550199",
from: "+19172544289",
recordDualChannel: true,
onStatus: (evt) => console.log(evt.status),
})
console.log(call.id) // call_rfw_2Kj8mNpQ带抖动的智能重试
基于光标的分页
内置签名验证
100% TypeScript 覆盖率
速率限制
每个级别都有可预测的限制。
限制是按工作空间而不是按 IP 强制执行的。每一个回应都承载着 X-RateLimit-Remaining, X-RateLimit-Reset，和一个 Retry-After 标头打开 429s 这样你就可以优雅地退后。
| 计划 | 持续 | 爆破帽 | 并发通话数 |
|---|---|---|---|
| 沙盒 | 5 请求/秒 | 15 请求/秒 | 2 次通话 |
| 起动机 | 40 请求/秒 | 80 请求/秒 | 25 通电话 |
| 商业 | 150 请求/秒 | 300 请求/秒 | 150 通电话 |
| 企业风俗 | 风俗 | 风俗 | 无限 |
为什么选择 Ringflow
建造不同。价格公道。
最多 电话 API 事后才添加人工智能。 Ringflow 从头开始将人工智能、语音和消息传递构建为单个连贯的 API，因此您不必将三个供应商捆绑在一起。
| 能力 | Ringflow | 典型替代方案 |
|---|---|---|
| 统一呼叫+短信+AI合一API | ✕ | |
| 永久沙箱——无有效期、无卡 | ✕ | |
| 开箱即用的双通道录音 | ✕ | |
| 通过 REST 端点的 AI 接待员 | ✕ | |
| HMAC 签名的 Webhook 交付 | ||
| 零停机 API 密钥轮换 | ✕ | |
| 提供企业安全审计+BAA | ✕ |
我们的承诺
按照生产标准构建的 REST API。
Ringflow 的 API 旨在处理实际生产工作负载 - 一致的 JSON 响应、强大的身份验证、明确的速率限制信号以及用于安全集成测试的永久沙箱。
JSON 响应
OAuth 2.0 身份验证
速率限制标头
幂等键
Webhook 重试
版本化端点
99 点正常运行时间
沙箱测试
常问问题
常见问题解答
主动回答常见问题解答可以增强用户信心并减少支持请求。
登录到 Ringflow 仪表板，导航到设置 → 开发人员 → API 密钥，然后单击新建密钥。每个密钥的范围仅限于特定资源（呼叫、消息、AI 或全部），并绑定到单个工作区环境。
是的。每个 Ringflow 帐户都包含一个永久的沙箱环境。沙盒呼叫使用模拟运营商路由，因此您可以测试完整的集成 - 包括录音、AI 接待员和网络钩子 - 无需任何使用费或真正的电话线。
大多数情况下，从注册到实时通话不到 5 分钟。在仪表板中配置一个号码，复制您的 API 密钥，然后 POST 到 /v2/calls。我们的入职指南将逐步介绍它。
每个事件 POST 都包含一个 X-Ringflow-Signature-256 标头 - 原始请求正文的 HMAC-SHA256 摘要，以您的 Webhook 密钥作为密钥。 Node.js 和 Python SDK 都公开了 verifySignature() 实用程序，因此您无需自己实现它。
Ringflow 在工作区级别提供美国和欧盟数据驻留区域。商业伙伴协议适用于医疗保健用例的商业和企业计划。请联系我们的团队获取完整的安全文档包。
AI 接待员包含在商业和企业计划中。沙盒和入门帐户具有对 AI 端点的读取权限以进行集成测试，但实时 AI 呼叫处理需要有效的商业或企业订阅。