REST API リファレンス : エラーコード一覧

REST API リファレンス

共通ドキュメント

エラーコード一覧

1 REST APIのエラーコードについて
2 「配信エラー内容」について

REST APIのエラーコードについて

REST APIを利用中、エラーが発生した場合には、エラーコードとメッセージがJSON形式で返却されます。

エラーコード	エラーメッセージ	内容
E100001	Authentication error by response signature incorrect.	レスポンスシグネチャの不一致 E404002,E404005,E405002,E415001ではレスポンスシグネチャがヘッダーに含まれないので、レスポンスの検証を有効にしていて上記エラーが発生しても、E100001が必ず返却される。（本エラーはレスポンスの検証を行った場合にSDK上で返却される）
E400000	Bad Request.	不正なリクエスト
E400001	JSON is invalid format.	JSON形式不正
E400002	{0} is invalid.	型が不正
E400003	{0} is empty.	必須項目で未入力
E400004	{0} is invalid format.	フォーマットが不正
E400005	{0} is not a valid value.	有効な値でない
E400006	{0} does not exist.	存在しない値
E400007	{0} is invalid format[lineNo:{1}].	インポートエラー
E400008	Either {0} or {1}.	相関関係でエラー
E400009	{0} size must be between {1} and {2}.	指定桁数を超えている
E401000	Unauthorized.	認証エラー
E401001	Authentication error by header incorrect.	Header不正による認証エラー
E401002	Authentication error with ID/PASS incorrect.	ID/Pass認証エラー
E401003	OAuth {0} authentication error.	OAuth認証エラー
E403000	Forbidden.	アクセス権なし
E403001	No access with ACL.	ACLによるアクセス権なし
E403002	Unauthorized operations for {0}.	管理者（サポート）権限なし
E403003	Operation that are prohibited.	禁止されているオペレーション
E403004	One-Time-Token expired.	ワンタイムキー有効期限切れ
E403005	{0} must not be entered.	設定不可の項目
E403006	Invalid GeoPoint value.	GeoPoint型フィールドに対してGeoPoint型以外の値を登録／更新 GeoPoint型以外のフィールドに対してGeoPoint型の値を登録／更新不正な位置検索を実施
E404001	No data available.	該当データなし
E404002	None service.	該当サービスなし
E404003	None field.	該当フィールドなし
E404004	None device token.	該当デバイストークンなし
E404005	No such application.	該当アプリケーションなし
E404006	No such user.	該当ユーザなし
E405001	Method not allowed.	リクエストURI/メソッドが不許可（サービス提供しているURI/メソッドでない）
E409001	{0} is duplication.	重複エラー。重複したデータが存在している。
E413001	File size Limit error.	1ファイルあたりのサイズ上限エラー
E413002	Request entity too large.	MongoDB1ドキュメントあたりのサイズ上限エラー（16MB）
E414000	Request-URI Too Large.	リクエストURI長の上限エラー
E415001	Unsupported media type.	サポート対象外のContent-Typeを指定
E429001	{0} have passed their limit.	使用制限（APIコール数、PUSH通知数、ストレージ容量）超過
E429002	Too many requests.	使用制限（過度な同時接続）
E500001	System error.	システムエラー
E502001	Storage error.	ストレージエラー。ストレージでエラーが発生した場合のエラー。
E502002	Mail failure.	メール送信エラー
E503001	Service unavailable.	サービス利用不可

「配信エラー内容」について

プッシュ通知の詳細画面にて、
配信エラーが発生する場合、「配信エラー内容」にて詳細を記載しています。

エラー表示

プッシュ通知のstatusはcomplete, timeout, error, unknownがあります。
エラーが発生する場合、エラーの詳細は以下のような例があります。

{
    "description": {             
        "status": "complete"     
    },                           
    "ios": {
        "total": 999999,
        "complete": 999986,
        "unknown": 1,
        "systemError": 1,
        "invalidToken": 1,
        "noErrorsEncountered": 1,
        "processingError": 1,
        "missingDeviceToken": 1,
        "missingTopic": 1,
        "missingPayload": 1,
        "invalidTokenSize": 1,
        "invalidTopicSize": 1,
        "invalidPayloadSize": 1,
        "badCollapseId": 1,
        "badDeviceToken": 1,
        "badExpirationDate": 1,
        "badMessageId": 1,
        "badPriority": 1,
        "badTopic": 1,
        "deviceTokenNotForTopic": 1,
        "duplicateHeaders": 1,
        "idleTimeout": 1,
        "invalidPushType": 1,
        "payloadEmpty": 1,
        "topicDisallowed": 1,
        "badCertificate": 1,
        "badCertificateEnvironment": 1,
        "expiredProviderToken": 1,
        "forbidden": 1,
        "invalidProviderToken": 1,
        "missingProviderToken": 1,
        "badPath": 1,
        "methodNotAllowed": 1,
        "unregistered": 1,
        "payloadTooLarge": 1,
        "tooManyProviderTokenUpdates": 1,
        "tooManyRequests": 1,
        "internalServerError": 1,
        "serviceUnavailable": 1,
        "shutdown": 1,
        "none": 1
    },
    "gcm": {
        "total": 499999,
        "complete": 499984,
        "unknown": 1,
        "systemError": 1,
        "missingRegistration": 1,
        "invalidRegistration": 1,
        "notRegistered": 1,
        "invalidPackageName": 1,
        "mismatchSenderId": 1,
        "messageTooBig": 1,
        "invalidDataKey": 1,
        "invalidTtl": 1,
        "timeout": 1,
        "internalServerError": 1,
        "topicsMessageRateExeeded": 1,
        "invalidJson": 1,
        "authenticationError": 1
    },
    "fcm": {
        "total": 500000,
        "complete": 499982,
        "unknown": 1,
        "systemError": 1,
        "serverUnavailable": 1,
        "invalidArgument": 1,
        "invalidRecipient": 1,
        "invalidPayload": 1,
        "invalidDataPayloadKey": 1,
        "payloadSizeLimitExceeded": 1,
        "invalidOptions": 1,
        "invalidRegistrationToken": 1,
        "registrationTokenNotRegistered": 1,
        "invalidPackageName": 1,
        "messageRateExceeded": 1,
        "deviceMessageRateExceeded": 1,
        "topicsMessageRateExceeded": 1,
        "tooManyTopics": 1,
        "mismatchedCredential": 1,
        "authenticationError": 1
    },
    "android": {
        "total": 999999,
        "complete": 999966,
        "unknown": 2,
        "systemError": 2,
        "missingRegistration": 1,
        "invalidRegistration": 1,
        "notRegistered": 1,
        "invalidPackageName": 1,
        "mismatchSenderId": 1,
        "messageTooBig": 1,
        "invalidDataKey": 1,
        "invalidTtl": 1,
        "timeout": 1,
        "internalServerError": 1,
        "topicsMessageRateExeeded": 1,
        "invalidJson": 1,
        "authenticationError": 2,
        "serverUnavailable": 1,
        "invalidArgument": 1,
        "invalidRecipient": 1,
        "invalidPayload": 1,
        "invalidDataPayloadKey": 1,
        "payloadSizeLimitExceeded": 1,
        "invalidOptions": 1,
        "invalidRegistrationToken": 1,
        "registrationTokenNotRegistered": 1,
        "invalidPackageName": 1,
        "messageRateExceeded": 1,
        "deviceMessageRateExceeded": 1,
        "topicsMessageRateExceeded": 1,
        "tooManyTopics": 1,
        "mismatchedCredential": 1
    }
}

description: プッシュ送信処理結果プッシュ送信処理結果を表示します。
total: プッシュ送信時にトータル何端末分の処理を行ったかを表示します。
"ios"の場合:
- "total", "complete", "unknown", "systemError"の項目：送信結果別iOS端末数（システムステータス）。送信処理に対してプッシュシステムによるステータスごとのiOS端末数です。
- その他の項目：送信結果別iOS端末数（APNSステータス）。送信処理に対してAPNs（Apple Push Notification Service）から返却されたエラーコード別のiOS端末数です。
"android"の場合:
- "total", "complete", "unknown", "systemError"の項目：送信結果別Android端末数（システムステータス）。送信処理に対してプッシュシステムによるステータスごとのAndroid端末数です。
- その他の項目：送信結果別Android端末数（GCM / FCM ステータス）。送信処理に対してGCM / FCM （Google Cloud Messaging / Firebase Cloud Messaging）から返却されたエラーコード別のAndroid端末数です。

GCM送信結果詳細

項目	説明
total	総プッシュ送信処理数
complete	送信完了端末数
unknown	送信結果不明端末数
systemError	システムエラーが発生した端末数
missingRegistration	(GCM) 端末ID欠如
invalidRegistration	(GCM) 不正な端末ID
notRegistered	(GCM) 未登録端末ID
invalidPackageName	(GCM) 不正なパッケージ名
mismatchSenderId	(GCM) 誤った送信元ID
messageTooBig	(GCM) メッセージ過大
invalidDataKey	(GCM) 不正なデータキー
invalidTtl	(GCM) 不正な有効期限
timeout	(GCM)　タイムアウト
internalServerError	(GCM) サーバエラー
topicsMessageRateExeeded	(GCM) 過剰なトピックメッセージ
invalidJson	(GCM) 不正なJSON
authenticationError	(GCM) 認証エラー

Androidの詳細には、エラーコード以外にも removeToken, updateToken が出力されることがあります。こちらはエラーではありません。内部システムにおいて、GCM送信後に即時端末データの更新／削除を行っています。
端末が notRegistered として返却された場合、端末が自動削除されます。削除された台数を removeToken として返却します。
端末が canonicalID として返却された場合、端末が自動更新されます。更新された台数を updateToken として返却します。

FCM送信結果詳細

項目	説明
total	総プッシュ送信処理数
complete	送信完了端末数
unknown	送信結果不明端末数
systemError	システムエラーが発生した端末数
serverUnavailable	システムエラーが発生した端末数
invalidArgument	(FCM) 不正な引数
invalidRecipient	(FCM) 不正な受信者
invalidPayload	(FCM) 不正なペイロード
invalidDataPayloadKey	(FCM) ペイロード内に不正なキー
payloadSizeLimitExceeded	(FCM) 過剰なサイズのペイロード
invalidOptions	(FCM) 不正なメッセージオプション
invalidRegistrationToken	(FCM) 不正なトークン
registrationTokenNotRegistered	(FCM) 登録されていないトークン
invalidPackageName	(FCM) 不正なパッケージ名
messageRateExceeded	(FCM) 特定ターゲットへのメッセージ過剰
deviceMessageRateExceeded	(FCM) 特定端末へのメッセージ過剰
topicsMessageRateExceeded	(FCM) 特定トピックへのメッセージ過剰
tooManyTopics	(FCM) 過剰なトピック数登録
mismatchedCredential	(FCM) 不正な認証情報 ※1
authenticationError	(FCM) 認証エラー

※1 mismatchedCredential エラーが返却される場合は、FCM API 機能が有効化されていないことが考えられます。 FCM APIの管理画面を開き、「プロジェクトの選択」からプロジェクトを選択後、「有効にする」をクリックしてAPIを有効にしてください。
ペイロードのサイズ制限は2,048バイトになります。
Androidの詳細には、エラーコード以外にも removeToken が出力されることがあります。こちらはエラーではありません。内部システムにおいて、FCM送信後に即時端末データの削除を行っています。
端末が registrationTokenNotRegistered として返却された場合、端末が自動削除されます。削除された台数を removeToken として返却します。

APNs送信結果詳細

項目	説明
total	総プッシュ送信処理数
complete	送信完了端末数
unknown	送信結果不明端末数
systemError	システムエラーが発生した端末数
noErrorsEncountered	(APNS) エラー無し
invalidToken	(APNS) 不正なトークン
processingError	(APNS) 処理エラー
missingDeviceToken	(APNS) デバイストークン欠如
missingTopic	(APNS) トピック欠如
missingPayload	(APNS) ペイロード欠如
invalidTokenSize	(APNS) 不正なトークンサイズ
invalidTopicSize	(APNS) 不正なトピックサイズ
invalidPayloadSize	(APNS) 不正なペイロードサイズ
badCollapseId	(APNS) 不正な識別子
badDeviceToken	(APNS) 不正なトークン
badExpirationDate	(APNS) 不正な配信期限
badMessageId	(APNS) 不正なパラメータ
badPriority	(APNS) 不正なパラメータ
badTopic	(APNS) 不正なトピック
deviceTokenNotForTopic	(APNS) 不正なトークン
duplicateHeaders	(APNS) 不正なパラメータ
idleTimeout	(APNS) タイムアウト
invalidPushType	(APNS) 不正なパラメータ
payloadEmpty	(APNS) ペイロード情報欠落
topicDisallowed	(APNS) 不許可トピックへの送信
badCertificate	(APNS) 不正な証明書
badCertificateEnvironment	(APNS) 不正な証明書（本番用、開発用取り違え）
expiredProviderToken	(APNS) 配信トークンの期限切れ
forbidden	(APNS) 不許可操作
invalidProviderToken	(APNS) 不正な配信トークン
missingProviderToken	(APNS) 認証不備
badPath	(APNS) リクエスト形式の不正
methodNotAllowed	(APNS) リクエスト形式の不正
unregistered	(APNS) 期限切れ（アプリ削除済み）デバイストークンへの送信
payloadTooLarge	(APNS) ペイロード上限越え
tooManyProviderTokenUpdates	(APNS) 更新回数の多い配信トークン
tooManyRequests	(APNS) 同一デバイストークンへのリクエスト過多
internalServerError	(APNS) 内部エラー
serviceUnavailable	(APNS) サービス利用不可（APNS内部エラー）
shutdown	(APNS) 停止
none	(APNS) 不明

※APNs、GCM、FCMステータスは予告なく変更されることがあります。