Aller au contenu
twitch.apiv2.0

Référence / Groupes de l'API

twitch.raids

Raids : en lancer un, annuler celui en attente.

Toutes les méthodes de twitch.raids, avec leurs paramètres, ce qu’elles renvoient et le jeton nécessaire.

twitch.raids.start(params, options?): Promise<PendingRaid>

Prépare un raid vers une autre chaîne. Les spectateurs ne partent que lorsque le diffuseur confirme dans l’interface de Twitch ou après un compte à rebours de 90 secondes : écoutez donc l’événement de raid de la chaîne pour savoir qu’il a eu lieu. Limité à 10 appels par tranche de 10 minutes.

Jeton : utilisateur, scope channel:manage:raids.

NomTypeDescription
from_broadcaster_idstringDiffuseur qui envoie ses spectateurs. Par défaut, l’utilisateur qui fait l’appel.
to_broadcaster_id requisstringIdentifiant du diffuseur visé par le raid.

options : Options de requête pour cet appel : as, token, signal, timeout, retries.

Promise<PendingRaid>

Champs de PendingRaid
NomTypeDescription
created_atstringDate de la demande de raid, sous forme d’horodatage RFC 3339.
is_maturebooleanObsolète. Toujours false.
const raid = await twitch.raids.start({ to_broadcaster_id: "141981764" });

Référence Twitch

twitch.raids.cancel(params?, options?): Promise<void>

Annule un raid qui n’est pas encore parti. Limité à 10 appels par tranche de 10 minutes.

Jeton : utilisateur, scope channel:manage:raids.

NomTypeDescription
broadcaster_idstringDiffuseur qui a lancé le raid. Par défaut, l’utilisateur qui fait l’appel.

options : Options de requête pour cet appel : as, token, signal, timeout, retries.

Promise<void>

await twitch.raids.cancel();

Référence Twitch