/sendbird | Type: Application | PCID required: Yes
Tools
sendbird_ban_from_group_channel
Ban a user from a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
description | string | No | — | Reason for the ban. |
seconds | integer | No | — | Ban duration in seconds. -1 for permanent. |
user_id | string | Yes | — | The ID of the user to ban. |
sendbird_block_user
Block a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
target_id | string | Yes | — | The ID of the user to block. |
sendbird_create_group_channel
Create a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | No | — | Custom channel URL. Auto-generated if not provided. |
cover_url | string | No | — | URL of the channel cover image. |
custom_type | string | No | — | Custom channel type for categorization. |
data | string | No | — | Additional data in string format. |
invitation_status | object | No | — | Invitation status per user. |
is_distinct | boolean | No | — | Whether the channel is reused for the same member set. |
is_public | boolean | No | — | Whether the channel is public. |
name | string | No | — | Channel name. |
operator_ids | string[] | No | — | User IDs to register as operators. |
user_ids | string[] | Yes | — | User IDs to add as members. |
sendbird_create_group_channel_metadata
Create group channel metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
metadata | object | Yes | — | Key-value pairs of metadata. |
sendbird_create_open_channel
Create an open channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | No | — | Custom channel URL. |
cover_url | string | No | — | URL of the channel cover image. |
custom_type | string | No | — | Custom channel type. |
data | string | No | — | Additional data. |
name | string | No | — | Channel name. |
operator_ids | string[] | No | — | Operator user IDs. |
sendbird_create_user
Create a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
issue_access_token | boolean | No | — | Whether to create an access token for the user. |
metadata | object | No | — | Key-value metadata for the user. |
nickname | string | No | — | User’s nickname. |
profile_url | string | No | — | URL of the user’s profile image. |
user_id | string | Yes | — | Unique ID for the user. |
sendbird_create_user_metadata
Create user metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
metadata | object | Yes | — | Key-value pairs of metadata. |
sendbird_delete_group_channel
Delete a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
sendbird_delete_group_channel_message
Delete a message in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
message_id | integer | Yes | — | The ID of the message. |
sendbird_delete_open_channel
Delete an open channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
sendbird_delete_user
Delete a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
sendbird_freeze_group_channel
Freeze a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
freeze | boolean | Yes | — | Whether to freeze (true) or unfreeze (false) the channel. |
sendbird_get_application_settings
View application settingssendbird_get_group_channel
View a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
show_member | boolean | No | — | Whether to include member details. |
sendbird_get_group_channel_message
View a message in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
message_id | integer | Yes | — | The ID of the message. |
sendbird_get_group_channel_metadata
View group channel metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
sendbird_get_open_channel
View an open channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
sendbird_get_user
View a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
sendbird_get_user_metadata
View user metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
sendbird_get_user_push_preferences
View push notification preferences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
sendbird_get_user_unread_count
Get user’s unread message count Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
sendbird_invite_to_group_channel
Invite users to a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
user_ids | string[] | Yes | — | IDs of users to invite. |
sendbird_leave_group_channel
Leave a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
user_ids | string[] | Yes | — | IDs of users to remove from the channel. |
sendbird_list_blocked_users
List blocked users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
limit | integer | No | — | Number of results to return. |
token | string | No | — | Pagination token. |
sendbird_list_group_channel_banned_users
List banned users in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
limit | integer | No | — | Number of results to return. |
token | string | No | — | Pagination token. |
sendbird_list_group_channel_members
List group channel members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
limit | integer | No | — | Number of results to return. |
token | string | No | — | Pagination token. |
sendbird_list_group_channel_messages
List messages in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
message_ts | integer | No | — | Timestamp to use as a reference point. Returns messages around this timestamp. |
message_id | integer | No | — | Message ID to use as a reference point. |
prev_limit | integer | No | — | Number of messages before the reference point. |
next_limit | integer | No | — | Number of messages after the reference point. |
include | boolean | No | — | Whether to include the reference message. |
reverse | boolean | No | — | Whether to reverse the results order. |
sender_id | string | No | — | Filter messages by sender ID. |
message_type | string | No | — | Filter by message type. Values: MESG, FILE, ADMM. |
custom_types | string | No | — | Comma-separated custom types to filter. |
sendbird_list_group_channel_muted_users
List muted users in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
limit | integer | No | — | Number of results to return. |
token | string | No | — | Pagination token. |
sendbird_list_group_channels
List group channels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return. Max 100. |
token | string | No | — | Pagination token from a previous response. |
members_include_in | string | No | — | Comma-separated user IDs to filter channels that include these members. |
name_contains | string | No | — | Filter channels whose name contains this value. |
show_empty | boolean | No | — | Whether to include empty channels. |
order | string | No | — | Sort order. Values: chronological, latest_last_message, channel_name_alphabetical, metadata_value_alphabetical. |
custom_types | string | No | — | Comma-separated custom types to filter. |
sendbird_list_open_channel_messages
List messages in an open channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
message_ts | integer | No | — | Timestamp to use as a reference point. |
message_id | integer | No | — | Message ID to use as a reference point. |
prev_limit | integer | No | — | Number of messages before the reference point. |
next_limit | integer | No | — | Number of messages after the reference point. |
sendbird_list_open_channels
List open channels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return. Max 100. |
token | string | No | — | Pagination token. |
name_contains | string | No | — | Filter channels whose name contains this value. |
custom_type | string | No | — | Filter by custom channel type. |
sendbird_list_user_group_channels
List user’s group channels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
limit | integer | No | — | Number of results to return. |
token | string | No | — | Pagination token. |
order | string | No | — | Sort order. Values: latest_last_message, chronological, channel_name_alphabetical. |
sendbird_list_users
List users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return. Max 100. |
token | string | No | — | Pagination token from a previous response. |
active_mode | string | No | — | Filter by active status. Values: activated, deactivated. |
nickname_startswith | string | No | — | Filter users whose nickname starts with this value. |
user_ids | string | No | — | Comma-separated list of user IDs to filter. |
sendbird_mute_in_group_channel
Mute a user in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
description | string | No | — | Reason for muting. |
seconds | integer | No | — | Mute duration in seconds. -1 for permanent. |
user_id | string | Yes | — | The ID of the user to mute. |
sendbird_send_group_channel_message
Send a message to a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
custom_type | string | No | — | Custom message type. |
data | string | No | — | Additional data in string format. |
is_silent | boolean | No | — | Whether the message is silent (no push/unread). |
mark_as_read | boolean | No | — | Whether to mark the channel as read for the sender. |
mention_type | string | No | — | Mention type. Values: users, channel. |
mentioned_user_ids | string[] | No | — | User IDs to mention. |
message | string | Yes | — | Message text content. |
message_type | string | Yes | — | Type of message. Values: MESG (text), FILE, ADMM (admin). |
send_push | boolean | No | — | Whether to send a push notification. |
user_id | string | Yes | — | ID of the user sending the message. |
sendbird_send_open_channel_message
Send a message to an open channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
custom_type | string | No | — | Custom message type. |
data | string | No | — | Additional data. |
message | string | Yes | — | Message text content. |
message_type | string | Yes | — | Type of message. Values: MESG (text), FILE, ADMM (admin). |
user_id | string | Yes | — | ID of the user sending the message. |
sendbird_unban_from_group_channel
Unban a user from a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
banned_user_id | string | Yes | — | The ID of the user to unban. |
sendbird_unblock_user
Unblock a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
target_id | string | Yes | — | The ID of the user to unblock. |
sendbird_unmute_in_group_channel
Unmute a user in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
muted_user_id | string | Yes | — | The ID of the user to unmute. |
sendbird_update_group_channel
Update a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
cover_url | string | No | — | URL of the channel cover image. |
custom_type | string | No | — | Custom channel type. |
data | string | No | — | Additional data. |
is_distinct | boolean | No | — | Whether the channel is distinct. |
is_public | boolean | No | — | Whether the channel is public. |
name | string | No | — | Channel name. |
operator_ids | string[] | No | — | Operator user IDs. |
sendbird_update_group_channel_message
Update a message in a group channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
message_id | integer | Yes | — | The ID of the message. |
custom_type | string | No | — | Custom message type. |
data | string | No | — | Additional data. |
message | string | No | — | New message text. |
sendbird_update_open_channel
Update an open channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_url | string | Yes | — | The URL of the channel. |
cover_url | string | No | — | URL of the channel cover image. |
custom_type | string | No | — | Custom channel type. |
data | string | No | — | Additional data. |
name | string | No | — | Channel name. |
operator_ids | string[] | No | — | Operator user IDs. |
sendbird_update_user
Update a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
is_active | boolean | No | — | Whether the user is active. |
metadata | object | No | — | Key-value metadata for the user. |
nickname | string | No | — | User’s nickname. |
profile_url | string | No | — | URL of the user’s profile image. |
sendbird_update_user_metadata
Update user metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | The unique ID of the user. |
metadata | object | No | — | Key-value pairs of metadata to update. |

