Overzicht van de open API

Authenticatiemethoden, responsformaat, foutcodes en ondersteunde taalcodes.

In het volgende verwijst {API} naar het serviceadres; je vindt dit op de pagina 'Integratie' in de backend.

Alle verzoeken bevatten Authorization: Bearer sk_live_... (aangemaakt op de pagina 'Integratie' in de backend, slechts één keer zichtbaar; bewaar deze alleen op de server).

Reacties hebben altijd de volgende vorm: {"code": "SUCCESS", "message": "", "data": ...}. Bij een fout is code een stabiele foutcode; gebruik die om te bepalen wat er aan de hand is. message is alleen bedoeld voor mensen. Bedragen zijn altijd strings.

Foutcodes

codeSituatie
UNAUTHORIZEDAPI Key is ongeldig of ingetrokken
VALIDATION_ERRORParameters zijn onjuist; data bevat de specifieke velden
NOT_FOUNDResource bestaat niet (ook resources die niet van jou zijn)
PLAN_LIMIT_REACHEDJe hebt de limiet van je abonnement voor het aantal producten, de kennisbankcapaciteit of het aantal seats overschreden
CONVERSATION_CLOSEDGesprek is beëindigd; start een nieuw gesprek
CONVERSATION_OPENGesprek is nog niet beëindigd; je kunt nog geen beoordeling geven
RATE_LIMITEDTe veel verzoeken
USER_TOKEN_INVALIDde handtekening van user_token is onjuist of verlopen
CHECKOUT_FAILEDOrderbevestiging is niet meer geldig, of de order-API is tijdelijk niet bereikbaar (wanneer in de widget op 'Bestelling bevestigen' wordt geklikt)
ORIGIN_NOT_ALLOWEDDe huidige website staat niet in de lijst met websites waarvoor insluiten is toegestaan
LANGUAGE_NOT_SUPPORTEDDeze taal wordt niet ondersteund of is niet beschikbaar
CHANNEL_CHECK_FAILEDAppID / AppSecret van het kanaal kan niet worden geverifieerd; message bevat de reden die WeChat teruggeeft
CHANNEL_REMOVEDHet kanaal waar het gesprek vandaan komt, is verwijderd; er kunnen geen antwoorden worden verzonden

Ondersteunde taalcodes: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Notaties zoals zh-Hant, pt-BR en en_US worden automatisch omgezet naar de bijbehorende code.

Was deze pagina nuttig?

Laatst bijgewerkt: