Skip to main content

chats.users

chats.users allows a user to see which users are present in a specified channel. Users in the channel with recent activity are indicated by an asterisk.

Security level

MIDSEC

Syntax

CLI

chats.users { channel: "example_channel" }

Script

#ms.chats.users({ channel: "example_channel" })

Parameters

channel (required)

The 'channel' argument specifies the channel to be checked.

Note: a user must be in the specified channel in order to see user details of the channel.

Return

Returns an array.

CLI

>>chats.users { channel: "example_channel" }
*<user>
*trust
inactive_user_123

Script

Same as CLI.

Example

function(context, args)
{
return #ms.chats.users({ channel: "example_channel" })
}