API 参考
将 Hanc.AI 集成到您的应用程序的完整 API 文档。以编程方式管理代理、获取通话数据、发起通话以及操作平台的每个部分。
快速概览
| Base URL | https://api.hanc.ai |
| Authentication | API Key via x-api-key header |
| Format | JSON |
从控制台的 Integration → API Keys 生成 API 密钥。每个用户最多可拥有 3 个密钥 —— 设置、权限和安全指南请参阅 集成中的 API 密钥章节。
curl -X GET "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"
可用端点
通话
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出通话 | GET | /v1/call/list |
| 通话详情(记录、情感、摘要) | GET | /v1/call/:id |
| 一般分析(按日期/代理的指标) | GET | /v1/call/general-metrics |
| 每日分析 | GET | /v1/call/daily-metrics |
| 情感统计 | GET | /v1/call/sentiment-stats |
| 成本分解 | GET | /v1/call/costs-breakdown |
| 导出通话(CSV) | GET | /v1/call/list/export |
| 导出成本(CSV) | GET | /v1/call/costs-breakdown/export |
| 发起电话通话 | POST | /v1/call/make-phone-call |
| 发起网页通话 | POST | /v1/call/make-web-call |
代理
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出代理 | GET | /v1/agent/list |
| 代理详情 | GET | /v1/agent/:id |
| 创建代理 | POST | /v1/agent |
| 更新代理 | PATCH | /v1/agent/:id |
| 删除代理 | DELETE | /v1/agent/:id |
| 代理通话统计 | GET | /v1/agent/:id/call-stats |
| 列出代理模板 | GET | /v1/agent/agent_template/list |
代理操作:
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出操作 | GET | /v1/agent/:id/actions |
| 添加操作 | POST | /v1/agent/:id/actions |
| 更新操作 | PATCH | /v1/agent/:id/actions/:actionId |
| 删除操作 | DELETE | /v1/agent/:id/actions/:actionId |
代理工具:
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出工具 | GET | /v1/agent/:id/tools |
| 添加工具 | POST | /v1/agent/:id/tools |
| 更新工具 | PATCH | /v1/agent/:id/tools/:toolId |
| 删除工具 | DELETE | /v1/agent/:id/tools/:toolId |
知识库
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出知识库 | GET | /v1/knowledge-base/list |
| 创建知识库 | POST | /v1/knowledge-base |
| 上传文件 | POST | /v1/knowledge-base/:id/file(s) |
| 删除文件 | DELETE | /v1/knowledge-base/:id/file |
| 分配代理 | PUT | /v1/knowledge-base/:id/agents |
电话号码
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出号码 | GET | /v1/phone-number/list |
| 可用号码(按国家) | GET | /v1/phone-number/available |
| 购买号码 | POST | /v1/phone-number/buy |
| 导入号码 | POST | /v1/phone-number/import |
| 连接到 SIP | PATCH | /v1/phone-number/connect-to-sip |
语音
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出语音 | GET | /v1/voice/list |
按语言筛选:GET /v1/voice/list?language=de
订阅
| 操作 | 方法 | 端点 |
|---|---|---|
| 订阅详情 | GET | /v1/subscription |
| 配置自动充值 | PATCH | /v1/subscription/auto-top-up |
| 设置充值金额 | PATCH | /v1/subscription/top-up-amount |
客户
| 操作 | 方法 | 端点 |
|---|---|---|
| 列出客户 | GET | /v1/customer/list |
| 客户详情 | GET | /v1/customer/:id |
| 创建客户 | POST | /v1/customer |
| 更新客户 | PATCH | /v1/customer/:id |
| 删除客户 | DELETE | /v1/customer/:id |
工作区
| 操作 | 方法 | 端点 |
|---|---|---|
| 工作区操作 | GET/POST/PATCH/DELETE | /v1/workspaces/* |
| 邀请成员 | POST | /v1/workspaces/:id/invite-member |
| 移除成员 | DELETE | /v1/workspaces/:id/invite-member |
API 中不可用的功能
某些操作仅通过控制台可用:
| 功能 | 原因 |
|---|---|
| API 密钥管理 | 安全 —— 密钥不能创建其他密钥 |
| 电话号码设置 | 需要交互式设置 |
| Google 日历集成 | 需要交互式授权 |
| 计费和付款 | 通过控制台管理 |
需要帮助?
如有 API 相关问题,请联系我们的支持团队:support@hanc.ai。