helix/io.github.captnblubber.twitchkt.helix.resource/WhisperResource/send

send

suspend fun send(fromUserId: String, toUserId: String, message: String)

Sends a whisper message to the specified user.

NOTE: The user sending the whisper must have a verified phone number.

NOTE: The API may silently drop whispers that it suspects of violating Twitch policies. (The API does not indicate that it dropped the whisper; it returns a 204 status code as if it succeeded.)

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.

Parameters

fromUserId

the ID of the user sending the whisper. This user must have a verified phone number. This ID must match the user ID in the user access token.

toUserId

the ID of the user to receive the whisper.

message

the whisper message to send. The message must not be empty. The maximum message lengths are: 500 characters if the recipient hasn't whispered you before, 10,000 characters if the recipient has whispered you before. Messages that exceed the maximum length are truncated.