TwitchApi.Chat.SendChatAnnouncement (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
Sends an announcement to the broadcaster’s chat room.
requests:
curl -X POST 'https://api.twitch.tv/helix/chat/announcements?broadcaster_id=11111&moderator_id=44444'
-H'Authorization: Bearer kpvy3cjboyptmdkiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfnys0nyan9c87zr6t'
-H'Content-Type: application/json'
-d'{"message":"Hello chat!","color":"purple"}'
Example response from twitch api docs:
descriptions:
responses:
Link to this section Summary
Types
The ID of the broadcaster that owns the chat room to send the announcement to.
The ID of a user who has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the OAuth token, which can be a moderator or the broadcaster.
Functions
Description:
NEW Sends an announcement to the broadcaster’s chat room.
Link to this section Types
Specs
broadcaster_id() :: %{broadcaster_id: String.t()}
The ID of the broadcaster that owns the chat room to send the announcement to.
Specs
moderator_id() :: %{moderator_id: String.t()}
The ID of a user who has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the OAuth token, which can be a moderator or the broadcaster.
Link to this section Functions
Specs
call(broadcaster_id() | moderator_id(), body_params()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
NEW Sends an announcement to the broadcaster’s chat room.
Required authentication:
Required authorization:
Requires a user access token that includes the moderator:manage:announcements scope. The ID in the moderator_id query parameter must match the user ID in the access token.