SEsendbird
User

View number of unread messages

Changed on

View number of unread messages

This action retrieves a user's total number of unread messages in group channels.

Note: The unread count feature is only available for group channels.

https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-number-of-unread-messages#1-get-number-of-unread-messages

user_id
Type: string
Description: Specifies the unique ID of a user.

get/v3/users/{user_id}/unread_message_count

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

user_idstring required

(Required)

Query parameters

custom_typesstring

Specifies a comma-separated string of one or more custom types to filter group channels. URL encoding each type is recommended. If not specified, all channels are returned, regardless of their custom type.

super_modestring

Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are all, super, and nonsuper. (Default: all)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

unread_countinteger

Example response

{
  "unread_count": 0
}

Changes