使用 Ody API 和 SDK
所有 Ody 套餐都包含公共 REST API。在应用中创建密钥，然后直接调用 API 或安装官方 SDK。完整的参考资料、指南和示例都在开发者网站 — dev.ody.co — 而非本帮助中心。
创建 API 密钥
您必须是工作区管理员或所有者。
- 打开设置 → 开发者 API（在手机上：更多 → 设置 → 开发者 API）。
- 输入密钥名称（例如“Zapier”或“生产服务器”）。
- 保持所有范围选中以获得完全访问权限，或取消选择某些范围以限制密钥权限（例如，为 AI 助手创建只读密钥）。
- 在密钥类型下，选择生产或测试。
- 点击创建密钥。
- 从横幅**“立即复制您的新密钥 — 您将无法再次看到它。”**中复制密钥。Ody 只存储哈希值 — 如果您丢失了密钥，请撤销该密钥并创建一个新的。
密钥列表显示一个掩码提示（ody_live_…WXYZ 或 ody_test_…WXYZ），测试密钥的测试徽章，范围，以及密钥上次使用的时间。点击撤销可立即禁用密钥。
安装 SDK
官方零依赖客户端封装了相同的 REST API，具有自动分页、类型化错误、幂等发送和标准 Webhook 验证功能：
| 语言 | 安装 | 文档 |
|---|---|---|
| TypeScript / JavaScript | npm install @ody-co/sdk |
dev.ody.co/sdks/typescript |
| Python | pip install ody-sdk (import as ody) |
dev.ody.co/sdks/python |
从 SDK 概述 或 5 分钟快速入门 开始。喜欢纯 HTTP？开发者网站上的每个示例都有一个 cURL 选项卡，机器可读的 OpenAPI 规范位于 api.ody.co/v1/api/openapi.json。
开发者网站上还有什么
| 主题 | 链接 |
|---|---|
| 身份验证、范围、生产与测试 | Authentication |
| REST API 参考 | API overview |
| 出站 webhook（验证签名、事件目录） | Webhooks |
| 通过 MCP 连接 ChatGPT 或 Claude | MCP |
| Switchboard（使用 AI 规划和构建呼叫路由） | Switchboard |
同一个 API 密钥支持 REST、SDK 和 MCP 服务器。将密钥粘贴到 MCP 客户端中，并使用开发者 API 屏幕上连接到 ChatGPT 和 Claude 下显示的端点。
故障排除
- “无法创建 API 密钥” — 您需要是工作区的管理员或所有者。请所有者提升您的权限，或让他们创建密钥。
- 密钥丢失 — 您无法找回它。请在设置 → 开发者 API 中撤销该密钥并创建一个新的。
- 代码返回 401 / 未授权 — 检查密钥是否是您预期的生产或测试密钥，是否未被撤销，以及
Authorization: Bearer …头部是否使用了完整的密钥（包括ody_live_或ody_test_前缀）。 - 403 缺少范围 — 密钥是使用一组受限的范围创建的。请创建一个具有您的端点所需范围的新密钥，或参阅范围。
- 想使用 Zapier / Make 而不是代码 — 许多无代码工具使用相同的密钥调用 REST API；请参阅 API 概述。内置的 CRM 和帮助台连接在Ody 支持哪些集成？下。
相关文章
常见问题
开发者文档在哪里？
所有开发者资源都在 https://dev.ody.co — 包括 REST API、webhook、MCP、Switchboard 以及 TypeScript 和 Python SDK。帮助中心仅涵盖如何在应用中创建 API 密钥。
如何安装 Ody SDK？
TypeScript/JavaScript: npm install @ody-co/sdk。Python: pip install ody-sdk (导入为 ody)。两者均为 v0.6.0 版本，零依赖，并包含 webhook 验证功能。
谁可以创建 API 密钥？
工作区管理员或所有者。打开**设置** → **开发者 API**（在手机上：**更多** → **设置** → **开发者 API**）。
生产密钥和测试密钥有什么区别？
生产密钥 (ody_live_…) 会发送真实的短信并拨打真实的电话。测试密钥 (ody_test_…) 可以读写真实的工作区数据，但绝不会发送真实的短信 — 发送操作会被记录为模拟发送。在开发时请使用测试密钥。