List participants of an open channel
Retrieves a list of participants of an open channel. A participant is a user who has entered an open channel and is currently online.
Note: See this page to learn more about channel types.
HTTP request
Parameters
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
channel_url | string | Specifies the URL of the channel. |
Optional | Type | Description |
---|---|---|
token | string | Specifies a page token that indicates the starting index of a chunk of results to retrieve. If not specified, the index is set as 0. |
limit | int | Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10) |
Response
If successful, this action returns a list of user resources that are participating in the open channel in the response body.
List of response properties
Property name | Type | Description |
---|---|---|
participants[] | array of objects | An array of user objects that are participating in the open channel. |
next | string | The value for the |
In the case of an error, an error object is returned. A detailed list of error codes is available here.