Notes
The user sending the whisper must have a verified phone number (see the Phone Number setting in your Security and Privacy settings).
The API may silently drop whispers that it suspects of violating Twitch policies, it will still indicate success even if the message is dropped.
Rate Limits: You may whisper to a maximum of 40 unique recipients per day. Within the per day limit, you may whisper a maximum of 3 whispers per second and a maximum of 100 whispers per minute.
The maximum message lengths are:
- 500 characters if the user you're sending the message to hasn't whispered you before.
- 10,000 characters if the user you're sending the message to has whispered you before.
Messages that exceed the maximum length are truncated.
Variables
The following variables will be populated when this trigger executes:
| Description | ||
|---|---|---|
badgeCount | number | The count of badges this user has Example: 3 |
badges | List<Twitch.Common.Models.Badge> | A C# accessible list of emotes used in the chat message |
isModerator | boolean | Is this user a moderator? Example: true |
isSubscribed | boolean | Is this user subscribed? Example: true |
isVip | boolean | Is this user a VIP? Example: true |
monthsSubscribed | number | The amount of months the user is subscribed Example: 3 |
subscriptionTier | number | The subscription tier (T1 = 1000, T2 = 2000, T3 = 3000) (only available if Example: 3000 |
user | string | The display name of the user Example: TwitchUser123 |
userGroups | string | Comma-delimited list of groups the user is in Example: Awesome Streamers,Discord Peeps,Top Contributors |
userId | string | Unique user identifier Example: 718933593 |
userName | string | The login name of the user Example: twitchuser123 |
userPreviousActive | DateTime | When was this user last active? Example: 8/4/2023 10:56:06 AM |
userType | string | Streaming service of this user Example: twitch |