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

開封通知を送信する

開封登録 API

プッシュ通知の開封結果を分析情報として登録します。

基本仕様

利用方法としてコマンド「curl」を想定して API 仕様と合わせて説明します。

HTTPメソッド

PUT または POST

エンドポイント

https://api-datastore.appiaries.com/v1/push/analytics/{データストアID}/{アプリID}/_open

リクエスト

ヘッダ

Content-Type application/json
X-APPIARIES-TOKEN アクセストークンを指定します(*1)

クエリ

クエリ名 備考
access_token アクセストークン(*1)
proc put HTTPメソッドがPOSTの場合は必須。

コンテント

パラメータ名 備考
pushId プッシュ配信ID Integer APNsまたはGCMにて受信できるプッシュ配信ID。(*2)
deviceId 端末ID String APNsのデバイストークン、またはAndroidのレジストレーションID
deviceType 端末タイプ String iPhone、iPadの場合”apns”、Androidの場合”gcm”
(*1)~いずれかの方式で指定。
(*2)~プッシュ通知を端末が受信する際に取得可能なプッシュ配信ID。

レスポンス

ヘッダ

Content-Type application/json

HTTPステータス

ステータスコード 内容
204 成功
400 コンテント未指定。コンテント形式不適切。
401 トークン未指定。認証失敗。
403 アクセス権限がない。
422 コンテント値不適切。
500 予期せぬエラー発生。
507 使用可能ストレージ容量超過。

ステータスコード422のとき下記のようなJSON形式でコンテントボディが返却される

エラーコード一覧

エラーコード値 分類 内容
0080001 コンテント全般 コンテント不足
0080002 コンテント全般 コンテント名不適切
0081001 pushId null, 空白
0081002 pushId 数値ではない
0081101 deviceId null, 空白
0081102 deviceId 文字列ではない

例)curlコマンド