TwitchApi.Moderation.CheckAutoModStatus (TwitchApi v0.1.0) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Checks to see if the messages “Hello World!” and “Boooooo!” meets AutoMod requirements.

requests:

curl -X POST 'https://api.twitch.tv/helix/moderation/enforcements/status'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'
-d'{ "data": [

{
  "msg_id": "123",
  "msg_text": "Hello World!",
  "user_id": "23749"
},
{
  "msg_id": "393",
  "msg_text": "Boooooo!",
  "user_id": "23422"
}

] }'

Example response from twitch api docs:

descriptions:

Shows that message ID 123 meets the requirements and message ID 393 does not.

responses:

{"data":[{"msg_id":"123","is_permitted":true},{"msg_id":"393","is_permitted":false}]}

Link to this section Summary

Functions

Description:

Determines whether a string message meets the channel’s AutoMod requirements.

Link to this section Types

Specs

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

Specs

user_info() :: %{user_id: integer() | binary()} | %{user_name: binary()}

Link to this section Functions

Specs

call(broadcaster_id(), user_info()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Determines whether a string message meets the channel’s AutoMod requirements.

Required authentication:

Required authorization:

OAuth token requiredRequired Scope: moderation:read