Get number of channels with unread messages
This action retrieves the total number of group channels in which a user has unread messages. You can use various query parameters to determine the search scope of group channels.
HTTP request
Parameters
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[] | array of strings | Specifies an array of one or more custom types to filter the group channels with the corresponding types. |
super_mode | string | Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are |
Responses
If successful, this action returns the total number of group channels in which the user has unread messages in the response body.
List of response properties
Property name | Type | Description |
---|---|---|
unread_count | long | The total number of the user's group channels with unread messages. |
Error
In the case of an error, an error object like below is returned. See the error codes section for more details.