开放 API 与 Webhook,让客服能力融入你的业务系统
X-API-Key)。
所有 API 请求需携带 API Key 与租户 ID 请求头:
X-API-Key: <你的API Key>
X-Company-Id: <租户ID>
Content-Type: application/json
API Key 在后台「系统设置 → 开放平台」申请,支持创建多个 Key、随时吊销。接口均使用 HTTPS 传输,响应格式统一为 JSON。
发送一条客户消息并获取 AI 回复(同步)。用于自定义客服入口、APP 内嵌等场景。
{
"session_id": "sess_xxxx", // 可选,不传则自动创建
"content": "你们有支持微信支付的套餐吗?",
"source": "app", // 渠道标识:web/wechat/wecom/douyin/app...
"user_id": "u_10001" // 可选,业务侧用户ID
}
分页拉取某会话的消息记录(含 AI 意图、转人工状态等元数据)。
创建会话,可指定机器人(bot_id)、渠道与用户标签。
分页查询知识库问答列表,支持按关键词、状态过滤。
批量新增问答(支持相似问法),用于业务系统自动同步 FAQ 与商品资料。
{
"questions": [
{
"question": "怎么退款?",
"answer": "在订单页点击申请退款即可…",
"category": "售后",
"similar": ["如何申请退款", "退款流程是什么"]
}
]
}
删除指定问答(逻辑删除,可在后台恢复)。
查询用户画像与历史会话摘要。
分页查询会话列表(支持状态、时间、渠道、机器人维度过滤)。
创建工单(自动分派、SLA 计时)。
更新工单状态与处理结果,支持流转历史。
获取运营概览(会话量、AI 解决率、满意度等 KPI)。
BI 多维聚合:趋势、渠道、机器人维度、转人工原因、高频问题、坐席绩效等。
在后台配置回调 URL 并订阅事件,系统实时推送(带签名验证):
| 事件类型 | 说明 |
|---|---|
session.created | 新会话创建 |
message.received | 收到客户消息 |
message.ai_replied | AI 完成回复 |
transfer.created | 触发转人工(含原因) |
ticket.created / updated | 工单创建 / 更新 |
rating.submitted | 客户提交满意度评价 |
knowledge.miss | 产生未解决问题(可驱动知识库优化) |
回调签名验证:请求头 X-TianKey-Signature = HMAC-SHA256(Webhook Secret, 原始 Body),请验签后处理,防止伪造。
内置电商订单查询场景,支持对接淘宝、京东、拼多多、抖音等平台订单数据:
根据订单号/手机号查询订单状态,AI 直接回答物流与售后问题。
{
"platform": "douyin",
"order_no": "DY202608270001",
"query": "我的订单发货了吗"
}
Python 示例:调用对话接口
import requests
API = "https://api.tiankeyun.com"
resp = requests.post(f"{API}/api/v1/chat/message",
headers={"X-API-Key": "你的APIKey", "X-Company-Id": "1001"},
json={"session_id": "sess_1001", "content": "你们支持微信支付吗?", "source": "app"})
print(resp.json()["reply"]) # AI 回复内容
print(resp.json()["intent"]) # 识别到的意图
JavaScript 示例:Webhook 验签
const crypto = require("crypto");
// 收到回调后验签
const sig = crypto
.createHmac("sha256", process.env.WEBHOOK_SECRET)
.update(rawBody)
.digest("hex");
if (req.headers["x-tiankey-signature"] !== sig) return res.status(401).end();
// 处理事件…