This action retrieves the number of group channels a user has joined by their join status. You can use various query parameters to determine the search scope of group channels.
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of a user. |
Optional | Type | Description |
---|---|---|
custom_types | string | Specifies a comma-separated string of one or more custom types to filter the group channels with the corresponding types, to retrieve the number of the user's group channels by join status in the filtered channels. |
hidden_mode | string | Restricts the search scope to group channels that match a specific |
state | string | Determines which join status to use to filter the user's group channels and count the total number. Valid values are the following: |
super_mode | string | Restricts the search scope to Supergroup channels, non-Supergroup channels, or both. Acceptable values are |
If successful, this action returns the number of the group channels by the user's join status in the response body.
Property name | Type | Description |
---|---|---|
group_channel_count | long | The number of the user's group channels by join status. |
In the case of an error, an error object like below is returned. See the error codes section for more details.