NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Sendbird

sendbird

Sendbird is a platform that provides chat, voice, and video APIs to help businesses build in-app communication features.

CommunicationTeam ChatWeb del proveedor
Acciones
37
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (37)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Members To Group ChannelSENDBIRD_ADD_MEMBERS_GROUP_CHANNELAcción

Tool to add members to a group channel. use when you need to invite one or more users into an existing group channel.

Parámetros de entrada

  • secondsinteger

    Duration in seconds to hide previous messages. Required if hide_existing_messages is true.

  • user_idsstring[]Obligatorio

    List of User IDs to add to the channel.

  • channel_urlstringObligatorio

    URL-encoded identifier of the target group channel.

  • hide_existing_messagesboolean

    Whether to hide previous messages for new members.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Ban User from Group ChannelSENDBIRD_BAN_USER_FROM_GROUP_CHANNELAcción

Tool to ban a user from a group channel. use when moderating group channels to restrict member access. execute after confirming channel url and user id.

Parámetros de entrada

  • secondsinteger

    Duration of the ban in seconds. If omitted, ban is permanent.

  • user_idstringObligatorio

    ID of the user to ban from the channel.

  • agent_idstring

    ID of the admin or moderator performing the ban.

  • channel_urlstringObligatorio

    URL-encoded identifier of the group channel to ban the user from.

  • descriptionstring

    Reason for the ban in moderation records.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Group ChannelSENDBIRD_CREATE_CHANNELAcción

Tool to create a new group channel. use when you need to start a conversation with specific users. execute after specifying users and optional settings.

Parámetros de entrada

  • datastring

    Custom data for the channel

  • namestring

    Name of the channel

  • strictboolean

    True for strict creation; fails if channel exists

  • is_superboolean

    True to create a supergroup channel

  • user_idsstring[]

    List of user IDs to invite to the channel (max 100)

  • cover_urlstring

    URL of the channel cover image

  • is_publicboolean

    True to create a public channel

  • cover_filestringbinary

    Binary content of the cover image for multipart upload

  • access_codestring

    Access code for private channels

  • channel_urlstring

    Custom URL of the channel; autogenerated if omitted

  • custom_typestring

    Custom type identifier for the channel

  • is_distinctboolean

    True to create a distinct channel

  • is_ephemeralboolean

    True to create an ephemeral channel

  • operator_idsstring[]

    List of user IDs to assign as operators

  • custom_fieldsobject

    Custom fields object

  • is_discoverableboolean

    True to list the channel in search results

  • is_chat_notificationboolean

    True to send system notifications for channel events

  • message_survival_secondsinteger

    Message retention period in seconds

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Sendbird UserSENDBIRD_CREATE_USERAcción

Tool to create a new user. use when you need to register a user account in sendbird.

Parámetros de entrada

  • user_idstringObligatorio

    Unique identifier for the new user

  • metadataobject

    Arbitrary key/value pairs for custom user data

  • nicknamestring

    Display name of the user

  • is_activeboolean

    Whether the user is active upon creation

  • profile_urlstring

    URL for the user's profile image

  • phone_numberstring

    User's phone number, E.164 format recommended

  • profile_filestringbinary

    Binary content of the user's profile image; use for multipart upload

  • discovery_keysstring[]

    List of discovery keys for the user

  • has_ever_logged_inboolean

    Indicates if the user has ever logged in before

  • issue_access_tokenboolean

    Whether to generate an access token for the user

  • preferred_languagesstring[]

    User's preferred language codes

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Group ChannelSENDBIRD_DELETE_CHANNELAcción

Tool to delete a specific group channel. use when you have the channel url and want to permanently remove the channel. execute after confirming the channel exists.

Parámetros de entrada

  • channel_urlstringObligatorio

    The unique URL of the group channel to delete. Example: 'sendbird_group_channel_1234567890abcdef'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete MessageSENDBIRD_DELETE_MESSAGEAcción

Tool to delete a specific message in a sendbird group channel. use when you need to permanently remove a sent message after confirming deletion permissions.

Parámetros de entrada

  • message_idintegerObligatorio

    Unique ID of the message to delete; must be a non-negative integer

  • channel_urlstringObligatorio

    URL identifier of the group channel containing the message

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Sendbird UserSENDBIRD_DELETE_USERAcción

Tool to delete a sendbird user. use when you need to remove a user from your sendbird application, optionally permanently.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user to delete.

  • hard_deleteboolean

    Whether to permanently delete the user and all associated data.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Count Preference Of ChannelSENDBIRD_GET_COUNT_PREFERENCE_OF_CHANNELAcción

Tool to retrieve a user's count preference for a specific group channel. use after confirming the user and channel exist to determine whether to display all, unread-only, or mention-only counts.

Parámetros de entrada

  • user_idstringObligatorio

    The unique ID of the user.

  • channel_urlstringObligatorio

    URL (identifier) of the group channel.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Sendbird Get Group Channel Count by Join StatusSENDBIRD_GET_NUMBER_OF_CHANNELS_BY_JOIN_STATUSAcción

Tool to retrieve number of group channels by join status for a user. use when you need counts of invited, joined, and total channels for a specific user.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user to fetch channel counts for.

  • super_modestringenum

    Filter by super or non-super channels, or all.

    allsupernonsuper
  • public_modestringenum

    Filter by public or private channels, or all.

    allpublicprivate
  • custom_typesstring[]

    List of custom channel types to filter by.

  • distinct_modestringenum

    Return count of distinct, nondistinct channels, or all.

    alldistinctnondistinct

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Sendbird Get Unread Item CountSENDBIRD_GET_NUMBER_OF_UNREAD_ITEMSAcción

Tool to retrieve a user's unread item counts. use after you need the total unread messages, mentions, and channel counts for a specific user.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user whose unread counts are to be retrieved.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Issue Session TokenSENDBIRD_ISSUE_SESSION_TOKENAcción

Tool to issue a session token for a user. use when you need to generate or refresh a user's session token.

Parámetros de entrada

  • user_idstringObligatorio

    The unique ID of the user to issue a session token for.

  • expires_atinteger

    Optional token expiration timestamp in Unix milliseconds. If omitted, the default token lifetime is used.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Leave Group ChannelsSENDBIRD_LEAVE_GROUP_CHANNELSAcción

Tool to leave group channels for a user. use when you need to make a user exit one or more joined group channels.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user who will leave group channels.

  • channel_urlsstring[]Obligatorio

    List of group channel URLs to leave. Ignored if `should_leave_all` is true.

  • should_leave_allboolean

    Whether to leave all joined group channels. If true, `channel_urls` is ignored.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Banned MembersSENDBIRD_LIST_BANNED_MEMBERSAcción

Tool to list banned members in a group channel. use when you need to see which users are banned from a specific group channel.

Parámetros de entrada

  • limitinteger

    Number of banned members to return per page (1-100). Default is 10.

  • tokenstring

    Pagination token from previous response; omit for first request.

  • channel_urlstringObligatorio

    Unique URL of the group channel to list banned members from.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Group ChannelsSENDBIRD_LIST_GROUP_CHANNELSAcción

Tool to list group channels. use when you need to fetch paginated group channels with optional filters.

Parámetros de entrada

  • namestring

    Filter channels by channel name

  • limitinteger

    Number of results per page (1-100)

  • tokenstring

    Pagination token to retrieve the next page

  • show_emptyboolean

    Whether to include empty channels in the results

  • super_modestringenum

    Filter by super channel type: all, super, or nonsuper

    allsupernonsuper
  • public_modestringenum

    Filter by public channel type: all, public, or private

    allpublicprivate
  • show_frozenboolean

    Whether to include frozen channels in the results

  • channel_urlsstring[]

    Filter channels by exact URLs

  • custom_typesstring[]

    Filter channels by custom types

  • url_containsstring

    Filter channels whose URL contains this substring

  • created_afterinteger

    List channels created after this timestamp (in milliseconds)

  • distinct_modestringenum

    Filter by distinct channel type: all, distinct, or nondistinct

    alldistinctnondistinct
  • show_metadataboolean

    Whether to include channel metadata

  • created_beforeinteger

    List channels created before this timestamp (in milliseconds)

  • my_member_statestringenum

    Filter by member state: all, joined_only, invited_only, invited_by_friend, or invited_by_non_friend

    alljoined_onlyinvited_onlyinvited_by_friendinvited_by_non_friend
  • members_nicknamestring

    Filter channels by member nickname

  • show_read_receiptboolean

    Whether to include read receipt data

  • members_exactly_instring[]

    List of user IDs who must all be members of the channel

  • members_include_instring[]

    List of user IDs one of whom must be a member of the channel

  • show_delivery_receiptboolean

    Whether to include delivery receipt data

  • custom_type_startswithstring

    Filter channels whose custom type starts with this prefix

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Group Channel MembersSENDBIRD_LIST_MEMBERS_GROUP_CHANNELAcción

Tool to list members of a group channel. use when you need to paginate through members of a specified group channel.

Parámetros de entrada

  • limitinteger

    Maximum number of results to return (1-100)

  • orderstringenum

    Sorting order of members list

    nickname_alphabeticaloperator_alphabetical
  • tokenstring

    Pagination token for fetching the next page

  • offsetinteger

    Number of results to skip before returning the set (deprecated; use token instead)

  • channel_urlstringObligatorio

    Unique URL of the group channel

  • operator_filterstringenum

    Filter by operator status

    alloperatornonoperator
  • member_state_filterstringenum

    Filter by membership state

    alljoined_onlyinvited_only
  • muted_member_filterstringenum

    Filter by muted status of members

    allmutedunmuted
  • nickname_startswithstring

    Search members whose nicknames start with this string

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Operators by Custom Channel TypeSENDBIRD_LIST_OPERATORS_CUSTOM_CHANNEL_TYPEAcción

Tool to list operators of a channel by custom channel type. use when you need to fetch operators for a specific custom channel type with pagination.

Parámetros de entrada

  • limitinteger

    Maximum number of operators to return per page (1-100).

  • tokenstring

    Pagination cursor from a previous call; omit for the first request.

  • custom_typestringObligatorio

    Custom channel type to list operators for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Group Channel OperatorsSENDBIRD_LIST_OPERATORS_GROUP_CHANNELAcción

Tool to list operators of a group channel. use after specifying the channel url when needing to paginate through operators.

Parámetros de entrada

  • limitinteger

    Number of operators to return per page (1-100). Default is 10.

  • tokenstring

    Pagination token from previous response; omit for first page

  • channel_urlstringObligatorio

    URL of the group channel to retrieve operators from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Open Channel OperatorsSENDBIRD_LIST_OPERATORS_OPEN_CHANNELAcción

Tool to list operators of an open channel. use when you have the open channel url and need to fetch its operators. supports pagination via token and limit.

Parámetros de entrada

  • limitinteger

    Maximum number of operators to return per page (1-100).

  • tokenstring

    Pagination cursor from a previous response; omit for the first request.

  • channel_urlstringObligatorio

    URL-encoded unique identifier of the open channel to list operators for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List UsersSENDBIRD_LIST_USERSAcción

Tool to retrieve a list of users. use after setting up sendbird api credentials to paginate or filter all users in your application.

Parámetros de entrada

  • limitinteger

    Number of users to return per page (1-100). Default is 10.

  • orderstringenum

    Sort order: nickname_alphabetical, created_at, or user_id_alphabetical.

    nickname_alphabeticalcreated_atuser_id_alphabetical
  • tokenstring

    Pagination token from previous response; omit for first request.

  • nicknamestring

    Exact nickname to filter (case-insensitive substring match).

  • user_idsstring[]

    List of user IDs to filter; sent as comma-separated string.

  • is_activeboolean

    Filter users by their active status.

  • custom_typestring

    Custom type to filter users by.

  • metatag_keystring

    Metatag key to filter users who have this key.

  • metatag_valuesstring[]

    List of metatag values to filter; requires `metatag_key`.

  • nickname_containsstring

    Substring filter for nicknames (case-insensitive).

  • has_ever_logged_inboolean

    Filter users by whether they have ever logged in.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Mark All User Messages As ReadSENDBIRD_MARK_ALL_USER_MESSAGES_AS_READAcción

Tool to mark all of a user's messages as read in group channels. use when resetting unread message counts after a user has viewed all messages.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user whose messages will be marked as read.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Mute UserSENDBIRD_MUTE_USERAcción

Tool to mute a user in a group channel. use when you need to prevent a user from sending messages for a specified duration.

Parámetros de entrada

  • secondsinteger

    Mute duration in seconds (0 = indefinite)

  • user_idstringObligatorio

    ID of the user to mute

  • channel_urlstringObligatorio

    URL-encoded identifier of the target group channel

  • descriptionstring

    Custom description for the mute action

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Register Operators by Custom Channel TypeSENDBIRD_REGISTER_OPERATORS_CUSTOM_CHANNEL_TYPEAcción

Tool to register users as operators to channels by custom channel type. use when assigning operator roles for all channels of a specified custom type.

Parámetros de entrada

  • custom_typestringObligatorio

    Custom channel type identifier

  • operator_idsstring[]Obligatorio

    List of user IDs to register as operators (at least one)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Register Group Channel OperatorsSENDBIRD_REGISTER_OPERATORS_GROUP_CHANNELAcción

Tool to register one or more users as operators in a sendbird group channel. use when elevating permissions of existing channel members.

Parámetros de entrada

  • user_idsstring[]Obligatorio

    List of user IDs to register as operators

  • channel_urlstringObligatorio

    URL-encoded identifier of the group channel

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Register Operators to Open ChannelSENDBIRD_REGISTER_OPERATORS_OPEN_CHANNELAcción

Tool to register operators to an open channel. use after creating or updating an open channel when you need to assign operator roles.

Parámetros de entrada

  • user_idsstring[]Obligatorio

    List of user IDs to register as operators (at least one)

  • channel_urlstringObligatorio

    URL-encoded identifier of the open channel

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Revoke All Session TokensSENDBIRD_REVOKE_ALL_SESSION_TOKENSAcción

Tool to revoke all session tokens for a user. use when you need to invalidate all active sessions for security.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user whose session tokens will be revoked.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Sendbird View MessageSENDBIRD_SENDBIRD_VIEW_MESSAGEAcción

Tool to view a specific message in a group channel. use after confirming channel url and message id.

Parámetros de entrada

  • message_idintegerObligatorio

    Unique ID of the message.

  • channel_urlstringObligatorio

    URL-encoded identifier of the group channel.

  • with_sorted_metaarrayboolean

    Whether to include sorted_metaarray arrays in the response.

Parámetros de salida

  • datastring

    Custom message data.

  • typestringObligatorio

    Type of the message (MESG, FILE, ADMIN).

  • userobjectObligatorio

    User who sent the message.

  • errorstring

    Error if any occurred during the execution of the action

  • og_tagobject

    Open graph metadata if present.

  • messagestring

    Text content of the message.

  • reactionsobject[]

    List of reactions.

  • created_atintegerObligatorio

    Creation timestamp (ms).

  • message_idintegerObligatorio

    Unique ID of the message.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • updated_atintegerObligatorio

    Update timestamp (ms).

  • channel_urlstringObligatorio

    URL of the group channel.

  • custom_typestring

    Custom message type.

  • thread_infoobject

    Thread information if applicable.

  • mention_typestring

    Mention type.

  • translationsobject

    Translated texts keyed by language.

  • parent_messageobject

    Parent message details if threaded.

  • mentioned_usersobject[]

    Users mentioned in the message.

  • sorted_metaarrayobject[]

    Sorted metadata array.

Sendbird View UserSENDBIRD_SENDBIRD_VIEW_USERAcción

Tool to view user information. use when retrieving details of a specific sendbird user by id.

Parámetros de entrada

  • user_idstringObligatorio

    The unique ID of the user to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send MessageSENDBIRD_SEND_MESSAGEAcción

Tool to send a message to a group channel. use when you need to post a text, file, or admin message to an existing group channel.

Parámetros de entrada

  • datastring

    Free-form custom data string (often JSON)

  • messagestring

    Text content of the message. Required when message_type is 'MESG'

  • poll_idinteger

    Attach an existing poll by its ID

  • user_idstring

    Sender's user ID. Required unless using API token as acting user

  • is_silentboolean

    Send as silent message (no push notifications)

  • metaarrayobject[]

    Array of metadata objects

  • channel_urlstringObligatorio

    URL-encoded identifier of the target group channel

  • custom_typestring

    Custom message type for classification

  • mention_typestringenum

    Mention scope: 'users' to mention specific users or 'channel' to mention all

    userschannel
  • message_typestringObligatorioenum

    Type of message: 'MESG' for text, 'FILE' for file, 'ADMM' for admin message

    MESGFILEADMM
  • parent_message_idinteger

    Reply in a thread to the message with this ID

  • mentioned_user_idsstring[]

    List of user IDs to mention when mention_type is 'users'

  • is_operator_messageboolean

    Mark as operator (moderator) message

  • translation_target_languagesstring[]

    List of language codes for auto-translation, e.g., ['en', 'es']

  • push_notification_delivery_optionstringenum

    Push notification option: 'default', 'suppress', or 'include_offline_user'

    defaultsuppressinclude_offline_user

Parámetros de salida

  • datastring

    Custom data payload

  • typestringObligatorioenum

    Type of the message

    MESGFILEADMM
  • userobjectObligatorio

    Sender user information

  • errorstring

    Error if any occurred during the execution of the action

  • silentbooleanObligatorio

    Whether the message is silent

  • messagestring

    Text content of the message

  • created_atintegerObligatorio

    Timestamp (ms) when message was created

  • message_idintegerObligatorio

    Unique message ID

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • updated_atintegerObligatorio

    Timestamp (ms) when message was last updated

  • channel_urlstringObligatorio

    URL of the group channel where message was sent

  • custom_typestring

    Custom message type

  • thread_infoobject

    Thread details when message has replies.

  • mention_typestringenum

    Mention type used in the message

    userschannel
  • translationsobject[]

    Auto-translation results for this message

  • operator_messageboolean

    Whether this is an operator message

  • parent_message_idinteger

    Parent message ID if it's a reply

  • mentioned_user_idsstring[]

    List of user IDs mentioned in the message

Unban User from Group ChannelSENDBIRD_UNBAN_USERAcción

Tool to unban a user from a group channel. use when reinstating a previously banned user. execute after confirming the user is currently banned.

Parámetros de entrada

  • channel_urlstringObligatorio

    The URL of the group channel from which to unban the user.

  • banned_user_idstringObligatorio

    The unique ID of the banned user to unban.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unmute UserSENDBIRD_UNMUTE_USERAcción

Tool to unmute a user in a group channel. use when you want to restore a muted user's ability to send messages after confirming they are muted.

Parámetros de entrada

  • channel_urlstringObligatorio

    URL-encoded identifier of the group channel to unmute the user in.

  • muted_user_idstringObligatorio

    User ID to unmute from the channel.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unregister Operators Custom Channel TypeSENDBIRD_UNREGISTER_OPERATORS_CUSTOM_CHANNEL_TYPEAcción

Tool to unregister operators from channels by custom channel type. use when you need to remove operator roles from users across channels of a specific custom type.

Parámetros de entrada

  • user_idsstring[]Obligatorio

    List of user IDs to unregister as operators.

  • custom_typestringObligatorio

    Custom channel type to target. Example: 'my_custom_type'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Count Preference Of ChannelSENDBIRD_UPDATE_COUNT_PREFERENCE_OF_CHANNELAcción

Tool to update a user's unread count preference for a specific group channel. use when you want to include or suppress a channel in the user's unread counts.

Parámetros de entrada

  • user_idstringObligatorio

    The unique ID of the user.

  • channel_urlstringObligatorio

    URL identifier of the group channel.

  • count_preferencestringObligatorioenum

    The user's count preference for the channel: one of 'all', 'unread_message_count_only', 'mention_count_only', or 'none'.

    allunread_message_count_onlymention_count_onlynone

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Group ChannelSENDBIRD_UPDATE_GROUP_CHANNELAcción

Tool to update group channel information. use when you need to modify channel attributes such as name, cover image, privacy settings, or operator list after channel creation.

Parámetros de entrada

  • datastring

    Custom channel data as a JSON-encoded string

  • namestring

    New name for the channel

  • is_superboolean

    Whether this is a supergroup channel

  • cover_urlstring

    HTTPS URL for the channel's cover image

  • is_publicboolean

    Whether this channel is publicly joinable

  • operatorsstring[]

    List of user IDs to assign as channel operators

  • access_codestring

    Access code required for joining this channel

  • channel_urlstringObligatorio

    URL identifier of the group channel to update

  • custom_typestring

    Custom type label for the channel

  • is_distinctboolean

    Whether this is a distinct channel

  • is_ephemeralboolean

    Whether this channel is ephemeral

  • my_count_preferencestringenum

    Unread count preference ("unread_message_count_only" or "all_count")

    unread_message_count_onlyall_count

Parámetros de salida

  • datastring

    Custom data string for the channel

  • namestring

    Name of the channel

  • errorstring

    Error if any occurred during the execution of the action

  • is_superbooleanObligatorio

    True if channel is a supergroup

  • cover_urlstring

    Cover image URL

  • is_publicbooleanObligatorio

    True if channel is public

  • operatorsstring[]

    User IDs of channel operators

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • access_codestring

    Access code for channel joining

  • channel_urlstringObligatorio

    Unique URL of the group channel

  • custom_typestring

    Custom type of the channel

  • is_distinctbooleanObligatorio

    True if channel is distinct

  • is_ephemeralbooleanObligatorio

    True if channel is ephemeral

  • my_count_preferencestring

    Unread count setting

Sendbird Update MessageSENDBIRD_UPDATE_MESSAGEAcción

Tool to update an existing group channel message in sendbird. use after you need to modify content or metadata of a sent message.

Parámetros de entrada

  • datastring

    Additional data for the message as a JSON-encoded string

  • contentstring

    New text content of the message

  • user_idstring

    ID of the user performing the update

  • dedup_idstring

    Deduplication ID for the message update

  • is_silentboolean

    Whether the message update should be silent (no push notification)

  • message_idintegerObligatorio

    Unique ID of the message to update

  • channel_urlstringObligatorio

    URL identifier of the group channel containing the message

  • custom_typestring

    Custom type label for the message

  • mention_typestring

    Mention type for the message (e.g., 'users' or 'channel')

  • message_typestring

    Type of the message (e.g., 'MESG' or 'FILE')

  • apns_bundle_idstring

    APNs bundle ID for iOS push notifications

  • sorted_metaarrayobject[]

    Sorted metaarray objects for the message

  • mentioned_user_idsstring[]

    List of user IDs to mention in the message

  • push_notification_delivery_optionstring

    Push notification delivery option ('default', 'suppress')

Parámetros de salida

  • datastring

    Additional data in the message

  • fileobject

    File object if the message contains a file

  • typestringObligatorio

    Type of the message

  • userobjectObligatorio

    User object who sent the message

  • errorstring

    Error if any occurred during the execution of the action

  • og_tagobject

    Open Graph tag information for the message

  • contentstring

    Content of the message

  • is_silentbooleanObligatorio

    True if the update was silent

  • reactionsobject[]

    List of reaction objects on the message

  • created_atintegerObligatorio

    Timestamp when the message was created (ms since epoch)

  • message_idintegerObligatorio

    Unique ID of the updated message

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • updated_atintegerObligatorio

    Timestamp when the message was last updated (ms since epoch)

  • channel_urlstringObligatorio

    URL of the channel containing the message

  • custom_typestring

    Custom type of the message

  • thread_infoobject

    Thread information if part of a thread

  • mention_typestring

    Mention type in the message

  • translationsobject

    Translations available for the message

  • mentioned_usersobject[]

    List of mentioned user objects

  • sorted_metaarrayobject[]

    Sorted metaarray objects for the message

  • parent_message_idinteger

    ID of the parent message if this is a reply

  • is_reply_to_channelboolean

    True if message is a direct reply to channel

  • parent_message_infoobject

    Parent message data if this is a reply

  • apple_critical_alert_optionsobject

    Apple critical alert options for the message

Update Sendbird UserSENDBIRD_UPDATE_USERAcción

Tool to update a user's information. use when modifying nickname, profile image url, activation status, or metadata.

Parámetros de entrada

  • user_idstringObligatorio

    Unique ID of the user to update

  • metadataobject

    Custom key-value store for user metadata

  • nicknamestring

    New display name for the user

  • is_activeboolean

    Set to false to deactivate the user account

  • profile_urlstring

    URL of the new profile image

  • issue_access_tokenboolean

    Whether to issue a new access token for the user

  • preferred_languagesstring[]

    List of language tags for localization

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Sendbird View Group ChannelSENDBIRD_VIEW_GROUP_CHANNELAcción

Tool to view information about a specific group channel. use when you need channel details after confirming the channel url.

Parámetros de entrada

  • channel_urlstringObligatorio

    URL-encoded identifier of the group channel to retrieve.

  • show_memberboolean

    Whether to include the channel's member list in the response.

  • show_metadataboolean

    Whether to include channel metadata in the response.

  • show_read_receiptboolean

    Whether to include read receipt information in the response.

  • show_migration_infoboolean

    Whether to include migration information in the response.

  • show_delivery_receiptboolean

    Whether to include delivery receipt information in the response.

Parámetros de salida

  • datastring

    Custom data of the channel.

  • namestring

    Name of the channel.

  • errorstring

    Error if any occurred during the execution of the action

  • membersobject[]

    List of members if show_member=true.

  • is_superbooleanObligatorio

    Whether the channel is a super group.

  • metadataobject

    Channel metadata if show_metadata=true.

  • cover_urlstring

    Cover image URL of the channel.

  • is_publicbooleanObligatorio

    Whether the channel is public.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • channel_urlstringObligatorio

    URL of the group channel.

  • custom_typestring

    Custom type of the channel.

  • is_distinctbooleanObligatorio

    Whether the channel is distinct.

  • is_broadcastbooleanObligatorio

    Whether the channel is a broadcast channel.

  • read_receiptobject

    Read receipt mapping (user_id to timestamp) if requested.

  • migration_infoobject

    Migration information if show_migration_info=true.

  • delivery_receiptobject

    Delivery receipt mapping (user_id to count) if requested.

View UserSENDBIRD_VIEW_USERAcción

Tool to retrieve information about a specific sendbird user. use when you need to fetch detailed user data by their user id.

Parámetros de entrada

  • user_idstringObligatorio

    The unique ID of the user to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not