目录
接入流程 平台授权 Webhook 回调 API 接口 代码示例 SDK 下载

API 集成文档

快速将 chinaqbq AI 客服能力接入你的电商运营系统,支持 REST API、Webhook 回调和多语言 SDK

接入流程

四步完成接入,当天即可上线

1

注册账号

访问 chinaqbq.com 注册,获取 API Key 和 Secret

2

平台授权

在后台完成电商平台 OAuth 授权,或通过 API 传授权 Token

3

配置规则

上传商品信息、设置自动回复规则、配置转人工策略

4

上线运行

AI 客服即刻开始工作,通过 Webhook 实时接收事件推送

平台授权

支持五大电商平台官方 API 授权

平台开放平台授权方式所需权限接入状态
淘宝 / 天猫淘宝开放平台 (TOP)OAuth 2.0 授权码模式消息服务、交易查询、商品读取已支持
京东京东宙斯 (JOS)OAuth 2.0 授权码模式客服消息、订单查询、商品接口已支持
抖音电商抖音开放平台OAuth 2.0 + 应用授权客服消息、订单管理、商品管理已支持
拼多多拼多多开放平台OAuth 2.0 授权码模式客服消息、订单查询、退款查询已支持
微信小店微信小店 APIAPI Key + Secret 签名客服消息、订单管理、售后管理已支持

所有授权均通过平台官方 API,不接触店铺密码,数据加密传输。 立即注册获取 API Key

Webhook 回调

实时事件推送,第一时间响应

在后台配置你的 Webhook URL,系统会将以下事件实时推送到你的服务器。 建议使用 HTTPS,支持签名验证防止伪造请求。

message.new
买家发送新消息时触发。包含消息内容、买家信息、会话 ID。
{ "event": "message.new", "session_id": "...", "buyer_nick": "...", "content": "...", "platform": "taobao", "timestamp": 1716600000 }
session.closed
会话结束时触发。包含会话摘要、满意度评价、消息总数。
{ "event": "session.closed", "session_id": "...", "msg_count": 24, "satisfaction": 5, "summary": "..." }
order.created
买家下单时触发。包含订单号、商品信息、金额。
{ "event": "order.created", "order_id": "...", "buyer_nick": "...", "amount": 29900, "items": [...] }
complaint.escalated
投诉升级/差评风险时触发。AI 判断需要人工介入的关键事件。
{ "event": "complaint.escalated", "session_id": "...", "reason": "negative_sentiment", "risk_level": "high" }
签名验证 (Python)
import hmac, hashlib, json

def verify_signature(payload: bytes, signature: str, secret: str) -> bool:
    """验证 Webhook 签名"""
    expected = hmac.new(
        secret.encode(), payload, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(expected, signature)

# 使用示例(Flask)
@app.route('/webhook', methods=['POST'])
def webhook():
    sig = request.headers.get('X-Chinaqbq-Signature')
    body = request.get_data()
    if not verify_signature(body, sig, WEBHOOK_SECRET):
        return 'Invalid signature', 403
    event = json.loads(body)
    handle_event(event)  # 你的业务逻辑
    return 'ok'
API 接口

RESTful API,标准 JSON 响应

Base URL: https://api.chinaqbq.com/v1    认证方式: Bearer Token
接口方法路径说明
获取 Access TokenPOST/auth/token用 API Key + Secret 换取 Bearer Token,有效期 2 小时
刷新 TokenPOST/auth/refresh用 refresh_token 换取新的 Access Token
发送消息POST/messages/send通过 API 向指定会话发送消息
查询会话列表GET/sessions分页查询店铺的会话列表,支持按状态/时间筛选
查询会话详情GET/sessions/{id}获取指定会话的完整消息记录
数据报表-概览GET/reports/summary获取咨询量、转化率、满意度等核心指标
数据报表-明细GET/reports/detail按日期/渠道/客服维度导出的详细数据
知识库管理POST/knowledge/upsert新增或更新自定义问答对
商品同步POST/products/sync同步商品信息到 AI 知识库
代码示例

快速开始,复制即用

Python
import requests

API_BASE = "https://api.chinaqbq.com/v1"
API_KEY = "your_api_key"
API_SECRET = "your_api_secret"

# 1. 获取 Token
resp = requests.post(f"{API_BASE}/auth/token", json={
    "api_key": API_KEY,
    "api_secret": API_SECRET
})
token = resp.json()["access_token"]
headers = {"Authorization": f"Bearer {token}"}

# 2. 查询今日会话
resp = requests.get(f"{API_BASE}/sessions", headers=headers, params={
    "date": "2025-05-25",
    "status": "active",
    "limit": 50
})
sessions = resp.json()["data"]
print(f"今日活跃会话: {len(sessions)} 个")

# 3. 发送消息到指定会话
resp = requests.post(f"{API_BASE}/messages/send", headers=headers, json={
    "session_id": "sess_abc123",
    "content": "亲,您咨询的这款商品今天有活动哦~",
    "msg_type": "text"
})
print(resp.json())
JavaScript (Node.js)
const API_BASE = 'https://api.chinaqbq.com/v1';
const API_KEY = 'your_api_key';
const API_SECRET = 'your_api_secret';

async function main() {
  // 1. 获取 Token
  const authResp = await fetch(`${API_BASE}/auth/token`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ api_key: API_KEY, api_secret: API_SECRET })
  });
  const { access_token: token } = await authResp.json();

  const headers = {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  };

  // 2. 查询今日会话
  const sessionsResp = await fetch(
    `${API_BASE}/sessions?date=2025-05-25&status=active&limit=50`,
    { headers }
  );
  const { data: sessions } = await sessionsResp.json();
  console.log(`今日活跃会话: ${sessions.length} 个`);

  // 3. 获取数据报表
  const reportResp = await fetch(`${API_BASE}/reports/summary`, { headers });
  const summary = await reportResp.json();
  console.log('今日数据:', summary);
}

main().catch(console.error);
SDK 下载

多语言 SDK,开箱即用

Python SDK

pip install chinaqbq-sdk

下载 (即将上线)

Node.js SDK

npm install chinaqbq-sdk

下载 (即将上线)

PHP SDK

composer require chinaqbq/sdk

下载 (即将上线)

Java SDK

Maven / Gradle 依赖引入

下载 (即将上线)