開放 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 這類寫法會自動換成對應的代碼。
這頁對你有幫助嗎？
最後更新:
