Bucket の購読解除

Bucket の講読を止めると、その Bucket で更新があってもプッシュ通知を受信しないようにできます。

アプリケーションスコープの Bucket を購読解除する例を以下に挙げます。

curl -v -X DELETE \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/buckets/{BUCKET_ID}/filters/all/push/subscriptions/users/{TARGET_USER_ID}" \
  -d ""

グループスコープの Bucket を購読解除する例を以下に挙げます。

curl -v -X DELETE \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/groups/{GROUP_ID}/buckets/{BUCKET_ID}/filters/all/push/subscriptions/users/{TARGET_USER_ID}" \
  -d ""

ユーザースコープの Bucket を購読解除する例を以下に挙げます。

curl -v -X DELETE \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/{USER_ID}/buckets/{BUCKET_ID}/filters/all/push/subscriptions/users/{TARGET_USER_ID}" \
  -d ""

いずれの場合についても {APP_ID} をアプリの値に、{TARGET_USER_ID} を購読解除するユーザーの ID にそれぞれ置き換えてください。また {ACCESS_TOKEN} は、このユーザーのアクセストークンかアプリ管理者トークンである必要があります。

Bucket の購読時とは異なり、購読者と ACCESS_TOKEN 所有者が同一であっても TARGET_USER_ID の指定は省略できません。

Kii Cloud は以下の応答を返します。

  • Bucket の購読解除に成功した場合は、204 応答を返します。
  • 指定した Bucket が存在しない場合は、エラーコード FILTER_NOT_FOUND を 404 応答で返します。
  • 指定した Bucket が購読されていない場合は、エラーコード PUSH_SUBSCRIPTION_NOT_FOUND を 404 応答で返します。