开发者 API

您的商务电话,
现在可编程。

您的 Ody 工作区中的每个联系人、对话、消息和通话都通过一个简洁的 REST API 提供 | | 此外还有一个用于 AI 助手的 MCP 服务器、签名 Webhook 和 SDK。一个密钥,几分钟内即可创建。

Bearer 认证 · ody_live_ 和 ody_test_ 密钥 · 设置 → 开发者 API

send-sms.sh | | 您的第一个 API 调用
# 从您的 Ody 号码发送短信
curl https://api.ody.co/v1/api/messages \
-H "Authorization: Bearer ody_live_…" \
-H "Idempotency-Key: order-1042-shipped" \
-d '{"to": "+15125550123", "body": "Your order shipped!"}'
201 已创建
{
"conversationId": "b4a6f0…",
"message": { "body": "Your order shipped!" },
"simulated": false
}
POST /messages 上的幂等键 | | 24 小时内的重试会重放首次响应
每个列表端点上的游标分页 | | 遵循 nextCursor,永不遗漏任何一行
标准 RateLimit-Limit / -Remaining / -Reset 标头,429 上的 Retry-After
统一的 JSON 错误封装,每个响应都带有 X-Request-Id 回显

平台

在 Ody 上构建所需的一切

六个部分,一个 API 密钥。以最好的方式设计得“无聊”:可预测的资源、可预测的错误、可预测的页面。

REST API

联系人 CRUD、对话、SMS/MMS 发送、消息搜索、通话记录、电话号码、您的 AI 代理及其知识库,位于 https://api.ody.co/v1/api | 使用您的 ody_live_ 密钥进行 Bearer 认证。

GET /v1/api/contacts

用于 AI 助手的 MCP

将 ChatGPT、Claude 或 Cursor 连接到 https://api.ody.co/v1/mcp,您的助手将获得 29 种工具 | 列出和更新联系人、阅读对话、搜索消息、发送短信、配置 AI 代理、维护其知识库 | 由您的密钥限定范围。

29 tools · /v1/mcp

签名 Webhook

带有 Standard-Webhooks HMAC 签名的出站 Webhook | | webhook-id、webhook-timestamp 和 webhook-signature 标头 | | 自动重试,以及可随时轮换的每个端点密钥。

webhook-signature: v1,…

测试模式

ody_test_ 密钥的行为与实时密钥完全相同,但消息发送是模拟的 | | 不会发送任何真实的短信。将您的 CI 指向生产环境,高枕无忧。

"simulated": true

TypeScript 和 Python SDK

官方、完全类型化的客户端,内置自动分页、类型化错误、幂等发送和 Webhook 签名验证 | | 因此您无需再手动编写 HMAC。

await ody.messages.send(…)

OpenAPI 3.1

整个接口都在 /v1/api/openapi.json 中的一个机器可读规范中描述 | | 生成客户端、模拟服务器,或者直接将其提供给您的 AI 编码代理。

GET /v1/api/openapi.json

最小权限

只执行您指定操作的密钥

在 Ody 应用的“设置 → Developer API”下创建密钥,并将每个密钥精确限定为集成所需的范围 | 涵盖联系人、对话、消息、号码、通话、AI 代理、知识和 Webhook 的十二个范围。只读仪表板密钥绝不能向客户发送短信。

ody_live_… · 范围限定密钥
✓contacts:read
✕contacts:write
✓conversations:read
✕conversations:write
✓messages:send
✓numbers:read
✓knowledge:read
✕knowledge:write
✕webhooks:manage

模型上下文协议

粘贴一个代码块,您的 AI 即可接听电话

相同的 API 密钥为 MCP 服务器提供支持。将此配置导入 ChatGPT、Claude 或 Cursor,并让您的助手了解未读对话、起草回复或向客户发送短信 | 每次调用都限定在密钥允许的范围内。

探索 MCP 服务器→
mcp.json
{
"mcpServers": {
"ody": {
"url": "https://api.ody.co/v1/mcp",
"headers": {
"Authorization": "Bearer ody_live_…"
}
}
}
}

开始构建

从零到第一条 SMS 只需五分钟

获取密钥,进行一次 curl 调用,您就发送了一条短信。完整的 API 参考、webhook 指南和 SDK 快速入门可在 dev.ody.co 上找到。

API 密钥由工作区所有者和管理员在 设置 → 开发者 API 下创建。

常见问题

开发者问题解答

API 目前能做什么?
完整的联系人 CRUD;列出和阅读对话并设置其状态;发送 SMS 和 MMS;搜索您的消息历史记录;获取包含转录的通话和语音邮件历史记录;列出、购买和路由您的电话号码;配置和发布 AI 代理;以及读取、写入、搜索和导入 AI 回答所用的知识库。完整的参考资料位于 dev.ody.co 的开发者文档中。

与您的技术栈更好地协同

API 提供完整功能。集成是无代码路径。

范围密钥、Webhooks 和 SDK 涵盖了您想构建的一切。Slack、Make 和 CSV 涵盖了大多数团队无需编写代码即可完成的工作。

绝不错过任何一位客户。

携号转网,在几分钟内训练您的 AI 助理,让您的线路自动运行。或者完全关闭 AI 功能。您说了算。