Error Code

    APIの呼び出し結果は、ResponseのHTTP Status Codeをもとに成功または失敗を判断することが可能です。

    HTTP Status Code 結果 説明
    200 番台 成功 正常
    300 番台 成功 追加処理が必要
    400 番台 失敗 クライアントエラー
    500 番台 失敗 サーバーエラー

    LINE WORKS API 2.0 (Beta)では、以下の2種類のエラーを返します。

    • 認証APIエラー
    • リソースAPIエラー

    呼び出しに失敗すると、Response BodyにError CodeとError Messageを返します。

    認証APIエラー

    User Account認証 (OAuth) または Service Account認証 (JWT)のAPI実行に失敗した場合、以下のエラーを返します。

    Error Response

    プロパティ タイプ 必須 説明
    error String Y エラーコード
    error_description String N エラーの説明
    error_uri String N エラーに関するガイドのURI

    Error Response Example

    {
      "error": "invalid_request",
      "error_description": "Failed to get access token",
      "error_uri": "See document on https://developers.worksmobile.com/reference/authorization-auth"
    }
    

    Error Code

    HTTP
    Status Code
    error error_description 説明
    400 invalid_scope Request scope is not valid. 無効な OAuth API Scope
    400 invalid_request Client-id is not valid. 無効な Client ID
    400 invalid_request Client secret is not valid. 無効な Client secret
    400 invalid_request Client-id or secret is not valid. 無効な Client ID または Client secret
    400 invalid_request Client-id, secret or authorization code is not valid. 無効な Client ID, Client secret または Authorization code
    400 invalid_request Client-id, secret or refresh token is not valid. 無効な Client ID, Client secret または refresh token
    400 invalid_request Userid is not valid. 存在しない User ID
    400 invalid_request Client app is not found. 存在しないアプリ
    400 invalid_request JWT token is not valid. 無効な JWT token
    400 invalid_request JWT claims is not json type. JWT が json 形式ではない
    400 invalid_request JWT part is missing. Please check jwt token. JWT Header, Payload, Signature が存在しない
    400 invalid_request JWT is already expired. JWT 期限切れ
    400 invalid_request JWT header is not valid. 無効な JWT Header
    400 invalid_request JWT is not activated yet. JWT が有効ではない
    400 invalid_request JWT iat term is wrong. 無効な JWT.iat
    400 invalid_request JWT iat term should be 3600 seconds maximum. JWT.iat が 3600 sec を超過
    400 invalid_request JWT iss is missing. JWT.iss が存在しない
    400 invalid_request JWT sub is missing. JWT.sub が存在しない
    400 invalid_request JWT iat is missing. JWT.iat が存在しない
    400 invalid_request JWT exp is missing. JWT.exp が存在しない
    400 unsupported_grant_type Grant type is not supported. 使用できない grant_type
    401 unauthorized_client Failed to get access token from request. Access Token の発行失敗
    401 unauthorized_client Failed to refresh token with request. Refresh Token を利用した再発行に失敗
    401 unauthorized_client Failed to get jwt token with request. Please check client authentication JWT Token の発行失敗
    500 server_error Internal Server Error 内部サーバーエラー
    500 server_error Unexpected error occurred while parsing jwt. JWT 解析中の不明なエラー

    リソースAPIエラー

    Error Response

    プロパティ タイプ 説明
    code String エラーコード
    description String エラーメッセージ

    Error Response Example

    {
        "code": "NOT_FOUND",
        "description": "Api not exists"
    }
    

    共通エラー

    リソースAPIの共通エラーは、以下の通りです。

    Error Code

    HTTP
    Status Code
    description 説明
    400 invalid client id 無効な Client ID
    400 invalid client app 無効なアプリ
    400 Malformed json parameter 不正な JSON パラメータ
    401 Authorization header not exists Authorization ヘッダーが存在しない
    401 Malformed Authorization header Authorization ヘッダーの形式が異なる
    401 Malformed authentication token トークン形式が異なる
    401 Authentication failed 認証失敗
    403 Api temporarily interrupted API サービスの一時停止
    403 Not allowed api 許可されていない API
    403 Blacklist ブラックリストに含まれている
    403 Domain stop ドメインが一時停止されている
    403 invalid api scope 無効な OAuth API Scope
    403 has not permission api scope 許可されていない OAuth API Scope
    404 Not support port 対応してない Port
    404 Api not exists 存在しない API
    405 Malformed http method 対応してない HTTP Method
    406 Not acceptable 対応してない Response Entity (application/json以外)
    429 API rate limit exceeded Rate Limit 超過
    429 Concurrent access fail 同時接続数の超過
    500 Additional information fail 追加情報の獲得に失敗
    500 Unknown error 不明なエラー
    503 Service fail サービス(メール、Botなど)内部エラー
    例) {errorMessage=Service fail,HTTP/1.1 400 bad_path(name), errorCode=090}

    個別エラー

    リソースAPIの個別エラーは、Response Bodyの「code」が上記以外の値になります。
    詳細は該当するAPIガイドを参照してください。