开放 API 概览
认证方式、响应格式、错误码和支持的语种代码。
下文的 {API} 指服务地址，在后台「接入」页可以看到。
所有请求带 Authorization: Bearer sk_live_...（后台「接入」页创建，只显示一次，只放在服务器上）。
响应统一为 {"code": "SUCCESS", "message": "", "data": ...}。失败时 code 是稳定的错误码，按它判断；message 只给人看。金额一律是字符串。
错误码
| code | 场景 |
|---|---|
UNAUTHORIZED | API Key 无效或已作废 |
VALIDATION_ERROR | 参数不正确，data 里有具体字段 |
NOT_FOUND | 资源不存在（也包括不属于你的资源） |
PLAN_LIMIT_REACHED | 超出套餐的商品数、知识库容量或座席数 |
CONVERSATION_CLOSED | 会话已结束，请新建 |
CONVERSATION_OPEN | 会话还没结束，不能评价 |
RATE_LIMITED | 请求太频繁 |
USER_TOKEN_INVALID | user_token 签名不对或已过期 |
CHECKOUT_FAILED | 订单确认已失效，或下单接口暂时不通（widget 点「确认下单」时） |
ORIGIN_NOT_ALLOWED | 当前网站不在允许嵌入的列表里 |
LANGUAGE_NOT_SUPPORTED | 不支持或没有开放这个语言 |
CHANNEL_CHECK_FAILED | 渠道的 AppID / AppSecret 验证不过，message 里有微信返回的原因 |
CHANNEL_REMOVED | 会话来自的渠道已删除，回复发不出去 |
支持的语种代码：zh-CN、zh-TW、en、ja、ko、de、fr、es、pt、it、ru、ar、th、vi、id、ms、tr、nl、pl。zh-Hant、pt-BR、en_US 这类写法会自动换成对应的代码。
这篇文档有帮助吗？
最后更新:
