Tổng quan API mở
Phương thức xác thực, định dạng phản hồi, mã lỗi và mã ngôn ngữ được hỗ trợ.
{API} trong tài liệu dưới đây là địa chỉ dịch vụ, bạn có thể xem ở trang 「Kết nối」 trong bảng điều khiển.
Mọi request đều phải kèm Authorization: Bearer sk_live_... (tạo ở trang 「Kết nối」 trong bảng điều khiển, chỉ hiển thị một lần, chỉ đặt trên server).
Response luôn có dạng {"code": "SUCCESS", "message": "", "data": ...}. Khi thất bại, code là mã lỗi cố định, hãy dựa vào đó để xử lý; message chỉ dành cho con người đọc. Số tiền luôn là chuỗi.
Mã lỗi
| code | Trường hợp |
|---|---|
UNAUTHORIZED | API Key không hợp lệ hoặc đã bị vô hiệu hóa |
VALIDATION_ERROR | Tham số không đúng, trong data có thông tin field cụ thể |
NOT_FOUND | Tài nguyên không tồn tại (bao gồm cả tài nguyên không thuộc về bạn) |
PLAN_LIMIT_REACHED | Vượt quá số lượng sản phẩm, dung lượng knowledge base hoặc số lượng nhân viên (seat) của gói dịch vụ |
CONVERSATION_CLOSED | Cuộc trò chuyện đã kết thúc, vui lòng tạo mới |
CONVERSATION_OPEN | Cuộc trò chuyện chưa kết thúc, không thể đánh giá |
RATE_LIMITED | Gửi request quá nhiều |
USER_TOKEN_INVALID | Chữ ký user_token không đúng hoặc đã hết hạn |
CHECKOUT_FAILED | Xác nhận đơn hàng đã hết hiệu lực, hoặc API đặt hàng tạm thời không khả dụng (khi nhấn 「Xác nhận đặt hàng」 trên widget) |
ORIGIN_NOT_ALLOWED | Website hiện tại không nằm trong danh sách được phép nhúng |
LANGUAGE_NOT_SUPPORTED | Không hỗ trợ hoặc chưa mở ngôn ngữ này |
CHANNEL_CHECK_FAILED | AppID / AppSecret của kênh không xác thực được, trong message có lý do do WeChat trả về |
CHANNEL_REMOVED | Kênh mà cuộc trò chuyện đến từ đó đã bị xóa, không thể gửi phản hồi |
Các mã ngôn ngữ được hỗ trợ: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Những cách viết như zh-Hant, pt-BR, en_US sẽ tự động được chuyển sang mã tương ứng.
Trang này có hữu ích không?
Cập nhật lần cuối:
