Reference

Issue Session Token

Generates secure session tokens that allow users to authenticate and access your Sendbird chat application without exposing sensitive credentials. This enables safe user connections to real-time messaging features with automatic token expiration for security.

Revoke All Session Tokens

Invalidates all active sessions for a specific user, forcing them to log back in across all devices and apps. Use this when you need to enforce immediate access control or respond to security concerns.

Add Members To Group Channel

Invite one or more users to join an existing group chat or collaboration channel so they can participate in conversations and share information with team members.

Create Group Channel

Creates a new group messaging channel with selected users, enabling organized team conversations and project-based discussions.

List Group Channels

Retrieve a list of your group channels with optional filtering and pagination to manage team conversations and communication channels. This helps you organize and monitor all active group discussions in one place.

Delete Group Channel

Permanently removes a group channel from your Sendbird workspace, deleting all associated messages, members, and channel data. Use this when you need to clean up inactive channels or remove channels that are no longer needed.

Get Count Preference Of Channel

Retrieves a user's notification count preference for a specific channel to determine how message counts are displayed to that user.

Get User Group Channel Count by Join Status

Retrieves counts of group channels for a user organized by their join status (joined, invited, etc.), helping you understand their engagement with different channel types. This lets you monitor user participation and communication patterns across your community or workspace.

Leave Group Channels

Allows a user to exit one or more group channels they've previously joined, helping manage channel memberships and reduce notification clutter.

List Group Channel Members

Retrieve a complete list of all members in a group channel, useful for understanding who has access to specific conversations and managing group participation.

List Group Channel Operators

Retrieve a list of operators managing a specific group channel to see who has administrative privileges and can moderate conversations.

List Open Channel Operators

Retrieve a list of operators managing a specific open channel, allowing you to see who has administrative control and can moderate conversations in that channel.

List Operators by Custom Channel Type

Retrieves all operators assigned to channels of a specific custom type, helping you manage who has administrative control over your communication channels. Use this to verify permissions, audit access, or identify the right administrator for channel-related tasks.

Register Group Channel Operators

Assign moderation and management permissions to selected members in a group chat channel, allowing them to manage messages and oversee conversations. This elevates trusted team members or community leaders to help maintain order and support other participants.

Register Operators by Custom Channel Type

Grants operator privileges to team members across all channels with a specific custom type, enabling them to moderate conversations, manage users, and control channel settings. This is ideal for assigning moderation responsibilities at scale across similar channel groups.

Register Operators to Open Channel

Assign moderator or operator roles to team members in a Sendbird open channel so they can manage messages, moderate conversations, and handle customer support. This is essential after creating a channel and needing to delegate administrative responsibilities.

Sendbird View Group Channel

Retrieve detailed information about a specific group channel, including members, settings, and metadata to understand the channel's current state and configuration.

Unregister Operators Custom Channel Type

Remove operator privileges from users across all channels of a specific custom type, allowing you to revoke administrative or moderator access in bulk.

Update Count Preference Of Channel

Lets you control whether unread messages in a specific channel count toward a user's total unread message count. This is useful for managing notification importance and reducing information overload from less critical channels.

Update Group Channel

Modify group channel settings including name, cover image, privacy level, and operators to keep your team communication spaces organized and up-to-date.

Send Message

Send text messages, files, or admin notifications to a group channel, enabling you to communicate updates and share information with your team or community in real-time.

Delete Message

Permanently remove a message from a Sendbird group channel when it was sent in error or contains content that shouldn't remain visible to team members.

Mark All User Messages As Read

Clears all unread message notifications for a user across their group channels, helping maintain a clean inbox and accurate message status. This is useful when a user has caught up on conversations and wants to reset their notification count.

Sendbird Get Unread Item Count

Retrieve the total count of unread messages, mentions, and pending invitations for a specific user across all group channels. This helps you display real-time notification badges and keep users informed about what needs their attention.

Sendbird List Group Channel Messages

Retrieve and paginate through messages in a group channel using a specific message as an anchor point. This helps you pull conversation history or find unread messages from a specific point in time.

Sendbird Update Message

Edit messages you've already sent in group channels, allowing you to fix typos, update information, or correct details without deleting the original conversation.

Sendbird View Message

Retrieve and view the full details of a specific message within a group channel, including content, sender information, and metadata.

Ban User from Group Channel

Prevent a specific user from accessing or participating in a group channel by removing their ability to send messages and view content. Use this to enforce community guidelines and maintain a safe communication environment within your group channels.

List Banned Members

Retrieve a list of all users who have been banned from a specific group channel, helping you manage channel access and maintain community standards.

Mute User

Temporarily silence a user in a group channel to prevent them from sending messages for a set period of time. This helps maintain channel focus and manage disruptive conversations without removing the user.

Unban User from Group Channel

Reinstates a previously banned user's access to a group channel, allowing them to participate in conversations again. Use this when you've resolved a conflict or dispute and want to give someone another chance.

Unmute User

Restore a muted user's ability to send messages in a group channel, allowing them to participate in conversations again.

Create Sendbird User

Registers a new user account in Sendbird so they can immediately start participating in channels and sending messages with your team or customers.

Update Sendbird User

Modify user details such as display names, profile images, account status, and custom metadata in your Sendbird communication platform.

Delete Sendbird User

Removes a user from your Sendbird application, with the option to permanently delete their account and associated data. Use this when offboarding team members, removing inactive users, or managing your application's user base.

List Sendbird Users

Retrieve a paginated list of users from your Sendbird application to view user profiles, connection status, and metadata. Use this to manage your user base, search for specific users, and understand your audience engagement.

View User

Retrieve detailed information about a specific user in your Sendbird chat application, such as their profile data, status, and account details. This helps you manage user information and understand who is accessing your communication channels.