開発者ドキュメント

PUSH API · v1a

エラーコード

公開APIとダッシュボードのエラーを分けて確認できます。再試行できるかどうかは、実際に受け取ったレスポンスを基準に判断してください。

API

コードHTTP意味
UNAUTHENTICATED401認証情報がないか、認証できませんでした。
PERMISSION_DENIED403この認証情報またはログイン中のアカウントには、操作に必要な権限がありません。
RESOURCE_NOT_FOUND404現在アクセスできる範囲に、指定されたリソースが見つかりません。
IDEMPOTENCY_KEY_REUSED409同じ冪等性キーが異なる入力で使われました。先に以前のリクエストと結果を確認してください。
IDEMPOTENCY_IN_PROGRESS409同じ冪等性キーのリクエストを処理中です。Retry-Afterで指定された時間を待ち、同じリクエストを再試行してください。
IDENTITY_REBIND_CONFLICT409同時更新により、想定していたユーザーとの紐付けが変わりました。現在の状態を読み取ってから、次の操作を判断してください。
IDENTITY_REBIND_IN_PROGRESS409インストールの紐付けを更新中です。Retry-Afterで指定された時間のあとに、同じリクエストとキーで再試行してください。
DELIVERY_NOT_RESOLVABLE409この配信は、手動で確定できる未解決の不明な結果ではありません。
DISPATCH_CONTROL_STALE409読み取り後に配信制御の状態が変わりました。最新の状態を取得し、意図した操作かどうかを確認してください。
PROVIDER_CONNECTION_EXISTS409このプロバイダーと環境の接続はすでに存在します。認証情報の更新は別の操作で行います。
PROVIDER_CREDENTIAL_IDENTITY_PENDING503認証情報の識別情報をまだ検証中です。完了を待ってから再確認してください。
PROVIDER_CREDENTIAL_RECOVERY_REQUIRED409この認証情報には、通常の更新ではなく明示的な復旧フローが必要です。
PROVIDER_CREDENTIAL_RECOVERY_NOT_REQUIRED409現在の認証情報は明示的な復旧が必要な状態ではありません。最新の接続状態を確認してください。
PROVIDER_CREDENTIAL_RECOVERY_IN_PROGRESS409認証情報の復旧を検証中です。Retry-Afterで指定された時間を待ってから、同じ操作の状態を確認してください。
MALFORMED_REQUEST400リクエストを解析できません。本文がJSONオブジェクトでない場合や、パスのエスケープが不正な場合などに発生します。
FIELD_REQUIRED422必須のフィールドまたはヘッダーがありません。field_errorsを確認してください。
METHOD_NOT_ALLOWED405このパスでは、指定されたHTTPメソッドを使えません。
REQUEST_TOO_LARGE413HTTPリクエスト本文が、サーバーのサイズ上限を超えています。
PAYLOAD_TOO_LARGE422シリアライズされた通知が、プロバイダーのペイロード上限を超えています。メッセージの内容を減らしてください。
RESERVED_DATA_KEY422データのキーに、プロバイダーの予約済みプレフィックスまたはKitsの名前空間が使われています。
UNKNOWN_FIELD422対応するレジストリにないリクエストフィールドです。
FIELD_TYPE_MISMATCH422入力値の型が違います。field_errorsを確認してください。
ATTRIBUTE_KEY_NOT_REGISTERED422属性キーが登録されていません。
EVENT_NAME_NOT_REGISTERED422イベント名が未登録、または廃止済みです。
DEFINITION_LIMIT_EXCEEDED422プロジェクト環境が、属性またはイベント定義の上限に達しています。
INSTALLATION_LIMIT_EXCEEDED422アプリ環境の累計インストール数が上限に達しています。容量と保持方針を運営者に確認してください。
RESERVED_NAMESPACE422入力に予約済みの名前空間が使われています。
PROVIDER_CREDENTIAL_INVALID422プロバイダーの認証情報を検証できませんでした。
PROVIDER_ENVIRONMENT_MISMATCH422APNsのsandbox/production環境が一致していません。
RATE_LIMITED429リクエスト頻度または同時処理の上限に達しました。Retry-Afterで指定された時間を待ってください。
INTERNAL_ERROR500サーバー内部でエラーが発生しました。実際の再試行情報に従い、リクエストIDを保存してください。
DISPATCH_PAUSED503このアプリ環境では配信が一時停止されており、リクエストは受け付けられませんでした。再開の判断は運営者が行います。
RESOURCE_ARCHIVED409対象のリソースまたは上位の範囲がアーカイブされているため、この操作は使えません。現在のアーカイブ状態を確認してください。

ダッシュボード

コードHTTP意味
APP_PLATFORM_ALREADY_REGISTERED409このプロジェクト環境には同じプラットフォームの有効なアプリ環境がすでにあるため、アプリ環境を作成・復元しませんでした。プロジェクト環境ごとにAndroidアプリとiOSアプリは1つずつです。既存のアプリを先に利用停止するか、作成する場合は別の環境の種類を選んでください。
AUTHENTICATION_FAILED401認証情報を確認できませんでした。入力を見直すか、パスワードを再設定してください。
BROADCAST_ROLLOUT_BLOCKED409このアプリ環境では、ダッシュボードからの一斉配信が有効になっていません。運営者による確認と有効化が必要です。
CONCURRENT_MUTATION409同時に別の変更が行われたため、完了できませんでした。最新の状態を確認してください。
CONTROL_PLANE_UNAVAILABLE503ダッシュボードの処理サービスが一時的に利用できません。しばらくしてから確認し、続く場合は運営者に問い合わせてください。
CSRF_INVALID403ブラウザーのオリジンまたはセッションの保護情報が正しくありません。正式なダッシュボードを再読み込みしてからお試しください。
DISPATCH_CONTROL_STALE409読み取り後に配信制御の状態が変わりました。最新の状態を取得し、意図した操作かどうかを確認してください。
DISPATCH_PAUSED503このアプリ環境では配信が一時停止されており、リクエストは受け付けられませんでした。再開の判断は運営者が行います。
IDEMPOTENCY_IN_PROGRESS409同じ冪等性キーのリクエストを処理中です。Retry-Afterで指定された時間を待ち、同じリクエストを再試行してください。
IDEMPOTENCY_KEY_REUSED409同じ冪等性キーが異なる入力で使われました。先に以前のリクエストと結果を確認してください。
INITIAL_SIGNUP_UNAVAILABLE410この新規登録の確認リンクは使えません。アカウント作成画面から新しい確認メールをリクエストしてください。すでにアカウントがある場合は、ログインまたはパスワード再設定をご利用ください。
INVITATION_UNAVAILABLE410この招待は使えません。管理者に確認し、必要であれば新しい招待を依頼してください。
LAST_ACTIVE_OWNER_REQUIRED409最後の有効なオーナーを削除または無効化することはできません。先に別の有効なオーナーを設定してください。
MESSAGE_LIBRARY_PROJECT_COMPOSITION409この下書きはプロジェクト環境の複数のアプリ向けに保存されているため、1つのアプリ向けの作成内容で上書きしませんでした。プロジェクトの「メッセージを作成」画面で編集するか、作成内容を含めずに名前・ラベル・メッセージだけを保存してください。
METHOD_NOT_ALLOWED405このパスでは、指定されたHTTPメソッドを使えません。
OUTCOME_ALREADY_RESOLVED409この配信結果はすでに確定済み、または手動で確定できる対象ではありません。
PASSWORD_RESET_UNAVAILABLE410このパスワード再設定リンクは使えません。ログイン画面から新しい再設定リンクをリクエストしてください。
PERMISSION_DENIED403この認証情報またはログイン中のアカウントには、操作に必要な権限がありません。
PROVIDER_CREDENTIAL_IDENTITY_PENDING503認証情報の識別情報をまだ検証中です。完了を待ってから再確認してください。
PROVIDER_CREDENTIAL_RECOVERY_IN_PROGRESS409認証情報の復旧を検証中です。Retry-Afterで指定された時間を待ってから、同じ操作の状態を確認してください。
PROVIDER_CREDENTIAL_RECOVERY_NOT_REQUIRED409現在の認証情報は明示的な復旧が必要な状態ではありません。最新の接続状態を確認してください。
PROVIDER_CREDENTIAL_RECOVERY_REQUIRED409この認証情報には、通常の更新ではなく明示的な復旧フローが必要です。
RATE_LIMITED429リクエスト頻度または同時処理の上限に達しました。Retry-Afterで指定された時間を待ってください。
REAUTHENTICATION_REQUIRED403この重要な操作を続けるには、現在のパスワードで再確認してください。
REQUEST_TOO_LARGE413HTTPリクエスト本文が、サーバーのサイズ上限を超えています。
RESOURCE_ARCHIVED409対象のリソースまたは上位の範囲がアーカイブされているため、この操作は使えません。現在のアーカイブ状態を確認してください。
RESOURCE_NOT_FOUND404現在アクセスできる範囲に、指定されたリソースが見つかりません。
SESSION_REQUIRED401有効なダッシュボードのセッションが必要です。ログインしてから再度お試しください。
VALIDATION_FAILED422入力がリクエストの条件を満たしていません。field_errorsを確認してください。