Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    User

    Get number of channels with unread messages

    Copy link

    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

    Copy link
    GET https://api-{application_id}.sendbird.com/v3/users/{user_id}/unread_channel_count

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    user_id

    string

    Specifies the unique ID of a user.

    OptionalTypeDescription

    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 all, super, and nonsuper. (Default: all)

    Responses

    Copy link

    If successful, this action returns the total number of group channels in which the user has unread messages in the response body.

    {
    "unread_count": 4
}

    List of response properties

    Copy link
    Property nameTypeDescription

    unread_count

    long

    The total number of the user's group channels with unread messages.

    Error

    Copy link

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
    "message": "\"User\" not found.",
    "code": 400201,
    "error": true
}