お知らせ

こんにちは。Spoon運営チームです。

開発者の皆さまからいただいたご意見をもとに、Spoon Developersに新しいAPIを追加し、既存APIの仕様をアップデートしました。特にご要望の多かったギフト履歴、サブスク情報、フォローイベントに関する機能を追加しています。

1. ギフト履歴取得APIを追加

現在のLIVEで発生したギフト履歴を取得できるGET /v1/live/donations APIを追加しました。

• 必要な権限：donations.read
• 取得できる情報：送ったリスナーの識別子とニックネーム、ギフト名、spoon数、送信日時
• カーソル方式のページネーションに対応

取得できるのは現在のLIVEの履歴のみで、LIVE終了後は取得できません。ギフトに添えられたメッセージと画像URLはレスポンスに含まれません。

2. リスナー一覧にサブスク情報を追加

GET /v1/live/listenersのレスポンスにsubscriptionフィールドを追加しました。

• 必要な権限：listeners.read
• サブスク中の場合：subscription.planにPLAN_1、PLAN_2、PLAN_3のいずれかが返されます。
• サブスク中でない場合：subscriptionはnullになります。

3. フォローイベントを追加

イベントストリームにfollowイベントを追加しました。

• 必要な権限：events.follow

LIVE中にリスナーがDJを初めてフォローしたときに届きます。

ボットアカウントがそのLIVEのマネージャーに指定されている必要があります。

LIVE外でのフォローや、同じLIVE内での再フォローは届きません。

4. DJ識別子取得APIを追加

同意したDJの識別子を取得できるGET /v1/me APIを追加しました。

• 必要な権限：me.read

LIVE配信中でなくても利用できます。

レスポンスのuserIdは、DJがイベントストリームでコメントしたときに届くuser.idと同じ値です。

ご利用前にご確認ください

donations.read、events.follow、me.readは新しく追加された権限です。既存のアプリで利用する場合は、開発者センターで必要な権限を追加したうえで、DJから再度同意を得てください。

リクエスト・レスポンス仕様や実装例については、v1.2.0の変更内容をご確認ください。

今後も開発者の皆さまからのご意見をもとに、Spoon Developersの機能とドキュメントを改善してまいります。

今後ともSpoonをよろしくお願いいたします。

Spoon