系統變數完整參考

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

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

事件訊息 — 小奇點

變數	說明	型別	可為空	輸入來源	範例
{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

事件訊息 — 今日首次聊天

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

事件訊息 — 分享連續觀看

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

事件訊息 — 取消揪團

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

事件訊息 — 訂閱

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

事件訊息 — 追隨

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

事件訊息 — 停止串流

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

事件訊息 — 揪團

變數	說明	型別	可為空	輸入來源	範例
{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

事件訊息 — 開始串流

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

事件訊息 — 準備揪團

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

事件訊息 — 贈送訂閱

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

自訂指令

變數	說明	型別	可為空	輸入來源	範例
{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

忠誠點數兌換訊息

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

強化道具兌換訊息

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

贊助通知

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

活動轉盤 — 轉盤完成

變數	說明	型別	可為空	輸入來源	範例
{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	否	使用者輸入	範例

黑心轉盤 — 轉盤完成

變數	說明	型別	可為空	輸入來源	範例
{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	否	使用者輸入	範例

抽籤 — 抽籤發籤完成

變數	說明	型別	可為空	輸入來源	範例
{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	否	系統資料	範例

抽籤 — 抽籤完成

變數	說明	型別	可為空	輸入來源	範例
{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	否	系統資料	範例

聊天室抽獎 — 抽獎開始

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

聊天室抽獎 — 抽出中獎者

變數	說明	型別	可為空	輸入來源	範例
{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
{winner_count}	得獎人數：chat-lottery.winner_drawn 結果事件提供的「得獎人數」。	number	否	系統資料	10

推推幣 — 推幣完成

變數	說明	型別	可為空	輸入來源	範例
{blue_coins_fallen}	本次推落藍幣數：coin-pusher.drop.completed 結果事件提供的「本次推落藍幣數」。	number	否	系統資料	10
{coins_fallen}	本次推落幣數：coin-pusher.drop.completed 結果事件提供的「本次推落幣數」。	number	否	系統資料	10
{coins_inserted}	本次投入幣數：coin-pusher.drop.completed 結果事件提供的「本次投入幣數」。	number	否	系統資料	10
{score_gained}	本次獲得分數：coin-pusher.drop.completed 結果事件提供的「本次獲得分數」。	number	否	系統資料	10
{table_coin_count}	目前台面幣數：coin-pusher.drop.completed 結果事件提供的「目前台面幣數」。	number	否	系統資料	10
{total_score}	本期累計分數：coin-pusher.drop.completed 結果事件提供的「本期累計分數」。	number	否	系統資料	10
{viewer}	觀眾顯示名稱：coin-pusher.drop.completed 結果事件提供的「觀眾顯示名稱」。	string	否	使用者輸入	範例
{viewer_login}	觀眾 Twitch ID：coin-pusher.drop.completed 結果事件提供的「觀眾 Twitch ID」。	string	否	系統資料	範例

推推幣 — 推幣分數查詢

變數	說明	型別	可為空	輸入來源	範例
{period_label}	積分範圍名稱：coin-pusher.score_queried 結果事件提供的「積分範圍名稱」。	string	否	系統資料	範例
{rank}	歷史總排名：coin-pusher.score_queried 結果事件提供的「歷史總排名」。	number	否	系統資料	10
{rank_text}	歷史總排名文字：coin-pusher.score_queried 結果事件提供的「歷史總排名文字」。	string	否	系統資料	範例
{total_score}	本期累計分數：coin-pusher.score_queried 結果事件提供的「本期累計分數」。	number	否	系統資料	10
{viewer}	觀眾顯示名稱：coin-pusher.score_queried 結果事件提供的「觀眾顯示名稱」。	string	否	使用者輸入	範例
{viewer_login}	觀眾 Twitch ID：coin-pusher.score_queried 結果事件提供的「觀眾 Twitch ID」。	string	否	系統資料	範例

影片播放 — 公開影片清單指令

變數	說明	型別	可為空	輸入來源	範例
{public_url}	公開影片清單連結：chat.command 結果事件提供的「公開影片清單連結」。	string	否	系統資料	範例
{title}	標題：chat.command 結果事件提供的「標題」。	string	否	系統資料	範例
{url}	影片網址：chat.command 結果事件提供的「影片網址」。	string	否	系統資料	範例

影片播放 — 影片加入隊列

變數	說明	型別	可為空	輸入來源	範例
{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	否	系統資料	範例

影片播放 — 影片點播失敗

變數	說明	型別	可為空	輸入來源	範例
{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	否	使用者輸入	範例

通用進度條 — 進度完成

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

觀眾累積贊助達標

變數	說明	型別	可為空	輸入來源	範例
{contribution_value}	本次增加數值：donation.viewer_accumulated 結果事件提供的「本次增加數值」。	number	否	系統資料	10
{current_total}	累積後數值：donation.viewer_accumulated 結果事件提供的「累積後數值」。	number	否	系統資料	10
{previous_total}	累積前數值：donation.viewer_accumulated 結果事件提供的「累積前數值」。	number	否	系統資料	10
{threshold}	觸發門檻：donation.viewer_accumulated 結果事件提供的「觸發門檻」。	number	否	系統資料	10
{user}	觸發使用者：donation.viewer_accumulated 結果事件提供的「觸發使用者」。	string	否	使用者輸入	範例
{user_login}	觀眾 Twitch login：donation.viewer_accumulated 結果事件提供的「觀眾 Twitch login」。	string	否	系統資料	範例

觀眾累積贈訂達標

變數	說明	型別	可為空	輸入來源	範例
{contribution_value}	本次增加數值：twitch.subscription_gift_viewer_accumulated 結果事件提供的「本次增加數值」。	number	否	系統資料	10
{current_total}	累積後數值：twitch.subscription_gift_viewer_accumulated 結果事件提供的「累積後數值」。	number	否	系統資料	10
{previous_total}	累積前數值：twitch.subscription_gift_viewer_accumulated 結果事件提供的「累積前數值」。	number	否	系統資料	10
{threshold}	觸發門檻：twitch.subscription_gift_viewer_accumulated 結果事件提供的「觸發門檻」。	number	否	系統資料	10
{user}	觸發使用者：twitch.subscription_gift_viewer_accumulated 結果事件提供的「觸發使用者」。	string	否	使用者輸入	範例
{user_login}	觀眾 Twitch login：twitch.subscription_gift_viewer_accumulated 結果事件提供的「觀眾 Twitch login」。	string	否	系統資料	範例

觀眾累積小奇點達標

變數	說明	型別	可為空	輸入來源	範例
{contribution_value}	本次增加數值：twitch.bits_viewer_accumulated 結果事件提供的「本次增加數值」。	number	否	系統資料	10
{current_total}	累積後數值：twitch.bits_viewer_accumulated 結果事件提供的「累積後數值」。	number	否	系統資料	10
{previous_total}	累積前數值：twitch.bits_viewer_accumulated 結果事件提供的「累積前數值」。	number	否	系統資料	10
{threshold}	觸發門檻：twitch.bits_viewer_accumulated 結果事件提供的「觸發門檻」。	number	否	系統資料	10
{user}	觸發使用者：twitch.bits_viewer_accumulated 結果事件提供的「觸發使用者」。	string	否	使用者輸入	範例
{user_login}	觀眾 Twitch login：twitch.bits_viewer_accumulated 結果事件提供的「觀眾 Twitch login」。	string	否	系統資料	範例

簽到月曆 — 簽到完成

變數	說明	型別	可為空	輸入來源	範例
{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	否	系統資料	範例