REST API プッシュAPI
最終更新日 2015-9-8

配信結果を取得する (個別)

通知結果個別取得 API

「指定日時予約登録 API」によって登録された予約配信の送信予約 ID を指定することで、その配信結果を取得します。
送信予約日時が経過していない場合、取得できるのは予約情報のみです。
送信予約日時が経過している場合、予約情報と送信ステータス情報が取得できます。
送信予約 ID は複数指定できます。

基本仕様

API 仕様

項目 説明
エンドポイント https://api-datastore.appiaries.com/v1/push/manage/
{contractId}/{applicationId}
エンドポイントのパラメータ {contractId}:契約者ID
{applicationId}:アプリケーションID
メソッド GET
リクエストコンテントタイプ 指定なし
レスポンスコンテントタイプ application/json
制約事項 ・予約配信が存在している必要があります。

ヘッダーパラメータ

パラメータ名 項目名 タイプ 必須 説明
X-Appiaries-Token Appiariesトークン 文字列 アプリトークン

クエリーパラメータ

パラメータ名 項目名 タイプ 必須 説明
reserveId 送信予約ID 文字列
リスト
・複数の送信予約 ID が指定できます。
(例)

?reserveId=1&reserveId=2…

返却値

返却値: コンテントボディ

クエリパラメータで指定された送信予約ID数分、下記のパラメータが返却されます。

パラメータ名 パラメータ名(子) 項目名 タイプ 説明
_id 送信予約ID 文字列 ・送信予約IDを返します。
exist データ存在フラグ Boolean ・設定されたデータ存在フラグを返します。
・true:データが存在する場合
・false:データが存在しない場合
type プラットフォーム種別 文字列 ・apns または gcm を返します。
reserve_datetime 送信予約日時 文字列 ・設定された送信予約日時を返します。
・yyyy-MM-ddTHH:mm+0900
(ISO8601)
apns APNs オブジェクト APNsパラメータ定義開始ポイント
alert 通知 オブジェクト 通知メッセージ定義開始ポイント
body 通知メッセージ 文字列 ・設定された通知センターの表示メッセージを返します。
badge バッヂ Int ・設定されたホーム画面上のアイコンの右上に表示される数値を返します。
sound 通知音声 文字列 ・設定された通知センターがプッシュ通知を受取った際に鳴らすサウンドの指定を返します。
content_available バックグラウンド起動フラグ Int ・設定されたiOS7以降、バックグラウンド通知の指定を返します。
・0=フロント起動
・1=バックグラウンド起動

(Apple 提供ガイドラインからの抜粋)

content-availableプロパティの値が1であれば、リモート通知は「無言の」通知として振る舞います。無言の通知が届くと、iOSはアプリケーションをバックグラウンドで「起こし」て、サーバから新規データを取得したり、バックグラウンドで情報を処理したりできるようにします。ユーザは、この時点では新しい情報や変化した情報を何も知らされませんが、次にアプリケーションを開いた時点で知ることができます。

custom_data カスタムデータ オブジェクト ・設定されたアプリケーションが利用するパラメータを返します。
production プッシュ送信先環境 Boolean ・設定されたプッシュ送信先の環境を返します。
・true:本番環境
・false:サンドボックス環境
gcm gcm オブジェクト GCMパラメータ定義開始ポイント
data 通知データ オブジェクト ・設定されたアプリケーションが利用するパラメータを返します。
collapse_key グループ折畳メッセージ 文字列 ・設定された折畳メッセージ文字列を返します。
delay_while_idle アイドル時送信の有効/無効 Boolean ・設定されたアイドル送信の有効/無効を返します。
・true:有効
・false:無効
time_to_live メッセージ保存時間 Int ・設定されたメッセージの保存時間の指定を返します。
ccs_use CCS送信フラグ Boolean ・デフォルト「true:ccs送信」
sample_date 最終データ更新日時 文字列 ・送信結果情報の最終更新日時を返します。
・「送信ステータス」が「2:送信完了、
4:キャンセル」の場合、送信完了日時
・yyyy-MM-ddTHH:mm+0900
(ISO8601)
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_status 送信ステータス Int ・送信ステータスを返します。
・0:未送信、1:送信中、2:送信完了
3:再送信待ち、4:キャンセル
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_start_date 送信開始時刻 文字列 ・送信開始時刻を返します。
・yyyy-MM-ddTHH:mm+0900
(ISO8601)
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
device_count 送信予約数 Int ・プッシュ送信対象デバイスの登録台数の合計を返します。
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_completion 送信完了数 Int ・プッシュ送信対象デバイスの送信完了数の合計を返します。
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_ok 送信成功数 Int ・プッシュ送信対象デバイスの送信成功数の合計を返します。
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_error 送信エラー数 Int ・プッシュ送信対象デバイスの送信エラー数の合計を返します。
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_error_content 送信エラー内容 オブジェクト ・プッシュ送信対象デバイスの送信エラーの内容を返します。
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
send_retry 送信再送数 Int ・プッシュ送信対象デバイスの再送信数の合計を返します。
・取得タイミングによっては実際の配信結果との差異が生じることもあります。
返却値: レスポンスステータス

REST APIのレスポンスステータスを下記に説明します。

ステータスコード 説明
200 正常に処理が終了しました。
400 不正なリクエスト内容が送信されました。
401 アプリトークンが未指定、又は、認証に失敗しました。
403 指定されたIDにアセス権限がありません。
422 パラメータが不適切です。
500 アピアリーズサーバに於いて、エラーが発生しました。

REST API のリクエスト例

項目
リクエスト先のエンドポイント https://api-datastore.appiaries.com/v1/push/manage/{contractId}/{applicationId}?reserveId=1&reserveId=2
メソッド GET
コンテントタイプ 指定なし
ヘッダーパラメータ X-Appiaries-Token: {アプリトークン}

curl のリクエスト例

リクエストコマンドの例

返却値の例:正常

返却値の例:異常(1):パラメータエラー発生

※エラー番号一覧は「エラーコード一覧」を参照して下さい。

返却値の例:異常(2):パラメータエラー発生

※エラー番号一覧は「エラーコード一覧」を参照して下さい。