Commands
Installation
- npm
- Yarn
- pnpm
npm install @wildix/xbees-conversations-client
yarn add @wildix/xbees-conversations-client
pnpm add @wildix/xbees-conversations-client
Commands
Adds a single member to an existing channel. This operation will either add an existing user or invite a new user to the channel. This operation is idempotent, meaning that if the member already exists, the operation will still return a successful response.
Adds members to an existing channel. This operation is idempotent, meaning that if a member already exists in the channel, the operation will still return a successful response.
Creates a new group channel with specified members and members to invite.
Creates a new tag that can be used to group channels. Each user can have up to 15 tags. If the limit is reached, a TagsLimitReachedException will be thrown.
Deletes an existing channel. This operation is idempotent, meaning that if the channel does not exist, the operation will still return a successful response.
Deletes a specific member from a channel. This operation is idempotent, meaning that if the member does not exist, the operation will still return a successful response.
Deletes an existing tag. This operation is idempotent.
Deletes an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.
Deletes a reaction from a specific message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.
Get result of the triggered action.
Retrieves details of a specific channel by its unique identifier.
Retrieves details of a specific member in a channel. This includes the member's role and user information.
Gets the channel ID of an existing or non-existing direct channel between the specified user and another member.
Retrieves a presigned URL for downloading a specific file from a message in a specified channel.
Retrieves the user's inbox state to track pinned, tagged, and unread markers.
Retrieves a specific message from a specified channel.
Gets or creates a direct channel between the specified user and another member.
Retrieves information about an uploaded file in a specified channel.
Allows a user to hide an existing channel. This operation requires the channel to be accessible to the user.
Invite a list of users to x-bees. This operation creates an account for specified emails or phone numbers. Use this method to create users who can be added to conversations later.
Allows a user to join an existing channel. This operation requires the channel to be accessible to the user. The user can join a channel if it is public or if they have the necessary permissions.
Allows a user to leave an existing channel. This operation requires the channel to be accessible to the user.
Retrieves a list of members for a specific channel. Supports pagination through limit and offset parameters.
Lists all channels associated with a user. Allows pagination using limit and offset parameters. Sorted by last message in the channel.
Returns a list of channels associated with the specified tag.
Returns a list of tags associated with the user.
Retrieves a list of reactions for a specific message in a specified channel. Supports pagination through limit and offset parameters.
Retrieves a list of messages from a specified channel. Supports pagination through limit and offset parameters.
Retrieves a list of pinned messages from a specified channel. Supports pagination through limit and offset parameters.
Marks all messages in the specified channel as read by the user. This operation requires the channel to be accessible to the user.
Marks the channel with unread indicator.
A user can have up to 100 channels marked as unread. If a user tries to tag more than 100 channels, the system will remove the oldest channel unread marked if the force flag is specified; otherwise, a MarkUnreadChannelsLimitReachedException will be thrown.
The system will automatically remove the unread mark from the channel if the user reads the messages using the MarkRead operation.
This operation is idempotent, meaning that if the channel is already marked as unread, no error will be thrown.
Partially updates the details of an existing channel. This operation allows for updating specific channel properties without altering the entire resource.
Partially updates an existing message in a specified channel. This operation requires the channel and message to be accessible to the user.
Marks the channel with a pin flag.
A user can have up to 10 pinned channels. If a user tries to pin more than 10 channels, the system will remove the oldest channel if the force flag is specified; otherwise, a PinnedChannelsLimitReachedException will be thrown.
The system will automatically remove the channel from pinned list if the user leaves the channel or if the channel is removed.
This operation is idempotent, meaning that if the channel is already pinned, no error will be thrown.
Pins specified message in the message. This operation is idempotent, meaning that if the message is already pinned, no error will be thrown.
Schedules a job to fix the "external" flag for channels in which the user participates.
Send result of the triggered action.
Sends a Giphy message to a specified channel. This operation requires the channel to be accessible to the user.
Sends a message to a specified channel. This operation requires the channel to be accessible to the user.
Sends a reaction to a specific message in a specified channel. This operation requires the channel to be accessible to the user.
Sends a typing start event to a specified channel. This operation requires the channel to be accessible to the user.
Sends a typing stop event to a specified channel. This operation requires the channel to be accessible to the user.
Allows a user to show an existing hidden channel. This operation requires the channel to be accessible to the user.
Marks the channel with specified tag.
A user can have up to 100 channels tagged for a single tag. If a user tries to tag more than 100 channels, the system will remove the oldest channel tagged if the force flag is specified; otherwise, a TaggedChannelsLimitReachedException will be thrown.
The system will automatically remove the channel from the specified tag if the user leaves the channel or if the channel is removed.
This operation is idempotent, meaning that if the channel is already tagged, no error will be thrown.
Sends a trigger for specific action for specified message. This operation requires the message to be accessible to the user.
Removes pin flag from the the channel.
Unpins the message that was previously pinned. This operation is idempotent, meaning that if the message is not pinned, no error will be thrown.
Removes specified tag from the the channel.
Updates the details of an existing channel. This operation can modify channel properties such as name, description, and members.
Updates an existing tag. This operation is idempotent.
Updates an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.
Create a presigned URL for file upload in the channel.
Libraries
- npm
- Yarn
- pnpm
npm install @wildix/xbees-conversations-utils
yarn add @wildix/xbees-conversations-utils
pnpm add @wildix/xbees-conversations-utils