Gambaran Keseluruhan API Terbuka

Kaedah pengesahan, format respons, kod ralat dan kod bahasa yang disokong.

Dalam dokumen ini, {API} merujuk kepada alamat perkhidmatan, yang boleh dilihat pada halaman "Integrasi" di backend.

Semua permintaan mesti membawa Authorization: Bearer sk_live_... (dicipta pada halaman "Integrasi" di backend, hanya dipaparkan sekali, dan hanya disimpan di pelayan).

Respons sentiasa dalam format {"code": "SUCCESS", "message": "", "data": ...}. Apabila gagal, code ialah kod ralat yang stabil — gunakannya untuk menentukan keputusan; message hanya untuk dibaca manusia. Semua jumlah wang adalah dalam bentuk string.

Kod ralat

codeSenario
UNAUTHORIZEDAPI Key tidak sah atau telah dibatalkan
VALIDATION_ERRORParameter tidak betul; data mengandungi medan yang berkenaan
NOT_FOUNDSumber tidak wujud (termasuk sumber yang bukan milik anda)
PLAN_LIMIT_REACHEDMelebihi had bilangan produk, kapasiti pangkalan pengetahuan atau bilangan tempat duduk dalam pelan
CONVERSATION_CLOSEDPerbualan telah tamat; sila buat perbualan baharu
CONVERSATION_OPENPerbualan belum tamat, jadi penilaian tidak boleh dibuat
RATE_LIMITEDTerlalu banyak permintaan
USER_TOKEN_INVALIDTandatangan user_token tidak betul atau telah tamat tempoh
CHECKOUT_FAILEDPengesahan pesanan telah tamat tempoh, atau API pesanan tidak dapat dihubungi buat sementara waktu (apabila widget menekan "Sahkan pesanan")
ORIGIN_NOT_ALLOWEDLaman web semasa tidak berada dalam senarai laman yang dibenarkan untuk pembenaman
LANGUAGE_NOT_SUPPORTEDBahasa ini tidak disokong atau belum diaktifkan
CHANNEL_CHECK_FAILEDAppID / AppSecret saluran gagal disahkan; message mengandungi sebab yang dikembalikan oleh WeChat
CHANNEL_REMOVEDSaluran asal perbualan telah dipadam, jadi balasan tidak dapat dihantar

Kod bahasa yang disokong: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Penulisan seperti zh-Hant, pt-BR, en_US akan ditukar secara automatik kepada kod yang sepadan.

Adakah halaman ini membantu?

Kemas kini terakhir: