TwitchApi.Whispers.SendWhisper (TwitchApi v0.1.3) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Send the user a whisper message.

requests:

curl -X POST 'https://api.twitch.tv/helix/whispers?from_user_id=123&to_user_id=456'
-H'Authorization: Bearer kpvy3cjboyptmdkiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfnys0nyan9c87zr6t'
-H'Content-Type: application/json'
-d'{"message":"hello"}'

Example response from twitch api docs:

descriptions:

responses:

Link to this section Summary

Types

The ID of the user sending the whisper. This user must have a verified phone number.

The ID of the user to receive the whisper.

Functions

Description:

NEW Sends a whisper message to the specified user.

Link to this section Types

Specs

from_user_id() :: %{from_user_id: String.t()}

The ID of the user sending the whisper. This user must have a verified phone number.

Specs

to_user_id() :: %{to_user_id: String.t()}

The ID of the user to receive the whisper.

Link to this section Functions

Specs

call(from_user_id() | to_user_id(), body_params()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

NEW Sends a whisper message to the specified user.

Required authentication:

Required authorization:

Requires a user access token that includes the user:manage:whispers scope. The ID in the from_user_id query parameter must match the user ID in the access token.