メインコンテンツまでスキップ

権限を選ぶ

権限はボットが DJ に求める同意の単位です。アプリに登録した権限だけを要求でき、DJ が 許可した権限だけが実際に動作します。

各権限がどのエンドポイントにつながるかは、下の表の 仕様 列からすぐ開けます。 このページは何を選ぶかを決めるために使います。

権限一覧​

スコープDJ に表示される名前何を与えるか仕様
me.read自分を指す識別子を見るこのトークンが指す DJ の暗号化識別子 — どのボットにも基本として必要ですDJ 識別子を取得
live.read自分の配信情報を見る配信タイトル・開始/終了時刻・リスナー数・挨拶・カテゴリ・チャット凍結状態現在の配信を取得
listeners.read自分の配信のリスナー一覧を見る部屋にいるリスナーの id・ニックネーム・サブスク状況リスナー一覧を取得
fans.read自分の配信のファンランキングを見るギフトが多い順のリスナー順位ファンランキングを取得
events.chat自分の配信のチャットを見るリスナーのチャットと DJ のクイックメッセージをリアルタイムにイベントストリーム · chat
events.presence自分の配信に誰が入るかを見るリスナーの配信入場をリアルタイムにイベントストリーム · presence
events.like自分の配信のハートを見るリスナーが送ったハートをリアルタイムにイベントストリーム · like
events.donation自分の配信のギフトをリアルタイムで見る送り主・合計スプーン・一言をリアルタイムにイベントストリーム · donation
donations.read自分の配信のギフト履歴を見る現在の配信で受け取ったギフト履歴の照会 — ボット停止中の復旧用ギフト履歴を取得
events.follow自分の配信の新しいフォローを見る配信中の新しいフォローをリアルタイムに — 配信ごとの最初のフォローだけイベントストリーム · follow
chat.send自分の配信にボット名でチャットを送るボットアカウント名での発言チャットを送る
dj.followボットアカウントが自分をフォローするボットアカウントでの DJ のフォロー。固定マネージャーに指定される前に必要ですDJ をフォロー

どの組み合わせが必要ですか​

ボットが実際に使うものだけを要求します。同意画面の権限が多いほど、DJ は許可をためらいます。

作りたいボット必要な権限
チャットに反応して返すボットevents.chat · chat.send
配信の開始・終了に合わせて案内するボットlive.read · chat.send
入場したリスナーを歓迎するボットevents.presence · chat.send · dj.follow(DJ の 固定マネージャー指定 が必要。その前にボットアカウントが dj.follow で DJ をフォロー)
ギフトにお礼を送るボットevents.donation · chat.send
取りこぼしたギフトを復旧・集計するボットdonations.read · events.donation
新しいファンにお礼を送るボットevents.follow · chat.send(DJ の 固定マネージャー指定 が必要)
ハートを集計して目標を知らせるボットevents.like · chat.send
リスナーから抽選するボットlisteners.read · chat.send
ファンランキングを読み上げるボットfans.read · chat.send
出席やランキングを集計するボットevents.chat · events.presence · live.read

要求する方法​

ユーザーの同意を得る の scope パラメータに スペース区切りで 並べます。URL に載せるときは %20 でエンコードします。

&scope=me.read%20events.chat%20events.presence%20chat.send

同意は積み重なります。後から権限を追加したい場合は、増やした権限で同意画面をもう一度 表示すればよく、DJ には 新しく要求した権限だけ が表示されます。

発行されたトークンの scope は その時点の DJ の同意 に基づきます。更新のたびに 確認してください — 詳しくは トークン にあります。

知っておくこと 2 つ​

イベント権限はひとつの接続を共有します​

events. で始まる 5 つの権限は ひとつの接続を共有します。

  • そのうち どれかひとつでも あれば イベントストリーム が開きます。
  • 同意されていないイベントは除外されます。接続は正常なのにそのイベントだけ届きません。
  • ひとつもなければ 403 です。

同意だけでは動かない権限があります​

events.presence と events.follow は、ボットがマネージャーで あってはじめて動作します。運用するボットは DJ が 固定マネージャー に指定することをおすすめします。 固定マネージャーになるには、ボットアカウントが先に DJ をフォロー している必要があります。dj.follow を得て DJ をフォロー を呼ぶか、ボットアカウントで Spoon アプリにログインして直接フォローします。

同意はあるのに指定がない場合、エラーになりません。 ストリームは 200 で開き chat も 届くのに presence と follow だけが 1 件も届かないため、原因を見つけにくいです。 配信サーバーが入場・フォロー通知を マネージャー等級 で発行するためです。

指定の手順は イベントストリーム にあります。

関連ドキュメント​