Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions streamerbot/3.api/4.servers/1.websocket/0.requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ Fetch information about the connected broadcaster account(s)
"broadcastUserName": "ik1497",
"broadcastUserId": 695682330,
"broadcasterIsAffiliate": false,
"broadcasterIsPartner": false
"broadcasterIsPartner": false,
"botUser": "MyBot",
"botUserName": "mybot",
"botUserId": "682553973"
Expand Down Expand Up @@ -623,7 +623,7 @@ Fetch information about the connected Streamer.bot instance.
::

### `GetActiveViewers`
Fetch a list of all active viewers for connected `Twitch` or `YouTube` accounts.
Fetch a list of all active viewers for connected broadcaster accounts.

::code-group
```json [Schema]
Expand All @@ -638,24 +638,26 @@ Fetch a list of all active viewers for connected `Twitch` or `YouTube` accounts.
"viewers": [
{
"id": "695682330",
"type": "kick",
"login": "ik1497",
"display": "ik1497",
"subscribed": true,
"role": "Broadcaster",
"groups": [],
"channelPointsUsed": 0,
"lastActive": "2022-12-20T01:03:01.4613004+01:00",
"previousActive": "2022-12-20T01:03:01.4613004+01:00",
"exempt": true
},
{
"id": "750146097",
"type": "twitch",
"login": "ik1497bot",
"display": "Ik1497Bot",
"subscribed": false,
"role": "Moderator",
"groups": [],
"groups": ["Friends"],
"channelPointsUsed": 0,
"lastActive": "2022-12-20T01:03:10.5548462+01:00",
"previousActive": "2022-12-20T01:03:10.5548462+01:00",
"exempt": false
}
],
Expand All @@ -671,7 +673,7 @@ Fetch a list of all active viewers for connected `Twitch` or `YouTube` accounts.
::

### `GetCodeTriggers`
Returns the list of (code triggers)[/api/csharp/core/triggers#RegisterCustomTrigger] available to be invoked by (ExecuteCodeTrigger)[#executecodetrigger].
Returns the list of [code triggers](/api/csharp/core/triggers#RegisterCustomTrigger) available to be invoked by [ExecuteCodeTrigger](#executecodetrigger).

::code-group
```json [Schema]
Expand All @@ -683,12 +685,7 @@ Returns the list of (code triggers)[/api/csharp/core/triggers#RegisterCustomTrig
```json [↗️ Request]
{
"request": "GetCodeTriggers",
"id": "my-subscribe-id",
"triggerName": "poll_vote_removed",
"args": {
"stringArg": "abcdef",
"numArg": 1234
}
"id": "my-subscribe-id"
}
```
```json [↙️ Response]
Expand All @@ -712,7 +709,7 @@ Returns the list of (code triggers)[/api/csharp/core/triggers#RegisterCustomTrig
::

### `ExecuteCodeTrigger`
Triggers a (code trigger)[/api/csharp/core/triggers#RegisterCustomTrigger], causing any associated actions to be executed.
Triggers a [code trigger](/api/csharp/core/triggers#RegisterCustomTrigger), causing any associated actions to be executed.

::code-group
```json [Schema]
Expand All @@ -729,6 +726,7 @@ Triggers a (code trigger)[/api/csharp/core/triggers#RegisterCustomTrigger], caus
{
"request": "ExecuteCodeTrigger",
"id": "my-subscribe-id",
"triggerName": "poll_vote_removed",
"args": {
"stringArg": "abcdef",
"numArg": 1234
Expand Down Expand Up @@ -809,7 +807,7 @@ Returns the list of defined commands.
::

### `TwitchGetEmotes`
Fetch a list of emotes for the selected platform
Fetches a list of emotes for Twitch.

::code-group
```json [Schema]
Expand Down Expand Up @@ -880,7 +878,7 @@ Fetch a list of emotes for the selected platform
::

### `YouTubeGetEmotes`
Fetch a list of emotes for the selected platform
Fetches a list of emotes for YouTube.

::code-group
```json [Schema]
Expand Down Expand Up @@ -960,7 +958,7 @@ Returns all the global variables, either persisted or temporary.
```
```json [↙️ Response]
{
"status": "ok"
"status": "ok",
"id": "my-subscribe-id",
"variables": [
"aGlobal": {
Expand Down Expand Up @@ -1077,7 +1075,7 @@ Fetches the values of a given user variable across all Twitch users.
::

### `TwitchGetUserGlobal`
Gets either a single user variable for a given user, or all variables for that users.
Gets either a single user variable for a given user, or all variables for that user.

::code-group
```json [Schema]
Expand Down Expand Up @@ -1209,7 +1207,7 @@ Fetches the pronouns for a given user.
{
"request": "GetUserPronouns",
"id": "my-subscribe-id",
"platform": "twitch"
"platform": "twitch",
"userLogin": "justsomeguyyouknow",
}
```
Expand Down
Loading