Sendbird

Sendbird integration (Communication, Developer Tools). Imported from open-connector.

API key27 toolshttps://api-{application_id}.sendbird.com/v3

GET

sendbird_list_users

List Sendbird users with common pagination and filtering controls.

/users

13 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of results to return.
token	string	optional	The pagination token returned by the previous response.
order	string	optional	The result ordering returned by Sendbird.
user_ids	array	optional	A list of non-empty strings.
nickname	string	optional	Filter by an exact nickname match.
nickname_contains	string	optional	Filter by a nickname substring match.
nickname_startswith	string	optional	Filter by a nickname prefix supported by the official API.
active_mode	string	optional	The official active-mode filter.
show_bot	boolean	optional	Whether to include bot users in the results.
metadatakey	string	optional	The official metadata key filter.
metadatavalues_in	array	optional	A list of non-empty strings.
custom_type	string	optional	Filter by the user custom type when supported by Sendbird.
has_ever_logged_in	boolean	optional	Filter by whether the user has logged in when supported by Sendbird.

GET

sendbird_view_user

Get a single Sendbird user by user ID.

/users/{user_id}

1 parameter

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.

POST

sendbird_create_user

Create a Sendbird user with common profile and metadata fields.

/users

10 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
nickname	string	optional	The nickname to assign to the new user.
profile_url	string	optional	The URL of the user's profile image.
metadata	object	optional	A metadata object whose keys and values are strings.
issue_access_token	boolean	optional	Whether Sendbird should issue an access token for the user.
discovery_keys	array	optional	A list of non-empty strings.
preferred_languages	array	optional	A list of non-empty strings.
is_active	boolean	optional	Whether the user should be active.
phone_number	string	optional	The phone number to store for the user.
has_ever_logged_in	boolean	optional	Whether the user has logged in before when supported by Sendbird.

PUT

sendbird_update_user

Update a Sendbird user's profile, metadata, or activation settings.

/users/{user_id}

9 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
nickname	string	optional	The new nickname for the user.
profile_url	string	optional	The new profile image URL.
metadata	object	optional	A metadata object whose keys and values are strings.
issue_access_token	boolean	optional	Whether Sendbird should issue a new access token for the user.
preferred_languages	array	optional	A list of non-empty strings.
is_active	boolean	optional	Whether the user should remain active.
phone_number	string	optional	The phone number to store for the user.
has_ever_logged_in	boolean	optional	Whether the user has logged in before when supported by Sendbird.

DELETE

sendbird_delete_user

Delete a Sendbird user.

/users/{user_id}

2 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
hard_delete	boolean	optional	Whether to permanently delete the user and related data.

POST

sendbird_issue_session_token

Issue a Sendbird session token for a user.

/users/{user_id}/token

2 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
expires_at	integer	optional	A Unix timestamp in milliseconds.

DELETE

sendbird_revoke_all_session_tokens

Revoke all Sendbird session tokens for a user.

/users/{user_id}/token

1 parameter

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.

GET

sendbird_get_number_of_unread_items

Get unread message, mention, and invitation counts for a Sendbird user.

/users/{user_id}/unread_item_count

3 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
item_keys	string	optional	The unread item keys to retrieve.
custom_types	string	optional	The custom channel types to filter the counts by.

PUT

sendbird_mark_all_user_messages_as_read

Mark all messages as read for a Sendbird user.

/users/{user_id}/mark_as_read_all

2 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
channel_urls	array	optional	A list of non-empty strings.

PUT

sendbird_leave_group_channels

Make a Sendbird user leave one or more joined group channels.

/users/{user_id}/my_group_channels/leave

4 parameters

Param	Type	Required	Description
user_id	string	required	The Sendbird user ID.
should_leave_all	boolean	optional	Whether the user should leave all joined group channels.
channel_urls	array	optional	A list of non-empty strings.
custom_type	string	optional	Restrict the leave operation to channels with this custom type.

GET

sendbird_list_group_channels

List Sendbird group channels in the application with common filtering controls.

/group_channels

24 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of results to return.
token	string	optional	The pagination token returned by the previous response.
name	string	optional	Filter by an exact channel name.
show_empty	boolean	optional	Whether to include empty channels.
show_frozen	boolean	optional	Whether to include frozen channels.
show_metadata	boolean	optional	Whether to include channel metadata.
show_member	boolean	optional	Whether to include channel members.
show_read_receipt	boolean	optional	Whether to include read receipts.
show_delivery_receipt	boolean	optional	Whether to include delivery receipts.
show_hidden	boolean	optional	Whether to include hidden channels.
show_member_info	boolean	optional	Whether to include detailed member information when supported by Sendbird.
super_mode	string	optional	Filter by whether the channel is a supergroup.
public_mode	string	optional	Filter by whether the channel is public.
distinct_mode	string	optional	Filter by whether the channel is distinct.
hidden_mode	string	optional	The hidden-mode filter supported by Sendbird.
custom_types	array	optional	A list of non-empty strings.
channel_urls	array	optional	A list of non-empty strings.
members_include_in	array	optional	A list of non-empty strings.
members_exactly_in	array	optional	A list of non-empty strings.
members_nickname	string	optional	Filter channels by a member nickname match.
url_contains	string	optional	Filter by a substring of the channel URL.
created_after	integer	optional	A Unix timestamp in milliseconds.
created_before	integer	optional	A Unix timestamp in milliseconds.
my_member_state	string	optional	Filter by the member state reported by Sendbird.

GET

sendbird_view_group_channel

Get a Sendbird group channel by channel URL.

/group_channels/{channel_url}

6 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
show_member	boolean	optional	Whether to include the member list.
show_metadata	boolean	optional	Whether to include channel metadata.
show_read_receipt	boolean	optional	Whether to include read receipt data.
show_delivery_receipt	boolean	optional	Whether to include delivery receipt data.
show_migration_info	boolean	optional	Whether to include migration information when available.

POST

sendbird_create_channel

Create a Sendbird group channel with common JSON body fields.

/group_channels

15 parameters

Param	Type	Required	Description
name	string	optional	The channel name.
channel_url	string	optional	The custom channel URL to create.
user_ids	array	optional	A list of non-empty strings.
operator_ids	array	optional	A list of non-empty strings.
cover_url	string	optional	The cover image URL to assign to the channel.
custom_type	string	optional	The custom type to assign to the channel.
data	string	optional	The custom data payload to store for the channel.
is_distinct	boolean	optional	Whether the channel should be distinct.
is_public	boolean	optional	Whether the channel should be public.
is_super	boolean	optional	Whether the channel should be a supergroup.
is_ephemeral	boolean	optional	Whether the channel should be ephemeral.
is_discoverable	boolean	optional	Whether the channel should be discoverable when supported by Sendbird.
access_code	string	optional	The access code for a private public channel.
strict	boolean	optional	Whether Sendbird should fail if a matching channel already exists.
message_survival_seconds	integer	optional	The message survival duration in seconds when supported by Sendbird.

PUT

sendbird_update_group_channel

Update a Sendbird group channel with common JSON body fields.

/group_channels/{channel_url}

12 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
name	string	optional	The new channel name.
cover_url	string	optional	The new cover image URL.
custom_type	string	optional	The custom type to assign to the channel.
data	string	optional	The custom data payload to store for the channel.
operators	array	optional	A list of non-empty strings.
is_distinct	boolean	optional	Whether the channel should be distinct.
is_public	boolean	optional	Whether the channel should be public.
is_super	boolean	optional	Whether the channel should be a supergroup.
is_ephemeral	boolean	optional	Whether the channel should be ephemeral.
access_code	string	optional	The access code to assign to the channel.
my_count_preference	string	optional	The count preference to store when supported by Sendbird.

DELETE

sendbird_delete_channel

Delete a Sendbird group channel.

/group_channels/{channel_url}

1 parameter

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.

GET

sendbird_list_members_group_channel

List members of a Sendbird group channel.

/group_channels/{channel_url}/members

9 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
limit	integer	optional	The maximum number of results to return.
token	string	optional	The pagination token returned by the previous response.
offset	integer	optional	The deprecated offset-based pagination value.
order	string	optional	The ordering of the returned members.
operator_filter	string	optional	Filter by operator status.
member_state_filter	string	optional	Filter by membership state.
muted_member_filter	string	optional	Filter by whether the member is muted.
nickname_startswith	string	optional	Filter by a member nickname prefix.

POST

sendbird_add_members_group_channel

Invite members into an existing Sendbird group channel.

/group_channels/{channel_url}/invite

4 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
user_ids	array	required	A list of non-empty strings.
hide_existing_messages	boolean	optional	Whether to hide previous messages from the invited users.
seconds	integer	optional	The hide-existing-messages duration in seconds when required by Sendbird.

GET

sendbird_list_group_channel_messages

List messages from a Sendbird group channel around a timestamp or message anchor.

/group_channels/{channel_url}/messages

19 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
message_id	integer	optional	The numeric identifier of the Sendbird message.
message_ts	integer	optional	A Unix timestamp in milliseconds.
prev_limit	integer	optional	The number of messages to return before the anchor.
next_limit	integer	optional	The number of messages to return after the anchor.
include	boolean	optional	Whether to include the anchor message.
reverse	boolean	optional	Whether to reverse the result ordering.
sender_id	string	optional	Restrict results to a single sender ID.
sender_ids	string	optional	Restrict results to the provided sender IDs.
message_type	string	optional	Restrict results to the provided Sendbird message types.
custom_types	string	optional	Restrict results to the provided custom message types.
operator_filter	string	optional	Filter by whether the sender is an operator.
include_reactions	boolean	optional	Whether to include reaction information.
including_removed	boolean	optional	Whether to include removed messages.
include_reply_type	string	optional	The reply-type filter supported by Sendbird.
include_thread_info	boolean	optional	Whether to include thread information.
include_poll_details	boolean	optional	Whether to include poll details.
include_parent_message_info	boolean	optional	Whether to include parent message information.
with_sorted_metaarray	boolean	optional	Whether to include sorted metaarray values.

GET

sendbird_view_message

Get a single Sendbird group channel message by message ID.

/group_channels/{channel_url}/messages/{message_id}

3 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
message_id	integer	required	The numeric identifier of the Sendbird message.
with_sorted_metaarray	boolean	optional	Whether to include sorted metaarray values.

POST

sendbird_send_message

Send a message into a Sendbird group channel.

/group_channels/{channel_url}/messages

14 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
message_type	string	required	The Sendbird message type to create.
message	string	optional	The message text content.
user_id	string	optional	The acting Sendbird user ID.
data	string	optional	The custom data payload for the message.
custom_type	string	optional	The custom type assigned to the message.
mention_type	string	optional	The mention type for the message.
mentioned_user_ids	array	optional	A list of non-empty strings.
parent_message_id	integer	optional	The parent message ID when creating a thread reply.
is_silent	boolean	optional	Whether the message should be silent.
is_operator_message	boolean	optional	Whether the message should be marked as an operator message.
push_notification_delivery_option	string	optional	The push notification delivery option to use.
translation_target_languages	array	optional	A list of non-empty strings.
metaarray	array	optional	The metadata entries to store for the message.

PUT

sendbird_update_message

Update an existing Sendbird group channel message.

/group_channels/{channel_url}/messages/{message_id}

11 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
message_id	integer	required	The numeric identifier of the Sendbird message.
message	string	optional	The updated message text content.
data	string	optional	The updated custom data payload.
user_id	string	optional	The acting Sendbird user ID.
custom_type	string	optional	The updated custom type.
mention_type	string	optional	The updated mention type.
mentioned_user_ids	array	optional	A list of non-empty strings.
is_silent	boolean	optional	Whether the update should be silent.
push_notification_delivery_option	string	optional	The push notification delivery option to use.
sorted_metaarray	array	optional	The sorted metaarray payload to store for the message.

DELETE

sendbird_delete_message

Delete a Sendbird group channel message.

/group_channels/{channel_url}/messages/{message_id}

2 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
message_id	integer	required	The numeric identifier of the Sendbird message.

GET

sendbird_list_banned_members

List banned users from a Sendbird group channel.

/group_channels/{channel_url}/ban

3 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
limit	integer	optional	The maximum number of results to return.
token	string	optional	The pagination token returned by the previous response.

POST

sendbird_ban_user_from_group_channel

Ban a user from a Sendbird group channel.

/group_channels/{channel_url}/ban

5 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
user_id	string	required	The Sendbird user ID.
seconds	integer	optional	The ban duration in seconds. Omit for a permanent ban.
description	string	optional	The moderation reason to record.
agent_id	string	optional	The moderator ID performing the action.

DELETE

sendbird_unban_user

Unban a user from a Sendbird group channel.

/group_channels/{channel_url}/ban/{banned_user_id}

2 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
banned_user_id	string	required	The banned user ID to unban from the channel.

POST

sendbird_mute_user

Mute a user in a Sendbird group channel.

/group_channels/{channel_url}/mute

4 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
user_id	string	required	The Sendbird user ID.
seconds	integer	optional	The mute duration in seconds. Use 0 for an indefinite mute when supported by Se…
description	string	optional	The moderation reason to record.

DELETE

sendbird_unmute_user

Unmute a user in a Sendbird group channel.

/group_channels/{channel_url}/mute/{muted_user_id}

2 parameters

Param	Type	Required	Description
channel_url	string	required	The unique URL of the target group channel.
muted_user_id	string	required	The muted user ID to unmute from the channel.