Get Chatters
Gets a list of users that are connected to the broadcaster’s chat session.
This is an Async (Purple) Command, which operates differently from standard commands.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to get chatters of |
| Save Variable As | String | Variable to save the result |
Saved Payload:
| Variable Name | Type | Description |
|---|---|---|
| total | Number | The total number of users |
| data | Array | Array of objects representing each chatter |
data[0-?] |
Object | contains info for a chatter |
data[0-?].user_id |
String | The user’s ID |
data[0-?].user_login |
String | The user’s login name |
data[0-?].user_name |
String | The user’s display name |
| pagination | Object | Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through. |
| pagination.cursor | String | The cursor used to get the next page of results with Twitch API Call. |
Twitch API Endpoint: GET /helix/chat/chatters
Example SAMMI Response Object:
{
"total": 523,
"data": [
{
"user_id": "55555555",
"user_login": "activechatter",
"user_name": "ActiveChatter"
},
{
"user_id": "66666666",
"user_login": "lurker42",
"user_name": "Lurker42"
}
],
"pagination": {
"cursor": "eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6MTAwMH19"
}
}