オープンAPI概要

認証方式、レスポンス形式、エラーコード、対応言語コード。

以下の {API} はサービスアドレスを指し、管理画面の「接続」ページで確認できます。

すべてのリクエストに Authorization: Bearer sk_live_... を付けます(管理画面の「接続」ページで作成され、表示は一度だけです。サーバー上にのみ保管してください)。

レスポンスはすべて {"code": "SUCCESS", "message": "", "data": ...} の形式です。失敗時の code は固定のエラーコードなので、これを基準に判断してください。message は人向けの説明です。金額はすべて文字列です。

エラーコード

code状況
UNAUTHORIZEDAPI Key が無効、または失効しています
VALIDATION_ERRORパラメータが正しくありません。data に該当するフィールドがあります
NOT_FOUNDリソースが存在しません(あなたに属さないリソースも含みます)
PLAN_LIMIT_REACHEDプランの商品数、ナレッジベース容量、または座席数を超えています
CONVERSATION_CLOSED会話はすでに終了しています。新しく作成してください
CONVERSATION_OPEN会話がまだ終了していないため、評価できません
RATE_LIMITEDリクエストが多すぎます
USER_TOKEN_INVALIDuser_token の署名が正しくない、または有効期限が切れています
CHECKOUT_FAILED注文確認の有効期限が切れている、または注文 API に一時的に接続できない(widget で「注文を確定」をクリックしたとき)
ORIGIN_NOT_ALLOWED現在のサイトが埋め込み許可リストに含まれていません
LANGUAGE_NOT_SUPPORTEDこの言語はサポートされていない、または公開されていません
CHANNEL_CHECK_FAILEDチャネルの AppID / AppSecret の検証に失敗しました。message に WeChat から返された理由が入っています
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 のような表記は、自動的に対応するコードに置き換わります。

このページは役に立ちましたか?

最終更新: