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

配信予約を削除する

予約削除 API

「指定日時予約登録 API」により登録されたプッシュ通知予約(GCM&APNs)を削除します。
予約の削除は、送信ステータスが「未送信」の場合に行えます。
送信中の予約で送信ステータスが「送信中」「再送信待ち」の場合、送信途中の配信が強制停止されます。
強制停止以降のデバイス配信数は、「通知結果取得API」ではエラーとして、カウントされます。

基本仕様

API 仕様

項目 説明
エンドポイント https://api-datastore.appiaries.com/v1/push/manage/
{contractId}/{applicationId}/{reserveId}
エンドポイントのパラメータ {contractId}:契約者ID
{applicationId}:アプリケーションID
{reserveId}:送信予約ID
メソッド DELETE
リクエストコンテントタイプ 指定なし
レスポンスコンテントタイプ 指定なし
制約事項 ・「デバイスプッシュ通知:指定日時予約登録API」の予約登録が存在する必要があります。
・送信ステータス「未送信」の予約登録が削除対象となります。
・送信ステータス「送信中」「再送信待ち」の予約登録は、送信が強制停止されます。
・「デバイスプッシュ通知:即時配信登録API」の送信登録は即時送信されるため、削除できません。

ヘッダーパラメータ

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

返却値: レスポンスステータス

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

ステータスコード 説明
204 正常に処理が終了しました。
400 不正なリクエスト内容が送信されました。
401 アプリトークンが未指定、又は、認証に失敗しました。
403 指定されたIDにアセス権限がありません。
404 削除対象の予約登録が存在しません。
412 送信予約の送信ステータスが「送信完了」「キャンセル」のため、削除できません。
500 アピアリーズサーバに於いて、エラーが発生しました。

REST API のリクエスト例

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

curl のリクエスト例

  • リクエストコマンドの例

  • 返却値の例

レスポンスステータスが「204:正常終了」であることを確認します。