开放 API
通过 REST API 与 TWT Chat 平台进行深度集成,管理聊天、发送消息、同步客户数据。
能做什么
- 服务端创建单聊或群聊,支持批量操作
- 删除/解散聊天,清理历史数据
- 管理知识库中的常见问题、网页和文章知识
- 通过 HMAC-SHA256 签名鉴权,保障接口安全
怎么做
- 鉴权与签名 — 生成请求签名,所有接口必读
- 在线聊天接口 — 创建单聊、批量创建、创建群聊、删除/解散
- 在线会话接口 — 创建客服会话、创建机器人会话 和 添加客服
- 知识库接口 — 新增、编辑和删除常见问题;新增和删除网页知识;新增、编辑和删除文章知识
- 错误码参考 — 统一错误响应格式
Base URL: https://apichat.twt.com,HTTPS,JSON 格式。
API 一览
| 接口 | 方法 | 模块 | 说明 |
|---|---|---|---|
| 鉴权与签名 | — | 鉴权 | HMAC-SHA256 签名,所有接口必读 |
| 创建单聊 | POST | 在线聊天 | 创建单个聊天会话 |
| 批量创建单聊 | POST | 在线聊天 | 批量创建单聊会话 |
| 创建群聊 | POST | 在线聊天 | 批量创建群聊会话 |
| 删除单聊 | POST | 在线聊天 | 删除单个聊天会话 |
| 解散群聊 | POST | 在线聊天 | 解散单个群聊 |
| 批量解散群聊 | POST | 在线聊天 | 批量解散群聊 |
| 创建客服会话 | POST | 在线会话 | 创建会话并分配负责人和参与客服 |
| 创建机器人会话 | POST | 在线会话 | 创建由机器人接待的会话 |
| 添加客服 | POST | 在线会话 | 向已有工单会话添加客服参与人 |
| 知识库接口 | POST | 知识库 | 管理常见问题及网页/文章知识(仅文章支持编辑) |
| 错误码参考 | — | 通用 | 统一错误响应格式 |
能获得什么
- 将 TWT Chat 嵌入业务系统工作流,自动化聊天管理
- 服务端主动发起聊天,无需客服手动触发
- 与 CRM、工单系统深度集成
还没有账号?
免费注册 TWT Chat 获取 API Key。