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 | ||
---|---|---|
bits | number | The amount of bits donated Example: 200 |
color | string | Hex value of the user's chat color Example: #e5e5e5 |
colorB | string | The blue in RGB of the user's chat color Example: 229 |
colorG | string | The green in RGB of the user's chat color Example: 229 |
colorR | string | The red in RGB of the user's chat color Example: 229 |
emoteCount | number | Number of emotes in the chat message |
emotes | List<Twitch.Common.Models.Emote> | A C# accessible list of emotes used in the chat message |
firstMessage | boolean | Is this user a first time chatter? Example: true |
isAction | boolean | Is this message a Example: true |
isHighlight | boolean | Is this message a Twitch Highlight? Example: true |
isReply | boolean | Is this message a reply? Example: true |
message | string | Text content of the chat message Example: Hello! |
messageCheermotesStripped | string | The chat message with cheer emotes stripped. Example: Hello! |
messageStripped | string | The chat message with emotes stripped Example: Hello! |
msgId | string | Twitch's message identifier Example: a126e8a8-43f7-4a14-8990-e8c3feea76d8 |
reply.msgBody | string | The text content of the reply, Spaces are replaced by Example: My\schat\smessage |
reply.msgId | string | The message id of the reply Example: a126e8a8-43f7-4a14-8990-e8c3feea76d8 |
reply.threadMsgId | string | The message id of the thread Example: a126e8a8-43f7-4a14-8990-e8c3feea76d8 |
reply.threadUserLogin | string | The user login name of the thread Example: twitchuser123 |
reply.userId | string | The user id from the user who sent the reply Example: 718933593 |
reply.userLogin | string | The user login from the user who sent the reply Example: twitchuser123 |
reply.userName | string | The user name from the user who sent the reply Example: TwitchUser123 |
role | number | The role of the user Example: 1 |