トピックの購読

あるトピックに興味のあるユーザーは、このトピックを購読することでトピックに送信されたメッセージをプッシュ通知で受信できるようになります。

アプリケーションスコープのトピックを購読する場合、以下のようになります。

curl -v -X PUT \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/topics/SendingAlert/push/subscriptions/users/{TARGET_USER_ID}" \
  -d ""

グループスコープのトピックを購読する場合、以下のようになります。

curl -v -X PUT \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/groups/{GROUP_ID}/topics/GroupTopic/push/subscriptions/users/{TARGET_USER_ID}" \
  -d ""

ユーザースコープのトピックを購読する場合、以下のようになります。

curl -v -X PUT \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/{USER_ID}/topics/MyTODO/push/subscriptions/users/{TARGET_USER_ID}" \
  -d ""

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

購読するユーザーと ACCESS_TOKEN の所有者が同じ場合は、次の例のように TARGET_USER_ID の指定を省略できます。なお、この場合は PUT ではなく POST を使います。

curl -v -X POST \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/topics/SendingAlert/push/subscriptions/users" \
  -d ""

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

購読に成功した場合は、204 応答を返します。
指定したトピックが存在しない場合は、エラーコード TOPIC_NOT_FOUND を 404 応答で返します。
ユーザーがトピックを購読済みの場合は、エラーコード PUSH_SUBSCRIPTION_ALREADY_EXISTS を 409 応答で返します。