エンドポイント一覧
ボットが呼び出せるエンドポイントを、メソッド・パス・必要な権限とともに 1 つの表にまとめました。
トークン
access token を発行・更新・失効させる OAuth エンドポイントの仕様です。
現在の配信を取得
GET /v1/live — 配信タイトル・開始/終了時刻・リスナー数・チャット凍結状態を取得します。
リスナー一覧を取得
GET /v1/live/listeners — 今部屋にいるリスナーの id・ニックネーム・サブスク状況をカーソルで分けて取得します。
ファンランキングを取得
GET /v1/live/fans — 今部屋にいるリスナーの中で、この配信のギフトランキング上位 30 名を取得します。
ギフト履歴を取得
GET /v1/live/donations — 現在の配信で受け取ったギフトステッカーの履歴をカーソルで分けて取得します。
イベントストリーム
GET /v1/live/events — チャット・入場・ハート・ギフトを SSE で受け取ります。イベント 5 種のペイロード仕様です。
チャットを送る
POST /v1/live/chat — ボットアカウント名で配信にチャットを送ります。
DJ をフォロー
POST /v1/live/follow — 連携した DJ をボットアカウントでフォローします。ボットを固定マネージャーにするには先に必要です。
DJ 識別子を取得
GET /v1/me — このトークンが指す DJ の識別子を取得します。配信中でなくても使えます。
エラーコード
ボット API のエラー応答の形式と、実際に遭遇するコードごとの対処方法です。