共通仕様

リクエスト

ChatLuckの公開APIは、「POST」メソッドをご利用ください。

安全に通信を行うために、「HTTPS」でアクセスすることを推奨いたします。

リクエスト先のURLは以下の各APIのページに記載しています。
詳しくは以下をご確認ください。

• ログインAPI
• 一般ユーザーAPI
• システム管理者API
• チャットボットAPI

HTTPヘッダーについて

以下が必要です。

※ 大文字小文字を区別してください。

• 「Content-Type」
• 「Content-Length」

Content-Type

値には「application/x-www-form-urlencoded」または「multipart/form-data」を指定してください。

「application/x-www-form-urlencoded」を指定する場合は、送信内容(リクエストボディ)はURLエンコードしてください。

Content-Length

値には送信内容(リクエストボディ)のバイト数を指定してください。

レスポンス

ChatLuckサーバーとの通信に成功している場合はAPIの実行結果に関わらず、
HTTPステータスコードは「200」になります。

内容(レスポンスボディ)はJSON形式になります。
詳しくは各APIのページをご覧ください。

エラー時のレスポンスについて

エラーの場合もHTTPステータスコードは「200」になります。

レスポンス内容の例

actionパラメータに間違った値を設定した時のレスポンスの例です。

// Content-Type: application/json
{
  "result": "ng",
  "error_no": -10002,
  "error_message": "E:リクエストが不正です。内容を確認して再度送信してください。"
}