Skip to main content
Server path: /sendbird | Type: Application | PCID required: Yes

Tools

ToolDescription
sendbird_ban_from_group_channelBan a user from a group channel
sendbird_block_userBlock a user
sendbird_create_group_channelCreate a group channel
sendbird_create_group_channel_metadataCreate group channel metadata
sendbird_create_open_channelCreate an open channel
sendbird_create_userCreate a user
sendbird_create_user_metadataCreate user metadata
sendbird_delete_group_channelDelete a group channel
sendbird_delete_group_channel_messageDelete a message in a group channel
sendbird_delete_open_channelDelete an open channel
sendbird_delete_userDelete a user
sendbird_freeze_group_channelFreeze a group channel
sendbird_get_application_settingsView application settings
sendbird_get_group_channelView a group channel
sendbird_get_group_channel_messageView a message in a group channel
sendbird_get_group_channel_metadataView group channel metadata
sendbird_get_open_channelView an open channel
sendbird_get_userView a user
sendbird_get_user_metadataView user metadata
sendbird_get_user_push_preferencesView push notification preferences
sendbird_get_user_unread_countGet user’s unread message count
sendbird_invite_to_group_channelInvite users to a group channel
sendbird_leave_group_channelLeave a group channel
sendbird_list_blocked_usersList blocked users
sendbird_list_group_channel_banned_usersList banned users in a group channel
sendbird_list_group_channel_membersList group channel members
sendbird_list_group_channel_messagesList messages in a group channel
sendbird_list_group_channel_muted_usersList muted users in a group channel
sendbird_list_group_channelsList group channels
sendbird_list_open_channel_messagesList messages in an open channel
sendbird_list_open_channelsList open channels
sendbird_list_user_group_channelsList user’s group channels
sendbird_list_usersList users
sendbird_mute_in_group_channelMute a user in a group channel
sendbird_send_group_channel_messageSend a message to a group channel
sendbird_send_open_channel_messageSend a message to an open channel
sendbird_unban_from_group_channelUnban a user from a group channel
sendbird_unblock_userUnblock a user
sendbird_unmute_in_group_channelUnmute a user in a group channel
sendbird_update_group_channelUpdate a group channel
sendbird_update_group_channel_messageUpdate a message in a group channel
sendbird_update_open_channelUpdate an open channel
sendbird_update_userUpdate a user
sendbird_update_user_metadataUpdate user metadata

sendbird_ban_from_group_channel

Ban a user from a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
descriptionstringNoReason for the ban.
secondsintegerNoBan duration in seconds. -1 for permanent.
user_idstringYesThe ID of the user to ban.

sendbird_block_user

Block a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
target_idstringYesThe ID of the user to block.

sendbird_create_group_channel

Create a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringNoCustom channel URL. Auto-generated if not provided.
cover_urlstringNoURL of the channel cover image.
custom_typestringNoCustom channel type for categorization.
datastringNoAdditional data in string format.
invitation_statusobjectNoInvitation status per user.
is_distinctbooleanNoWhether the channel is reused for the same member set.
is_publicbooleanNoWhether the channel is public.
namestringNoChannel name.
operator_idsstring[]NoUser IDs to register as operators.
user_idsstring[]YesUser IDs to add as members.

sendbird_create_group_channel_metadata

Create group channel metadata Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
metadataobjectYesKey-value pairs of metadata.

sendbird_create_open_channel

Create an open channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringNoCustom channel URL.
cover_urlstringNoURL of the channel cover image.
custom_typestringNoCustom channel type.
datastringNoAdditional data.
namestringNoChannel name.
operator_idsstring[]NoOperator user IDs.

sendbird_create_user

Create a user Parameters:
ParameterTypeRequiredDefaultDescription
issue_access_tokenbooleanNoWhether to create an access token for the user.
metadataobjectNoKey-value metadata for the user.
nicknamestringNoUser’s nickname.
profile_urlstringNoURL of the user’s profile image.
user_idstringYesUnique ID for the user.

sendbird_create_user_metadata

Create user metadata Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
metadataobjectYesKey-value pairs of metadata.

sendbird_delete_group_channel

Delete a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.

sendbird_delete_group_channel_message

Delete a message in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
message_idintegerYesThe ID of the message.

sendbird_delete_open_channel

Delete an open channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.

sendbird_delete_user

Delete a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.

sendbird_freeze_group_channel

Freeze a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
freezebooleanYesWhether to freeze (true) or unfreeze (false) the channel.

sendbird_get_application_settings

View application settings

sendbird_get_group_channel

View a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
show_memberbooleanNoWhether to include member details.

sendbird_get_group_channel_message

View a message in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
message_idintegerYesThe ID of the message.

sendbird_get_group_channel_metadata

View group channel metadata Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.

sendbird_get_open_channel

View an open channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.

sendbird_get_user

View a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.

sendbird_get_user_metadata

View user metadata Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.

sendbird_get_user_push_preferences

View push notification preferences Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.

sendbird_get_user_unread_count

Get user’s unread message count Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.

sendbird_invite_to_group_channel

Invite users to a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
user_idsstring[]YesIDs of users to invite.

sendbird_leave_group_channel

Leave a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
user_idsstring[]YesIDs of users to remove from the channel.

sendbird_list_blocked_users

List blocked users Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
limitintegerNoNumber of results to return.
tokenstringNoPagination token.

sendbird_list_group_channel_banned_users

List banned users in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
limitintegerNoNumber of results to return.
tokenstringNoPagination token.

sendbird_list_group_channel_members

List group channel members Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
limitintegerNoNumber of results to return.
tokenstringNoPagination token.

sendbird_list_group_channel_messages

List messages in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
message_tsintegerNoTimestamp to use as a reference point. Returns messages around this timestamp.
message_idintegerNoMessage ID to use as a reference point.
prev_limitintegerNoNumber of messages before the reference point.
next_limitintegerNoNumber of messages after the reference point.
includebooleanNoWhether to include the reference message.
reversebooleanNoWhether to reverse the results order.
sender_idstringNoFilter messages by sender ID.
message_typestringNoFilter by message type. Values: MESG, FILE, ADMM.
custom_typesstringNoComma-separated custom types to filter.

sendbird_list_group_channel_muted_users

List muted users in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
limitintegerNoNumber of results to return.
tokenstringNoPagination token.

sendbird_list_group_channels

List group channels Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results to return. Max 100.
tokenstringNoPagination token from a previous response.
members_include_instringNoComma-separated user IDs to filter channels that include these members.
name_containsstringNoFilter channels whose name contains this value.
show_emptybooleanNoWhether to include empty channels.
orderstringNoSort order. Values: chronological, latest_last_message, channel_name_alphabetical, metadata_value_alphabetical.
custom_typesstringNoComma-separated custom types to filter.

sendbird_list_open_channel_messages

List messages in an open channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
message_tsintegerNoTimestamp to use as a reference point.
message_idintegerNoMessage ID to use as a reference point.
prev_limitintegerNoNumber of messages before the reference point.
next_limitintegerNoNumber of messages after the reference point.

sendbird_list_open_channels

List open channels Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results to return. Max 100.
tokenstringNoPagination token.
name_containsstringNoFilter channels whose name contains this value.
custom_typestringNoFilter by custom channel type.

sendbird_list_user_group_channels

List user’s group channels Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
limitintegerNoNumber of results to return.
tokenstringNoPagination token.
orderstringNoSort order. Values: latest_last_message, chronological, channel_name_alphabetical.

sendbird_list_users

List users Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results to return. Max 100.
tokenstringNoPagination token from a previous response.
active_modestringNoFilter by active status. Values: activated, deactivated.
nickname_startswithstringNoFilter users whose nickname starts with this value.
user_idsstringNoComma-separated list of user IDs to filter.

sendbird_mute_in_group_channel

Mute a user in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
descriptionstringNoReason for muting.
secondsintegerNoMute duration in seconds. -1 for permanent.
user_idstringYesThe ID of the user to mute.

sendbird_send_group_channel_message

Send a message to a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
custom_typestringNoCustom message type.
datastringNoAdditional data in string format.
is_silentbooleanNoWhether the message is silent (no push/unread).
mark_as_readbooleanNoWhether to mark the channel as read for the sender.
mention_typestringNoMention type. Values: users, channel.
mentioned_user_idsstring[]NoUser IDs to mention.
messagestringYesMessage text content.
message_typestringYesType of message. Values: MESG (text), FILE, ADMM (admin).
send_pushbooleanNoWhether to send a push notification.
user_idstringYesID of the user sending the message.

sendbird_send_open_channel_message

Send a message to an open channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
custom_typestringNoCustom message type.
datastringNoAdditional data.
messagestringYesMessage text content.
message_typestringYesType of message. Values: MESG (text), FILE, ADMM (admin).
user_idstringYesID of the user sending the message.

sendbird_unban_from_group_channel

Unban a user from a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
banned_user_idstringYesThe ID of the user to unban.

sendbird_unblock_user

Unblock a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
target_idstringYesThe ID of the user to unblock.

sendbird_unmute_in_group_channel

Unmute a user in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
muted_user_idstringYesThe ID of the user to unmute.

sendbird_update_group_channel

Update a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
cover_urlstringNoURL of the channel cover image.
custom_typestringNoCustom channel type.
datastringNoAdditional data.
is_distinctbooleanNoWhether the channel is distinct.
is_publicbooleanNoWhether the channel is public.
namestringNoChannel name.
operator_idsstring[]NoOperator user IDs.

sendbird_update_group_channel_message

Update a message in a group channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
message_idintegerYesThe ID of the message.
custom_typestringNoCustom message type.
datastringNoAdditional data.
messagestringNoNew message text.

sendbird_update_open_channel

Update an open channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_urlstringYesThe URL of the channel.
cover_urlstringNoURL of the channel cover image.
custom_typestringNoCustom channel type.
datastringNoAdditional data.
namestringNoChannel name.
operator_idsstring[]NoOperator user IDs.

sendbird_update_user

Update a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
is_activebooleanNoWhether the user is active.
metadataobjectNoKey-value metadata for the user.
nicknamestringNoUser’s nickname.
profile_urlstringNoURL of the user’s profile image.

sendbird_update_user_metadata

Update user metadata Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe unique ID of the user.
metadataobjectNoKey-value pairs of metadata to update.