Available on crate feature
helix only.Expand description
Helix endpoints regarding chat
§Implemented endpoints
Chat 🟢 19/19
Modules§
- get_
channel_ chat_ badges - Gets a list of custom chat badges that can be used in chat for the specified channel. This includes subscriber badges and Bit badges.
- get_
channel_ emotes - Gets all custom emotes for a specific Twitch channel including subscriber emotes, Bits tier emotes, and follower emotes.
- get_
chat_ settings - Gets the broadcaster’s chat settings.
get-chat-settings - get_
chatters - Gets the list of users that are connected to the specified broadcaster’s chat session.
get-chatters - get_
emote_ sets - Gets all Twitch emotes for one or more specific emote sets.
get-emote-sets - get_
global_ chat_ badges - Gets a list of chat badges that can be used in chat for any channel.
get-global-chat-badges - get_
global_ emotes - Gets all global emotes. Global emotes are Twitch-specific emoticons that every user can use in Twitch chat.
get-global-emotes - get_
pinned_ chat_ message - Gets the currently pinned message for the broadcaster’s chat room.
get-pinned-chat-message - get_
shared_ chat_ session - Retrieves the active shared chat session for a channel.
get-shared-chat-session - get_
user_ chat_ color - Gets the color used for the user’s name in chat.
get-user-chat-color - get_
user_ emotes - Retrieves emotes available to the user across all channels.
get-user-emotes - pin_
chat_ message - Pins a chat message to the specified broadcaster’s chat room.
pin-chat-message - send_
a_ shoutout - Sends a Shoutout to the specified broadcaster.
send-a-shoutout - send_
chat_ announcement - Sends an announcement to the broadcaster’s chat room.
send-chat-announcement - send_
chat_ message - Sends an message in the broadcaster’s chat room.
send-chat-message - unpin_
chat_ message - Unpins a pinned chat message from the broadcaster’s chat room.
unpin-chat-message - update_
chat_ settings - Updates the broadcaster’s chat settings.
update-chat-settings - update_
pinned_ chat_ message - Updates the duration of a pinned chat message.
update-pinned-chat-message - update_
user_ chat_ color - Updates the color used for the user’s name in chat.
Structs§
- Badge
Set - A set of badges
- Channel
Emote - A chat emote
- Chat
Badge - A chat Badge
- Chat
Message Drop Reason - A drop reason of a sent message.
- Chat
Settings - Chat settings
- Chatter
- Return Values for Get Chatters
- GetChannel
Chat Badges Request - Query Parameters for Get Channel Chat Badges
- GetChannel
Emotes Request - Query Parameters for Get Channel Emotes
- GetChat
Settings Request - Query Parameters for Get Chat Settings
- GetChatters
Request - Query Parameters for Get Chatters
- GetEmote
Sets Request - Query Parameters for Get Channel Emotes
- GetGlobal
Chat Badges Request - Query Parameters for Get Global Chat Badges
- GetGlobal
Emotes Request - Query Parameters for Get Channel Emotes
- GetPinned
Chat Message Request - Query Parameters for Get Pinned Chat Message
- GetShared
Chat Session Request - Query Parameters for Get Shared Chat Session
- GetUser
Chat Color Request - Query Parameters for Get Chatters
- GetUser
Emotes Request - Query Parameters for Get User Emotes
- Global
Emote - A chat emote
- PinChat
Message Request - Query Parameters for Pin Chat Message
- Pinned
Chat Message - Return Values for Get Pinned Chat Message
- SendA
Shoutout Request - Query Parameters for Send A Shoutout
- Send
Chat Announcement Body - Body Parameters for Send Chat Announcement
- Send
Chat Announcement Request - Query Parameters for Send Chat Announcement
- Send
Chat Message Body - Body Parameters for Send Chat message
- Send
Chat Message Request - Query Parameters for Send Chat message
- Send
Chat Message Response - Return Values for Send Chat message
- Shared
Chat Participant - A participant in a shared chat session
- Shared
Chat Session - Return Values for Get Shared Chat Session
- Unpin
Chat Message Request - Query Parameters for Unpin Chat Message
- Update
Chat Settings Body - Body Parameters for Update Chat Settings
- Update
Chat Settings Request - Query Parameters for Update Chat Settings
- Update
Pinned Chat Message Request - Query Parameters for Update Pinned Chat Message
- Update
User Chat Color Request - Query Parameters for Update Chat Settings
- User
Chat Color - Return Values for Get Chatters
- User
Emote - Return Values for Get User Emotes
Enums§
- Announcement
Color eventsuborhelix - Valid colors for announcements
- Chat
Message Drop Code - Code for why a message was dropped.
- PinChat
Message Response - Return Values for Pin Chat Message
- SendA
Shoutout Response - Return Values for Send A Shoutout
- Send
Chat Announcement Response - Return Values for Send Chat Announcement
- Unpin
Chat Message Response - Return Values for Unpin Chat Message
- Update
Pinned Chat Message Response - Return Values for Update Pinned Chat Message
- Update
User Chat Color Response - Return Values for Update Chat Settings