List banned users in channels by a custom channel type
Retrieves a list of users banned from channels with the specified custom channel type.
The following table lists the parameters that this action supports.
Specifies a custom channel type.
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 1 and 100. (Default: 10)
If successful, this action returns a list of banned user resources 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 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.