REST API リファレンス

共通ドキュメント

プッシュ通知取得

プッシュ通知取得APIについて

プッシュ通知の取得を行います。

基本仕様

  • APIパス：/push/オブジェクトID
  • メソッド：GET

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

なし

HTTPステータス

ステータスコード 説明
200 取得完了

レスポンスヘッダー

フィールド名 値
Content-Type application/json

レスポンスコンテント

パラメータ名 説明 データ型 必須
objectId オブジェクトID 文字列
deliveryTime 配信時刻 日付
target ターゲット 配列
searchCondition 検索条件 オブジェクト
message メッセージ 文字列
userSettingValue 会員設定値 オブジェクト
deliveryExpirationDate 配信期限日 日付
deliveryExpirationTime 配信期限時間 文字列
deliveryPlanNumber 配信予定数 数値
deliveryNumber 配信数 数値
status ステータス 数値
error エラー内容 オブジェクト
action アクション 文字列
badgeIncrementFlag バッジ数増加フラグ 真偽値
badgeSetting バッジ数 数値
sound 音楽ファイル 文字列
contentAvailable content-available 真偽値
title タイトル 文字列
dialog ダイアログ通知有効化フラグ 真偽値
richUrl リッチプッシュURL 文字列
category カテゴリ 文字列
createDate 登録日時 日付
updateDate 更新日時 日付
acl ACL オブジェクト
  • 配信予定数、配信数は以下の内容となりますので、二つの値が同一でない場合がございますが、問題ございません。
    • 配信予定数：プッシュ通知を登録した時点の配信予定端末数(プッシュ通知登録時点のinstallationに基づく)
    • 配信数：プッシュが実際に送信された端末数（プッシュ通知送信処理時点のinstallationに基づく）

プッシュ通知のステータスについて

数値 内容
0 未配信
1 配信中
2 配信済み
3 配信上限越えのため未送信で終了
4 エラーのため未送信で終了（API キー不正、証明書不正 等）
5 フラグOFFのため未送信で終了
6 送信完了だが一部送信でエラー発生

errorについては、ステータスが「6:送信完了だが一部送信でエラー発生」の場合のみ設定され、
発生したエラー内容とエラーが発生した端末数を返却します。
エラーの詳細については、エラーコード一覧をご覧ください。

リクエストサンプル

curl -X GET -G \
 -H "X-NCMB-Application-Key: 549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
 -H "X-NCMB-Signature: Emx2idk/xk0yvnTNQv+yBILy2Ftcu25hHeOvwa0cP/0=" \
 -H "Content-Type: application/json" \
https://mbaas.api.nifcloud.com/2013-09-01/push/IcdC9M0EJwn6Azef

レスポンスサンプル

{
  "objectId":"IcdC9M0EJwn6Azef",
  "deliveryTime":{
    "__type":"Date",
    "iso":"2013-09-21T04:02:00.000Z"
  },
  "target":[
    "ios",
    "android"
  ],
  "searchCondition":null,
  "message":"push test",
  "userSettingValue":null,
  "deliveryExpirationDate":null,
  "deliveryExpirationTime":null,
  "deliveryPlanNumber":1,
  "deliveryNumber":0,
  "status":0,
  "action":null,
  "badgeIncrementFlag":true,
  "sound":null,
  "contentAvailable":false,
  "title":null,
  "createDate":"2013-09-11T11:46:29.410Z",
  "updateDate":"2013-09-11T11:46:29.410Z",
  "acl":{
    "*":{
      "read":true,
      "write":true
    }
  }
}