List banned participants in an open channel
Retrieves a list of users who are banned from the specified open channel.
The following table lists the parameters that this action supports.
Specifies the URL of a channel.
Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set as 0.
Specifies the number of results to return per page. This value must be between 0 and 100. (Default: 10)
Determines whether to include the number of all users banned from the channel in the response. If set to true, includes the number of all users banned from the channel in the response. (Default: false)
If successful, this action returns a list of banned user resource and ban information in the response body.
List of response properties
array of objects
An array of
The user resource that contains brief information about the banned user.
The timestamp of when the ban starts. The value is in Unix milliseconds format.
The timestamp of when the ban is scheduled to end. The value is in Unix milliseconds format.
The reason for ban.
The count of all users banned from the channel.
The value that can be used in the
In the case of an error, an error object is returned. A detailed list of error codes is available here.