Skip to main content
L’objet channelPoints inclus plusieurs méthodes pour gérer les points de chaîne et les récompenses personnalisées sur votre chaîne Twitch.

​
Actions

​
getCustomRewards

Récupère la liste des récompenses personnalisées de la chaîne. 
const rewards = await ctx.twitch.channelPoints.getCustomRewards()
Type de retour La méthode retourne un tableau de CustomReward.

​
getCustomRewardsByIds

Récupère les récompenses personnalisées par ID. 
const rewardIds = ["reward_id_1", "reward_id_2"]
const rewards = await ctx.twitch.channelPoints.getCustomRewardsByIds(rewardIds)
Retourne un tableau de CustomReward. Arguments
​
rewardIds
string[]
Un tableau d’identifiants de récompenses personnalisées.

​
getCustomRewardById

Récupère une récompense personnalisée par ID. 
const rewardId = "reward_id"
const reward = await ctx.twitch.channelPoints.getCustomRewardById(rewardId)
Retourne un objet CustomReward. Arguments
​
rewardId
string
L’ID de la récompense personnalisée à récupérer.

​
createCustomReward

Crée une nouvelle récompense personnalisée sur la chaîne. 
const data = {
  title: "Titre de la récompense",
  cost: 100,
}
const reward = await ctx.twitch.channelPoints.createCustomReward(data)
Retourne un objet CustomReward. Arguments
​
data
CreateCustomRewardData
Les données de la récompense personnalisée à créer.

​
updateCustomReward

Met à jour une récompense personnalisée existante. 
const rewardId = "reward_id"
const data = {
  title: "Nouveau titre de la récompense",
  cost: 150,
}
const updatedReward = await ctx.twitch.channelPoints.updateCustomReward(
  rewardId,
  data,
)
Retourne un objet CustomReward. Arguments
​
rewardId
string
L’ID de la récompense personnalisée à mettre à jour.
​
data
UpdateCustomRewardData
Les données mises à jour de la récompense personnalisée.

​
deleteCustomReward

Supprime une récompense personnalisée de la chaîne. 
const rewardId = "reward_id"
await ctx.twitch.channelPoints.deleteCustomReward(rewardId)
Arguments
​
rewardId
string
L’ID de la récompense personnalisée à supprimer.

​
getRedemptions

Récupère les rédemptions de récompenses personnalisées pour une récompense donnée. 
const rewardId = "reward_id"
const status = "FULFILLED"
const filter = {
  sort: "NEWEST",
  maxRedemptions: 10,
}
const redemptions = await ctx.twitch.channelPoints.getRedemptions(
  rewardId,
  status,
  filter,
)
Arguments
​
rewardId
string
L’ID de la récompense personnalisée.
​
status
CustomRewardRedemptionStatus
Le statut des rédemptions à récupérer (“FULFILLED”, “CANCELED”, “UNFULFILLED”, “PARTIALLY_FULFILLED”).
​
filter
PaginatedCustomRewardRedemptionFilter
(optionnel): Les filtres supplémentaires pour les rédemptions.
Type de retour La méthode retourne un objet contenant les données des rédemptions et un curseur de pagination.

​
Types

​
CustomReward

​
id
string
L’identifiant de la récompense personnalisée.
​
backgroundColor
string
La couleur de fond de la récompense.
​
isEnabled
boolean
Indique si la récompense est activée.
​
cost
number
Le coût de la récompense en points de chaîne.
​
title
string
Le titre de la récompense.
​
prompt
string
Le texte de la demande associée à la récompense.
​
userInputRequired
boolean
Indique si une entrée utilisateur est requise.
​
maxRedemptionsPerStream
number
Le nombre maximal de rédemptions par diffusion.
​
maxRedemptionsPerUserPerStream
number
Le nombre maximal de rédemptions par utilisateur par diffusion.
​
globalCooldown
number
Le temps de refroidissement global en secondes.
​
isPaused
boolean
Indique si la récompense est en pause.
​
isInStock
boolean
Indique si la récompense est en stock.
​
redemptionsThisStream
number
Le nombre de rédemptions pendant cette diffusion.
​
autoFulfill
boolean
Indique si les rédemptions sont automatiquement satisfaites.
​
cooldownExpiryDate
Date
La date d’expiration du temps de refroidissement.

​
CustomRewardRedemption

​
id
string
L’identifiant de la rédemption de récompense personnalisée.
​
userId
string
L’identifiant de l’utilisateur qui a effectué la rédemption.
​
userName
string
Le nom d’utilisateur de l’utilisateur qui a effectué la rédemption.
​
userDisplayName
string
Le nom d’affichage de l’utilisateur qui a effectué la rédemption.
​
userInput
string
L’entrée utilisateur associée à la rédemption.
​
isFulfilled
boolean
Indique si la rédemption a été satisfaite.
​
isCanceled
boolean
Indique si la rédemption a été annulée.
​
redemptionDate
Date
La date de la rédemption.
​
rewardId
string
L’identifiant de la récompense associée à la rédemption.
​
rewardTitle
string
Le titre de la récompense associée à la rédemption.
​
rewardPrompt
string
Le texte de la demande associée à la récompense.
​
rewardCost
number
Le coût de la récompense associée à la rédemption.
⌘I