IRC Messages - dmatech1/twitch-bot GitHub Wiki

Introduction

Commands

The official documentation seems to be mostly complete.

Command Description Docs
CLEARCHAT Clears all messages in a channel or all messages from a given user. Command, Tags
CLEARMSG Deletes a single message from chat. Command, Tags
HOSTTARGET Start/stop hosting another channel. Command
NOTICE Notices from the server. Command
RECONNECT Server requesting that the client reconnect. Command
GLOBALUSERSTATE Gives information on the currently logged-in user. Tags
JOIN Joins a channel.
PART Leaves a channel.
PING Requests a PONG from the other side of the connection.
PONG Response to a PING from the other side of the connection.
PRIVMSG Sends a message to a channel. Tags
ROOMSTATE Communicates channel settings like slow mode. Command, Tags
USERNOTICE User events in a channel (including raids and subscriptions). Command, Tags
USERSTATE User state data in a channel (including color, badges, and allowed emotes). Command, Tags

CLEARCHAT

CLEARMSG

HOSTTARGET

NOTICE

RECONNECT

GLOBALUSERSTATE

JOIN

Joins a channel (see RFC-2812 for details).

Sample request:

<< JOIN #dmatech

Sample response:

>> :[email protected] JOIN #dmatech

PART

PING

Requests a PONG response from the other side of the connection. See RFC-2812 for more information.

PONG

PRIVMSG

ROOMSTATE

USERNOTICE

This message can be used for a variety of events. Each event has a set of applicable tags.

msg-id Message
anongiftpaidupgrade display-name is continuing the Gift Sub they got from an anonymous user!
bitsbadgetier
communitypayforward display-name is paying forward the Gift they got from msg-param-prior-gifter-display-name to the community!
giftpaidupgrade display-name is continuing the Gift Sub they got from msg-param-sender-name!
highlighted-message
primecommunitygiftreceived
primepaidupgrade display-name converted from a Prime sub to a Tier 1 sub!
raid msg-param-viewerCount raiders from msg-param-displayName have joined!
resub display-name subscribed with msg-param-sub-plan. They've subscribed for msg-param-cumulative-months months!

display-name subscribed with msg-param-sub-plan. They've subscribed for msg-param-cumulative-months months, currently on a msg-param-streak-months month streak!
rewardgift display-name's Gift shared rewards to msg-param-selected-count others in Chat!

display-name's Cheer shared rewards to msg-param-selected-count others in Chat!
ritual @display-name is new here. Say hello!
skip-subs-mode-message
standardpayforward
sub
subgift display-name gifted a Tier 1 sub to msg-param-recipient-user-name! They have given msg-param-sender-count Gift Subs in the channel!

display-name gifted msg-param-gift-months months of Tier 1 to msg-param-recipient-display-name. They've gifted msg-param-sender-count months in the channel!
submysterygift display-name is gifting msg-param-mass-gift-count Tier 1 Subs to dmatech's community! They've gifted a total of msg-param-sender-count in the channel!
unraid The raid has been canceled.

USERSTATE

Tags

Tag Name                                                 Description
badge-info Metadata related to the chat badges in the badges tag.
Currently this is used only for subscriber, to indicate the exact number of months the user has been a subscriber. This number is finer grained than the version number in badges. For example, a user who has been a subscriber for 45 months would have a badge-info value of 45 but might have a badges version number for only 3 years.
badges Comma-separated list of chat badges and the version of each badge (each in the format <badge>/<version>, such as admin/1). There are many valid badge values; e.g., admin, bits, broadcaster, global_mod, moderator, subscriber, staff, turbo. Many badges have only 1 version, but some badges have different versions (images), depending on how long you hold the badge status; e.g., subscriber.
ban-duration
bits
client-nonce
color Hexadecimal RGB color code; the empty string if it is never set.
custom-reward-id
display-name
emote-only Emote-only mode. If enabled, only emotes are allowed in chat. Valid values: 0 (disabled) or 1 (enabled).
emote-sets
emotes
flags
followers-only Followers-only mode. If enabled, controls which followers can chat. Valid values: -1 (disabled), 0 (all followers can chat), or a non-negative integer (only users following for at least the specified number of minutes can chat).
id
login
mod 1 if the user has a moderator badge; otherwise, 0.
msg-id
msg-param-anon-gift
msg-param-cumulative-months sub, resub: The total number of months the user has subscribed. This is the same as msg-param-months but sent for different types of user notices.
msg-param-displayName raid: The display name of the source user raiding this channel.
msg-param-fun-string
msg-param-gift-month-being-redeemed
msg-param-gift-months
msg-param-gifter-id
msg-param-gifter-login
msg-param-gifter-name
msg-param-login
msg-param-mass-gift-count
msg-param-months subgift, anonsubgift: The total number of months the user has subscribed. This is the same as msg-param-cumulative-months but sent for different types of user notices.
msg-param-multimonth-duration
msg-param-multimonth-tenure
msg-param-origin-id
msg-param-prior-gifter-anonymous
msg-param-prior-gifter-display-name
msg-param-prior-gifter-id
msg-param-prior-gifter-user-name
msg-param-profileImageURL
msg-param-recipient-display-name
msg-param-recipient-id
msg-param-recipient-user-name
msg-param-ritual-name ritual: The name of the ritual this notice is for. Valid value: new_chatter.
msg-param-sender-count
msg-param-sender-login
msg-param-sender-name
msg-param-should-share-streak
msg-param-streak-months
msg-param-sub-plan
msg-param-sub-plan-name
msg-param-threshold
msg-param-viewerCount raid: The number of viewers watching the source channel raiding this channel.
msg-param-was-gifted
r9k R9K mode. If enabled, messages with more than 9 characters must be unique. Valid values: 0 (disabled) or 1 (enabled).
reply-parent-display-name
reply-parent-msg-body
reply-parent-msg-id
reply-parent-user-id
reply-parent-user-login
rituals
room-id
slow The number of seconds a chatter without moderator privileges must wait between sending messages.
subs-only Subscribers-only mode. If enabled, only subscribers and moderators can chat. Valid values: 0 (disabled) or 1 (enabled).
subscriber
system-msg The message printed in chat along with this notice.
target-msg-id
target-user-id
tmi-sent-ts Timestamp when the server received the message.
turbo Deprecated, use badges. 1 if the user has a Turbo badge; otherwise, 0.
user-id
user-type Deprecated, use badges. The user’s type. Valid values: mod, global_mod, admin, staff. If the broadcaster is not any of these user types, this field is left empty.
⚠️ **GitHub.com Fallback** ⚠️