Sendbird/viewNumberOfUnreadMessages

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

GET/v3/users/{user_id}/unread_message_count

View number of unread messages

Retrieves a user's total number of unread messages in group channels for the given user_id. The unread count feature is only available for group channels.

Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.

Request

operationId
viewNumberOfUnreadMessages
Server
https://api-{app_id}.sendbird.com
Authentication
apiTokenAuth

Request parameters

user_id

pathstringrequired

User identifier.

user_id_123

custom_types

querystring

custom types field.

custom_types_value

super_mode

querystring

Super channel mode.

super_mode_value

Responses

200

ViewNumberOfUnreadMessagesResponseapplication/json

Request succeeded.

Properties: unread_count

400

SendbirdApiErrorapplication/json

Request parameters are invalid.

Properties: codemessage

401

SendbirdApiErrorapplication/json

Unauthenticated or the API token is invalid.

Properties: codemessage

403

SendbirdApiErrorapplication/json

Access to the resource is forbidden.

Properties: codemessage

404

SendbirdApiErrorapplication/json

The requested resource was not found.

Properties: codemessage

429

SendbirdApiErrorapplication/json

Rate limited; retry later.

Properties: codemessage

500

SendbirdApiErrorapplication/json

Upstream internal error.

Properties: codemessage

{
  "unread_count": 1
}