Przegląd otwartego API
Metody uwierzytelniania, format odpowiedzi, kody błędów i obsługiwane kody języków.
Poniższy {API} oznacza adres usługi; można go zobaczyć na stronie „Integracja” w panelu administracyjnym.
Wszystkie żądania zawierają nagłówek Authorization: Bearer sk_live_... (utwórz go na stronie „Integracja” w panelu; jest wyświetlany tylko raz i należy przechowywać go wyłącznie na serwerze).
Odpowiedzi mają jednolity format: {"code": "SUCCESS", "message": "", "data": ...}. W przypadku błędu code jest stabilnym kodem błędu — na jego podstawie podejmuj decyzje; message służy tylko do wyświetlenia człowiekowi. Kwoty są zawsze ciągami znaków.
Kody błędów
| code | Scenariusz |
|---|---|
UNAUTHORIZED | API Key jest nieprawidłowy lub unieważniony |
VALIDATION_ERROR | Nieprawidłowe parametry; data zawiera konkretne pola |
NOT_FOUND | Zasób nie istnieje (dotyczy też zasobów, które nie należą do Ciebie) |
PLAN_LIMIT_REACHED | Przekroczono limit produktów, pojemności bazy wiedzy lub liczby miejsc w planie |
CONVERSATION_CLOSED | Rozmowa została zakończona, utwórz nową |
CONVERSATION_OPEN | Rozmowa jeszcze się nie zakończyła, nie można jej ocenić |
RATE_LIMITED | Zbyt wiele żądań |
USER_TOKEN_INVALID | Podpis user_token jest nieprawidłowy lub wygasł |
CHECKOUT_FAILED | Potwierdzenie zamówienia wygasło albo endpoint składania zamówienia jest chwilowo niedostępny (gdy w widgetcie kliknięto „Potwierdź zamówienie”) |
ORIGIN_NOT_ALLOWED | Obecna witryna nie znajduje się na liście witryn dozwolonych do osadzenia |
LANGUAGE_NOT_SUPPORTED | Język nie jest obsługiwany lub nie został włączony |
CHANNEL_CHECK_FAILED | Weryfikacja AppID / AppSecret kanału nie powiodła się; message zawiera powód zwrócony przez WeChat |
CHANNEL_REMOVED | Kanał, z którego pochodzi rozmowa, został usunięty — nie można wysłać odpowiedzi |
Obsługiwane kody języków: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Zapis taki jak zh-Hant, pt-BR, en_US jest automatycznie zamieniany na odpowiedni kod.
Czy ta strona była pomocna?
Ostatnia aktualizacja:
