メインコンテンツまでスキップ

エラー定義

Messaging API で何らかのエラーが発生した場合、HTTP ステータスコードで 2xx 以外の値を応答するとともに、以下のようなエラー情報を持った JSON を返します。

Global Errors​

何らかの理由によりリクエストが受け付けられなかった際に発生します。 エラー内容は code の値によって識別できます。

JSON 構造​

Global Error の場合、 path には常に __global__ が指定されます。

{
  "errors": [
    {
      "path": "__global__",
      "code": "{Error Code}"
    }
  ]
}

エラーコード一覧​

Client Side Errors​

HTTP StatusError CodeDescription
401unauthorizedAuthorization Header が不正
400invalid_parameter必須パラメータが存在しない, パラメータが不正
404resource_not_foundリクエストされたリソースが見つからない
403access_denied接続元 IP アドレスが制限されている
400line_messaging_api_channel_not_setLINE Messaging API チャネルが設定されていない
404end_user_not_found指定したエンドユーザーが見つからない
404recipient_user_not_found送信先ユーザが特定できない。ソーシャル PLUS ID やユーザID が正しくない
400recipient_id_length_is_over_255配信者リストに 255 文字を超える文字列が含まれている
406recipient_registration_is_running送信対象の登録処理が実行中である
409message_was_deliveredメッセージが配信中または配信完了であるため更新できない
409step_delivery_not_draftステップ配信定義が「下書き」でない
422step_delivery_not_runningステップ配信が稼働していない
409richmenu_has_already_linked_usersリッチメニューが既にユーザーとリンクしている
409default_richmenu_is_already_existsリッチメニューが既にデフォルトに設定されている
409richmenu_has_already_been_a_defaultリッチメニューが既にデフォルトに設定されている
400adding_recipients_via_api_is_not_allowedリッチメニューが「API で配信」以外の設定である

Server Side Errors​

HTTP StatusError CodeDescription
503provider_server_errorプロバイダが提供する API でエラーが発生した
503under_maintenanceメンテナンス中

Validation Errors​

リクエスト内容のデータベースへの保存が失敗した際に発生します。
主に操作者がフォームに入力した内容に不備がある場合に使用され、内容の修正を促すレスポンスが返されます。

応答される HTTP Status Code は 422 Unprocessable Entity です。

JSON 構造​

path にはエラーのある form field を示すパスが含まれます。

option は後述のエラーコードの Description に含まれる %{count} などの変数値を表します。Description に変数が含まれない場合は省略されます。

{
  "errors": [
    {
      "path": "{Path}",
      "code": "{Error Code}",
      "option": {
        "{variable_name}": "{variable_value}"
      }
    },
    {
      "path": "{Path}",
      "code": "{Error Code}"
    }
  ]
}

エラーコード一覧​

path に * が指定されているものは path の値に関係なく発生する可能性があります。

path に固有の値が指定されているものは、その path 固有のエラーです。

PathError CodeDescription
*acceptedを受諾してください
*blankを入力してください
*presentは入力しないでください
*confirmationと%{attribute}の入力が一致しません
*emptyを入力してください
*equal_toは%{count}にしてください
*evenは偶数にしてください
*exclusionは予約されています
*greater_thanは%{count}より大きい値にしてください
*greater_than_or_equal_toは%{count}以上の値にしてください
*inclusionは一覧にありません
*invalidは不正な値です
*invalid_url_formatは無効な URL 形式です
*less_thanは%{count}より小さい値にしてください
*less_than_or_equal_toは%{count}以下の値にしてください
*not_a_numberは数値で入力してください
*not_an_integerは整数で入力してください
*oddは奇数にしてください
*requiredを入力してください
*takenはすでに存在します
*too_longは%{count}文字以内で入力してください
*too_shortは%{count}文字以上で入力してください
*wrong_lengthは%{count}文字で入力してください
*other_thanは%{count}以外の値にしてください
actionsexceeded_size_limitの数が制限値を超えています
basecell_pattern_size_and_action_size_are_not_equal指定されたセルパターンとアクションの数が一致しません
deliver_days_latergreater_than_or_equal_to0 未満の整数は入力できません
deliver_days_laterless_than_or_equal_to366 を超える整数は入力できません
deliver_days_laternot_a_number文字列は入力できません
deliver_days_laternot_an_integer小数値は入力できません
delivery_time_in_localinvalid不正なフォーマットです
delivery_time_in_localout_of_range00:00 ~ 23:59 の間の時刻を指定してください
delivery_time_in_localtaken他のステップで同じ配信日時が設定されています
recipient_identifier_typenot_editable%{attribute}は後から変更する事はできません
recipient_registeringregistration_processing送信対象の登録処理中のため、予約状態での保存はできません
recipientsunassociatedは LINE ログイン連携されていないユーザーです
recipientsunregisteredは存在しないユーザーです
reservation_timetime_past現在時刻より前の時刻は入力できません
statusalready_delivered配信中または配信完了しているため編集できません
statusnot_editableステップ配信の%{attribute}が draft でないため変更できません
step_definitionsblankステップが登録されていません
textemojis_size_must_be_between_1_and_20メッセージに含められる絵文字は 20 個までです
に最終更新