特洛兹 REST API

将语音融入到任何事物中 特洛兹API

发起呼叫、接收 Webhook、流式传输记录并嵌入功能齐全的拨号器 — 所有这些都通过干净的 REST API 以及适用于每种主要语言的 SDK 实现。

休息API网络钩子OpenAPI 规范软件开发工具包99.99% 正常运行时间
200 OK — 呼叫已排队
包含 OpenAPI 3.0 规范
teloz-api.js
// Initiate an outbound call
 
const response = await teloz.calls.create({
to: "+12025550123",
from: "+18005550199",
record: true,
webhook: "https://your-app.com/events"
});
 
// Response
// {
// sid: "CA3f9a…"
// status: "queued"
// duration: null
// }
从数字来看

从第一天起就为生产而打造

Teloz API 与为数千个美国用户提供支持的基础设施相同 商务电话系统 每天。

99.99%
API 正常运行时间 SLA
企业级可靠性
<100毫秒
中位响应时间
遍及美国所有地区
50+
REST 端点
通话、联系人、号码等
4 个 SDK
官方语言库
节点、Python、PHP、Go
端点

六个资源组,50 多个端点

将语音、短信和联络中心功能构建到您的产品中所需的一切。

发布·获取·删除

通话

发起外拨呼叫、检索通话记录、访问录音并流式传输实时文字记录。

邮政/v1/calls
得到/v1/calls/:sid
得到/v1/calls/:sid/recording
删除/v1/calls/:sid
发布·获取·放置·删除

联系方式

创建、读取、更新和删除联系人。与您的 CRM 同步或建立您自己的电话簿。

邮政/v1/contacts
得到/v1/contacts
/v1/contacts/:id
删除/v1/contacts/:id
发布·获取·删除

数字

搜索可用号码、配置本地或免费 DID 以及管理号码配置。

得到/v1/numbers/available
邮政/v1/numbers
得到/v1/numbers/:id
删除/v1/numbers/:id
发布·获取·删除

网络钩子

注册端点以接收呼叫、语音邮件、文字记录和短信的实时事件。

邮政/v1/webhooks
得到/v1/webhooks
/v1/webhooks/:id
删除/v1/webhooks/:id
得到

分析

为您的仪表板和报告提取呼叫量、持续时间、处置和队列统计信息。

得到/v1/analytics/calls
得到/v1/analytics/queues
得到/v1/analytics/agents
得到/v1/analytics/summary
JavaScript SDK

嵌入式拨号器

只需几行 JavaScript,即可将功能齐全的点击通话小部件放入任何 Web 应用程序中。

teloz.dialer.init(config)
teloz.dialer.call(number)
teloz.dialer.on('event', fn)
teloz.dialer.destroy()
代码示例

集成您选择的语言

Node.js、Python、PHP 和 Go 的官方 SDK — 或致电 休息API 直接从任何语言。

发起呼叫
import Teloz from "@teloz/node";
 
const client = new Teloz(process.env.TELOZ_API_KEY);
 
const call = await client.calls.create({
to: "+12025550123",
from: "+18005550199",
record: true,
transcribe: true,
webhook: "https://your-app.com/events",
});
 
console.log(call.sid); // CA3f9a7b…
网络钩子

对每个呼叫事件做出反应 即时的

注册一个 Webhook URL,Teloz 会在事件发生时将签名的 JSON 有效负载 POST 到您的端点 - 无需轮询。将 webhook 与我们的 整合 端到端自动化您的工作流程。

每个有效负载上的 HMAC-SHA256 签名
使用指数退避自动重试
仪表板中的交付日志和重播
可按每个端点的事件类型进行过滤
事件类别
call.initiated当出站呼叫排队时触发
通话
call.ringing目的地电话振铃
通话
call.answered呼叫已接听 — 包括呼叫者元数据
通话
call.completed通话结束 — 包括持续时间、处理
通话
call.missed来电无人接听
通话
recording.ready录音文件网址可供下载
记录
transcript.ready附有完整的文字记录和演讲者标签
人工智能
voicemail.new收到带有音频 URL 的新语音邮件
语音信箱
sms.inbound通过配置的号码收到入站短信
短信
API常见问题解答

简短的答案。

开始构建之前的常见问题。

注册 Teloz 帐户并导航至“设置”→“开发人员”→“API 密钥”。您可以创建多个具有范围权限(只读、仅调用、管理)的密钥并随时撤销它们。

是的。完整的 OpenAPI 3.0 规范可在 api.teloz.com/openapi.json 上获取,并且可以直接导入到 Postman、Insomnia 或任何兼容的客户端中。它与每个版本保持同步。

API 使用 Bearer 令牌身份验证。将您的 API 密钥作为“Bearer YOUR_API_KEY”在授权标头中传递。对于服务器到服务器的使用,我们建议使用范围键;对于浏览器嵌入的拨号器,使用 OAuth 短期令牌。

是 - 默认限制是每个 API 密钥每秒 100 个请求。最多允许 10 秒内突发高达 500 个请求/秒。企业计划可以要求更高的限制。每个响应都会返回速率限制标头(X-RateLimit-Remaining、X-RateLimit-Reset)。

每个 Webhook POST 都包含一个 X-Teloz-Signature 标头,其中包含使用 Webhook 密钥签名的原始请求正文的 HMAC-SHA256 哈希值。在您的一端计算相同的哈希值并进行比较——拒绝不匹配的请求。

是的。将基本 URL https://api.sandbox.teloz.com 与您的测试 API 密钥一起使用。在沙盒模式下进行的呼叫永远不会连接到 PSTN - 它们模拟完整的事件生命周期,包括录音和文字记录。

开始使用 Teloz API 进行构建。 包括免费沙盒。

在两分钟内获取您的 API 密钥。在上线之前使用我们功能齐全的沙箱进行测试 - 无需信用卡。

完整的 OpenAPI 规范4个官方SDK沙盒环境美国开发商支持