Get Shared Chat Session
Retrieves the active shared chat session for a Twitch channel.
If Channel is empty, SAMMI uses the default Twitch account. The command saves the active shared chat session object returned by Twitch. If there is no active shared chat session, the saved variable is set to undefined.
This is an Async (Purple) Command, which operates differently from standard commands.
This command returns nothing if there isn't an active shared chat, leaving your variable with the result of
undefined!
| Box Name | Type | Description |
|---|---|---|
| Channel | Twitch Account | Channel name to get shared chat info from. Leave empty to use the default Twitch account. |
| Save Variable As | String | Variable name to save the shared chat session object. |
Response Data:
| Variable Name | Type | Description |
|---|---|---|
| session_id | String | The ID for the shared chat session. |
| host_broadcaster_id | String | The User ID of the host channel. |
| participants | Array | Array of objects for each participant of the shared chat session. |
participants[0-?].broadcaster_id |
String | The User ID of the participant. |
| updated_at | String | The time in Twitch format that the shared chat session was last updated. |
| created_at | String | The time in Twitch format that the shared chat session was created. |
Requires the
user:read:email Twitch scope for the selected channel/account.