Skip to content

系統變數完整參考

這份頁面由程式中的變數 catalog 自動產生。未列出的事件 payload 欄位不屬於公開保證。

缺少或為 null 的變數會輸出空字串。標示為「使用者輸入」的值可能經過系統內容過濾。

channel-point-redemption

變數說明型別可為空輸入來源範例
{cost}獎勵點數:兌換獎勵所需的忠誠點數。number系統資料1000
{message}觀眾輸入內容:兌換時填寫的內容。string使用者輸入想聽這首歌
{reward}獎勵名稱:被兌換的忠誠點數獎勵名稱。string系統資料點歌
{user}兌換者顯示名稱:兌換忠誠點數獎勵的觀眾名稱。string使用者輸入viewer26
{user_login}兌換者 Twitch ID:兌換者的 Twitch login。string系統資料viewer26

custom-command / chat.command

變數說明型別可為空輸入來源範例
{args}指令參數:指令名稱後方的完整文字。string使用者輸入only26k hello
{command}指令名稱:包含驚嘆號的自訂指令名稱。string系統資料!hello
{login}使用者 Twitch ID:輸入指令者的 Twitch login。string系統資料viewer26
{user}使用者顯示名稱:輸入指令者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_id}使用者 Twitch User ID:輸入指令者的 Twitch 數字識別碼。string系統資料123456789

donation-alert / donation.paid

變數說明型別可為空輸入來源範例
{amount}贊助金額:這筆贊助的金額。number系統資料520
{donor_name}贊助者名稱:贊助頁面送出的公開名稱。string使用者輸入viewer26
{message}贊助留言:贊助者輸入的留言。string使用者輸入直播加油!

event-action / chat-lottery.round_started

變數說明型別可為空輸入來源範例
{keyword}參加關鍵字:chat-lottery.round_started 結果事件提供的「參加關鍵字」。string系統資料範例

event-action / chat-lottery.winner_drawn

變數說明型別可為空輸入來源範例
{entry_count}參加人數:chat-lottery.winner_drawn 結果事件提供的「參加人數」。number系統資料10
{odds_percent}中獎機率百分比:chat-lottery.winner_drawn 結果事件提供的「中獎機率百分比」。number系統資料10
{total_weight}總權重:chat-lottery.winner_drawn 結果事件提供的「總權重」。number系統資料10
{viewer}觀眾顯示名稱:chat-lottery.winner_drawn 結果事件提供的「觀眾顯示名稱」。string使用者輸入範例
{viewer_login}觀眾 Twitch ID:chat-lottery.winner_drawn 結果事件提供的「觀眾 Twitch ID」。string系統資料範例
{weight}中獎權重:chat-lottery.winner_drawn 結果事件提供的「中獎權重」。number系統資料10

event-action / check_in.completed

變數說明型別可為空輸入來源範例
{streak_days}連續簽到天數:check_in.completed 結果事件提供的「連續簽到天數」。number系統資料10
{stream_day}直播日:check_in.completed 結果事件提供的「直播日」。string系統資料範例
{today_check_in_count}今日簽到人數:check_in.completed 結果事件提供的「今日簽到人數」。number系統資料10
{total_days}累計簽到天數:check_in.completed 結果事件提供的「累計簽到天數」。number系統資料10
{viewer}觀眾顯示名稱:check_in.completed 結果事件提供的「觀眾顯示名稱」。string使用者輸入範例
{viewer_login}觀眾 Twitch ID:check_in.completed 結果事件提供的「觀眾 Twitch ID」。string系統資料範例

event-action / prank_wheel.spin_completed

變數說明型別可為空輸入來源範例
{amount}金額:prank_wheel.spin_completed 結果事件提供的「金額」。number系統資料10
{gift_count}贈訂數量:prank_wheel.spin_completed 結果事件提供的「贈訂數量」。number系統資料10
{prize}獎項:prank_wheel.spin_completed 結果事件提供的「獎項」。string系統資料範例
{source}觸發來源:prank_wheel.spin_completed 結果事件提供的「觸發來源」。string系統資料範例
{user}觸發使用者:prank_wheel.spin_completed 結果事件提供的「觸發使用者」。string使用者輸入範例

event-action / progress_goals.completed

變數說明型別可為空輸入來源範例
{progress_id}進度 ID:progress_goals.completed 結果事件提供的「進度 ID」。string系統資料範例
{target_value}目標值:progress_goals.completed 結果事件提供的「目標值」。number系統資料10
{title}標題:progress_goals.completed 結果事件提供的「標題」。string系統資料範例

event-action / raffle.draw_completed

變數說明型別可為空輸入來源範例
{odds_percent}中獎機率百分比:raffle.draw_completed 結果事件提供的「中獎機率百分比」。number系統資料10
{remaining_effective_tickets}中獎後剩餘有效籤數:raffle.draw_completed 結果事件提供的「中獎後剩餘有效籤數」。number系統資料10
{ticket_count_at_draw}抽出時籤數:raffle.draw_completed 結果事件提供的「抽出時籤數」。number系統資料10
{total_effective_tickets_at_draw}抽出時總有效籤數:raffle.draw_completed 結果事件提供的「抽出時總有效籤數」。number系統資料10
{viewer}觀眾顯示名稱:raffle.draw_completed 結果事件提供的「觀眾顯示名稱」。string使用者輸入範例
{viewer_login}觀眾 Twitch ID:raffle.draw_completed 結果事件提供的「觀眾 Twitch ID」。string系統資料範例

event-action / raffle.tickets_awarded

變數說明型別可為空輸入來源範例
{effective_ticket_count}有效籤數:raffle.tickets_awarded 結果事件提供的「有效籤數」。number系統資料10
{odds_percent}中獎機率百分比:raffle.tickets_awarded 結果事件提供的「中獎機率百分比」。number系統資料10
{ticket_count}基礎籤數:raffle.tickets_awarded 結果事件提供的「基礎籤數」。number系統資料10
{tickets_awarded}本次發籤數:raffle.tickets_awarded 結果事件提供的「本次發籤數」。number系統資料10
{total_effective_tickets}總有效籤數:raffle.tickets_awarded 結果事件提供的「總有效籤數」。number系統資料10
{viewer}觀眾顯示名稱:raffle.tickets_awarded 結果事件提供的「觀眾顯示名稱」。string使用者輸入範例
{viewer_login}觀眾 Twitch ID:raffle.tickets_awarded 結果事件提供的「觀眾 Twitch ID」。string系統資料範例

event-action / video_queue.enqueue_failed

變數說明型別可為空輸入來源範例
{duration_seconds}影片秒數:video_queue.enqueue_failed 結果事件提供的「影片秒數」。number系統資料10
{input}輸入內容:video_queue.enqueue_failed 結果事件提供的「輸入內容」。string使用者輸入範例
{max_duration_minutes}允許的最長分鐘數:video_queue.enqueue_failed 結果事件提供的「允許的最長分鐘數」。number系統資料10
{reason}失敗原因代碼:video_queue.enqueue_failed 結果事件提供的「失敗原因代碼」。string系統資料範例
{reason_message}失敗原因:video_queue.enqueue_failed 結果事件提供的「失敗原因」。string系統資料範例
{requester_login}點播者 Twitch ID:video_queue.enqueue_failed 結果事件提供的「點播者 Twitch ID」。string系統資料範例
{requester_name}點播者顯示名稱:video_queue.enqueue_failed 結果事件提供的「點播者顯示名稱」。string使用者輸入範例

event-action / video_queue.item_queued

變數說明型別可為空輸入來源範例
{duration_seconds}影片秒數:video_queue.item_queued 結果事件提供的「影片秒數」。number系統資料10
{queue_position}佇列順位:video_queue.item_queued 結果事件提供的「佇列順位」。number系統資料10
{requester_login}點播者 Twitch ID:video_queue.item_queued 結果事件提供的「點播者 Twitch ID」。string系統資料範例
{requester_name}點播者顯示名稱:video_queue.item_queued 結果事件提供的「點播者顯示名稱」。string使用者輸入範例
{source}觸發來源:video_queue.item_queued 結果事件提供的「觸發來源」。string系統資料範例
{title}標題:video_queue.item_queued 結果事件提供的「標題」。string系統資料範例
{url}影片網址:video_queue.item_queued 結果事件提供的「影片網址」。string系統資料範例

event-action / wheel.spin_completed

變數說明型別可為空輸入來源範例
{amount}金額:wheel.spin_completed 結果事件提供的「金額」。number系統資料10
{gift_count}贈訂數量:wheel.spin_completed 結果事件提供的「贈訂數量」。number系統資料10
{prize}獎項:wheel.spin_completed 結果事件提供的「獎項」。string系統資料範例
{source}觸發來源:wheel.spin_completed 結果事件提供的「觸發來源」。string系統資料範例
{user}觸發使用者:wheel.spin_completed 結果事件提供的「觸發使用者」。string使用者輸入範例

event-template / bits

變數說明型別可為空輸入來源範例
{bits}Bits 數量:這次 Cheer 的 Bits 數量。number系統資料100
{broadcaster}實況主顯示名稱:事件所屬頻道的 Twitch 顯示名稱。string系統資料only26k
{broadcaster_login}實況主 Twitch ID:事件所屬頻道的 Twitch login。string系統資料only26k
{message}Bits 留言:觀眾 Cheer 時輸入的留言。string使用者輸入加油!
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / first_chat

變數說明型別可為空輸入來源範例
{broadcaster}實況主顯示名稱:事件所屬頻道的 Twitch 顯示名稱。string系統資料only26k
{broadcaster_login}實況主 Twitch ID:事件所屬頻道的 Twitch login。string系統資料only26k
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / follow

變數說明型別可為空輸入來源範例
{broadcaster}實況主顯示名稱:事件所屬頻道的 Twitch 顯示名稱。string系統資料only26k
{broadcaster_login}實況主 Twitch ID:事件所屬頻道的 Twitch login。string系統資料only26k
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / raid_cancelled

變數說明型別可為空輸入來源範例
{target}取消揪團目標:被取消的揪團目標顯示名稱。string系統資料target_channel
{target_login}取消揪團目標 Twitch ID:被取消的揪團目標 login。string系統資料target_channel
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / raid_started

變數說明型別可為空輸入來源範例
{target}揪團目標顯示名稱:準備揪團的目標頻道名稱。string系統資料target_channel
{target_login}揪團目標 Twitch ID:準備揪團的目標 login。string系統資料target_channel
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / raid

變數說明型別可為空輸入來源範例
{broadcaster}實況主顯示名稱:事件所屬頻道的 Twitch 顯示名稱。string系統資料only26k
{broadcaster_login}實況主 Twitch ID:事件所屬頻道的 Twitch login。string系統資料only26k
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26
{viewers}揪團人數:揪團帶來的觀眾人數。number系統資料42

event-template / stream_offline

變數說明型別可為空輸入來源範例
{broadcaster}實況主顯示名稱:關台頻道的 Twitch 顯示名稱。string系統資料only26k
{broadcaster_login}實況主 Twitch ID:關台頻道的 Twitch login。string系統資料only26k

event-template / stream_online

變數說明型別可為空輸入來源範例
{broadcaster}實況主顯示名稱:開台頻道的 Twitch 顯示名稱。string系統資料only26k
{broadcaster_login}實況主 Twitch ID:開台頻道的 Twitch login。string系統資料only26k

event-template / subscription_gift

變數說明型別可為空輸入來源範例
{count}贈訂數量:這次贈送的訂閱數量。number系統資料5
{tier}贈訂等級:贈送訂閱的 Twitch 等級。string系統資料1
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / subscription

變數說明型別可為空輸入來源範例
{cumulative_months}累計訂閱月數:使用者累計訂閱月數。number系統資料12
{message}訂閱留言:觀眾輸入的訂閱留言。string使用者輸入支持頻道!
{tier}訂閱等級:Twitch 訂閱等級。string系統資料1
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

event-template / watch_streak

變數說明型別可為空輸入來源範例
{streak}連續觀看次數:觀眾分享的連續觀看次數。number系統資料7
{user}使用者顯示名稱:觸發事件使用者的 Twitch 顯示名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:觸發事件使用者的 Twitch login。string系統資料viewer26

power-up-redemption

變數說明型別可為空輸入來源範例
{bits}Bits 金額:使用強化道具花費的 Bits。number系統資料100
{message}觀眾輸入內容:使用強化道具時填寫的內容。string使用者輸入大家好
{power_up}強化道具名稱:被使用的自訂強化道具名稱。string系統資料超醒目訊息
{user}使用者顯示名稱:使用強化道具的觀眾名稱。string使用者輸入viewer26
{user_login}使用者 Twitch ID:使用者的 Twitch login。string系統資料viewer26

HannyaStudio 公開使用說明