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

デバイストークンを登録する

デバイストークン 登録 API

iOS のプッシュ通知送信に必要なデバイストークンを登録します。
デバイストークンは単体、または複数を指定することができます。

基本仕様

API 仕様

項目 説明
エンドポイント https://api-datastore.appiaries.com/v1/push/apns/{contractId}/{applicationId}/_target
エンドポイントのパラメータ {contractId}:契約者ID
{applicationId}:アプリケーションID
メソッド PUT (POST の場合は proc=put を指定)
リクエストコンテントタイプ 指定なし
レスポンスコンテントタイプ application/json
制約事項

ヘッダーパラメータ

パラメータ名 項目名 タイプ 必須 説明
Content-Type application/json コンテントタイプ 文字列
X-Appiaries-Token Appiariesトークン 文字列 アプリトークン

クエリーパラメータ

パラメータ名 項目名 タイプ 必須 説明
access_token アクセストークン 文字列
proc put PUT メソッド代替 文字列 ※説明参照 ※HTTPメソッドが POST の場合は必須
get true 返却値取得フラグ 文字列 デフォルトは false

ボディパラメータ

パラメータ名 項目名 タイプ 必須 説明
devicetoken デバイストークン 文字列
attr 端末属性 文字列 ・自由に設定できるデータ領域です。
・配信予約を登録するとき、ここに設定した値で配信対象を絞り込むことができます。

返却値

返却値: レスポンスヘッダ
ヘッダー
Content-Type application/json
返却値: レスポンスボディ

複数のデバイストークンを指定したときのみ、成功時、以下が返却されます。

パラメータ名 項目名 タイプ 説明
_count 登録総数件数 int
_failed 登録失敗件数 int

例:

返却値: レスポンスステータス
ステータスコード 説明
204 成功
400 コンテント未指定。コンテント形式不適切。
401 トークン未指定。認証失敗。
403 アプリにアクセスする権限がない。コレクションに create 権限がない。コレクションに格納可能なオブジェクトが”JSONデータ”ではない。
422 コンテント値不適切
500 予期せぬエラー発生
507 使用可能ストレージ容量超過

ステータスコード 409 または 422 のとき、JSON 形式による次のようなコンテントボディが返却されます。

エラーコード一覧

エラーコード 分類 内容
0080001 コンテント全般 コンテント不足
0080002 コンテント全般 コンテント名不適切
0080201 レジストレーションID null, 空白
0080202 レジストレーションID 文字列ではない
0080203 レジストレーションID LF, CR, TABを除く制御文字が含まれている。
0080103 attr LF, CR, TABを除く制御文字が含まれている。

curl のリクエスト例

リクエストコマンドの例

list.json の中身:

単一のデバイストークンを登録する場合

複数のデバイストークンを登録する場合