サーバー構築不要！スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:プッシュ通知検索

REST API リファレンス

共通ドキュメント

プッシュ通知検索

プッシュ通知検索APIについて

クエリ条件に合致した指定クラスのオブジェクトの情報取得を行います。クエリ条件を指定しない場合は全件取得となります。
プッシュ通知配信履歴自動バックアップ機能でバックアップされたデータは返却されません。

基本仕様

  • APIパス
    • 全件検索：/push
    • 指定検索：/push?where=
  • メソッド：GET

リクエストヘッダー

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

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

リクエストコンテント

パラメータ名 説明 データ型 必須
objectId オブジェクトID 文字列
deliveryTime 配信時刻 日付
target ターゲット 配列
searchCondition 検索条件 文字列
title タイトル 文字列
message メッセージ 文字列
userSettingValue ユーザー設定値 オブジェクト
deliveryExpirationDate 配信期限日 日付
deliveryExpirationTime 配信期限時間 文字列
deliveryPlanNumber 配信予定数 数値
deliveryNumber 配信数 数値
status ステータス 数値
error エラー内容 オブジェクト
action アクション 文字列
dialog ダイアログ通知有効化フラグ 真偽値
badgeIncrementFlag バッジ数増加フラグ 真偽値
badgeSetting バッジ数 数値
sound 音楽ファイル 文字列
contentAvailable content-available 真偽値
richUrl リッチプッシュURL 文字列
category カテゴリ 文字列
createDate 登録日時 日付
updateDate 更新日時 日付
acl ACL オブジェクト

HTTPステータス

ステータスコード 説明
200 検索完了

レスポンスヘッダー

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

レスポンスコンテント

{"results":[{(オブジェクト情報1)},{(オブジェクト情報2)},{}…]}の配列形式で返ってきます。
以下は、オブジェクト情報を記載しています。

パラメータ名 説明 データ型 必須
objectId オブジェクトID 文字列
deliveryTime 配信時刻 日付
target ターゲット 配列
searchCondition 検索条件 オブジェクト
title タイトル 文字列
message メッセージ 文字列
userSettingValue ユーザー設定値 オブジェクト
deliveryExpirationDate 配信期限日 日付
deliveryExpirationTime 配信期限時間 文字列
deliveryPlanNumber 配信予定数 数値
deliveryNumber 配信数 数値
status ステータス 数値
error エラー内容 オブジェクト
action アクション 文字列
dialog ダイアログ通知有効化フラグ 真偽値
badgeIncrementFlag バッジ数増加フラグ 真偽値
badgeSetting バッジ数 数値
sound 音楽ファイル 文字列
contentAvailable content-available 真偽値
richUrl リッチプッシュURL 文字列
createDate 登録日時 日付
updateDate 更新日時 日付
acl ACL オブジェクト

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

数値 管理画面での表示 内容
0 未配信 APNs/FCMへの配信依頼前
1 配信中 APNs/FCMへ配信依頼中
2 配信済み APNs/FCMへ配信依頼がエラーなく完了※端末までの配信はAPNs/FCMや通信環境に依存しているため、必ず端末にプッシュ通知が届いたという訳ではありません
3 上限により中止 プランによる配信上限越えのため配信依頼未実施で終了
4 配信エラー エラーのため配信依頼未実施で終了（API キー不正、証明書不正 等）もしくは配信依頼が完了したが全てでエラー発生
5 フラグOFFのため未送信で終了 フラグOFFのため配信依頼未実施で終了 ※現在の仕様により、通常利用では発生しません
6 配信済み(一部エラー) 配信依頼が完了したが一部でエラー発生

errorフィールドについては、ステータスが「4:配信エラー」もしくは「6:送信完了だが一部送信でエラー発生」の場合に、発生したエラー詳細とエラーが発生した端末数を表示します。詳細はエラーコード一覧をご覧ください。
※例外として、APNs証明書エラーにより「4:配信エラー」になった場合、errorは空になります。

なお、配信依頼結果の成功した端末件数で、ステータス「4:配信エラー」と「6:送信完了だが一部送信でエラー発生」を区別しています。成功した端末が0件の場合、ステータスが「4:配信エラー」になり、それ以外の場合、ステータスが「6:送信完了だが一部送信でエラー発生」となります。

リクエストサンプル

curl -X GET -G \
 -H "X-NCMB-Application-Key:549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp:2013-09-10T02:44:35.452Z" \
 -H "X-NCMB-Signature: KiYsaDJ6FNNhD33Bs99O2Y/WTaPGbkKReTbEvToDzaI=" \
 -H "Content-Type: application/json" \
 --data-urlencode 'where={"target":["ios"]}' \
 https://mbaas.api.nifcloud.com/2013-09-01/push

※ errorでの検索サンプルはこちらをご覧ください。

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "results":[
    {
      "objectId":"wy7SZOQOdRMQvmIJ",
      "deliveryTime":{
        "__type":"Date",
        "iso":"2013-08-13T14:00:02.801Z"
      },
      "target":[
        "ios"
      ],
      "searchCondition":null,
      "message":null,
      "userSettingValue":null,
      "deliveryExpirationDate":null,
      "deliveryExpirationTime":null,
      "deliveryPlanNumber":1,
      "deliveryNumber":0,
      "status":4,
      "action":null,
      "badgeIncrementFlag":true,
      "sound":null,
      "contentAvailable":false,
      "title":null,
      "createDate":"2013-08-13T14:00:02.805Z",
      "updateDate":"2013-08-13T14:00:02.921Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      }
    },
    {
      "objectId":"STMJtm8IyPHjGRZN",
      "deliveryTime":{
        "__type":"Date",
        "iso":"2013-10-04T03:11:59.783Z"
      },
      "target":[
        "ios"
      ],
      "searchCondition":{

      },
      "message":"test",
      "userSettingValue":null,
      "deliveryExpirationDate":null,
      "deliveryExpirationTime":"10 day",
      "deliveryPlanNumber":1,
      "deliveryNumber":1,
      "status":2,
      "action":null,
      "badgeIncrementFlag":false,
      "sound":"",
      "contentAvailable":false,
      "title":null,
      "createDate":"2013-10-04T03:11:59.784Z",
      "updateDate":"2013-10-04T03:12:01.250Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      }
    }
  ]
}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。（回答保証はいたしかねます）
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ