Commands
Installation
- npm
- Yarn
- pnpm
- Bun
npm install @wildix/xbees-conversations-client
yarn add @wildix/xbees-conversations-client
pnpm add @wildix/xbees-conversations-client
bun add @wildix/xbees-conversations-client
Commands
ListChannelsCommand
Lists all channels associated with a user. Allows pagination using limit and offset parameters. Sorted by last message in the channel.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ListChannels
- messaging:read
DeleteChannelCommand
Deletes an existing channel. This operation is idempotent, meaning that if the channel does not exist, the operation will still return a successful response.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:DeleteChannel
GetChannelCommand
Retrieves details of a specific channel by its unique identifier.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetChannel
- messaging:read
PartialUpdateChannelCommand
Partially updates the details of an existing channel. This operation allows for updating specific channel properties without altering the entire resource.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:PartialUpdateChannel
UpdateChannelCommand
Updates the details of an existing channel. This operation can modify channel properties such as name, description, and members.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:UpdateChannel
AssignChannelCommand
Assigns a channel to a user and/or service, optionally managing members according to a variant.
### Allowed Auth Scopes
- messaging:AssignChannel
UploadFileCommand
Create a presigned URL for file upload in the channel.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 20 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:UploadFile
GetUploadedFileInfoCommand
Retrieves information about an uploaded file in a specified channel.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 100 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 100 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 300 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 300 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetUploadedFileInfo
HideChannelCommand
Allows a user to hide an existing channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:HideChannel
JoinChannelCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 50 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:JoinChannel
LeaveChannelCommand
Allows a user to leave an existing channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:LeaveChannel
ListChannelMembersCommand
Retrieves a list of members for a specific channel. Supports pagination through limit and offset parameters.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 100 |
| XBS | 3600 | 600 |
| PBX | 60 | 300 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 300 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ListChannelMembers
- messaging:read
AddChannelMemberCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:AddChannelMember
AddChannelMembersCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:AddChannelMembers
DeleteChannelMemberCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:DeleteChannelMember
GetChannelMemberCommand
Retrieves details of a specific member in a channel. This includes the member's role and user information.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 100 |
| XBS | 3600 | 600 |
| PBX | 60 | 300 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 300 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetChannelMember
- messaging:read
ListMessagesCommand
Retrieves a list of messages from a specified channel. Supports pagination through limit and offset parameters.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ListMessages
- messaging:read
SendMessageCommand
Sends a message to a specified channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 10 | 10 |
| XBS | 3600 | 600 |
| PBX | 10 | 30 |
| PBX | 3600 | 1800 |
| XBS_BOT | 10 | 30 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendMessage
DeleteMessageCommand
Deletes an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:DeleteMessage
GetMessageCommand
Retrieves a specific message from a specified channel.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetMessage
- messaging:read
PartialUpdateMessageCommand
Partially updates an existing message in a specified channel. This operation requires the channel and message to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:PartialUpdateMessage
UpdateMessageCommand
Updates an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:UpdateMessage
TriggerMessageActionCommand
Sends a trigger for specific action for specified message. This operation requires the message to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 10 | 10 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 10 | 10 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 10 | 30 |
| PBX | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:TriggerMessageAction
GetFilePresignedDownloadUrlCommand
Retrieves a presigned URL for downloading a specific file from a message in a specified channel.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 50 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetFilePresignedDownloadUrl
- messaging:read
UnpinMessageCommand
Unpins the message that was previously pinned. This operation is idempotent, meaning that if the message is not pinned, no error will be thrown.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 10 | 10 |
| XBS | 3600 | 600 |
| PBX | 10 | 30 |
| PBX | 3600 | 1800 |
| XBS_BOT | 10 | 30 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:UnpinMessage
PinMessageCommand
Pins specified message in the message. This operation is idempotent, meaning that if the message is already pinned, no error will be thrown.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 10 | 10 |
| XBS | 3600 | 600 |
| PBX | 10 | 30 |
| PBX | 3600 | 1800 |
| XBS_BOT | 10 | 30 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:PinMessage
ListMessageReactionsCommand
Retrieves a list of reactions for a specific message in a specified channel. Supports pagination through limit and offset parameters.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ListMessageReactions
- messaging:read
SendMessageReactionCommand
Sends a reaction to a specific message in a specified channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendMessageReaction
DeleteMessageReactionCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:DeleteMessageReaction
UnpinChannelCommand
Removes pin flag from the the channel.
### Allowed Auth Scopes
- messaging:UnpinChannel
PinChannelCommand
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.
### Allowed Auth Scopes
- messaging:PinChannel
ListPinnedMessagesCommand
Retrieves a list of pinned messages from a specified channel. Supports pagination through limit and offset parameters.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ListPinnedMessages
- messaging:read
ListChannelMembersReadStatusCommand
Retrieves a list of members read status for a specific channel. Read status does not work for conversations with more than 100 members.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 100 |
| XBS | 3600 | 600 |
| PBX | 60 | 300 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 300 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ListChannelMembersReadStatus
- messaging:read
MarkReadCommand
Marks all messages in the specified channel as read by the user. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 50 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:MarkRead
SendGiphyCommand
Sends a Giphy message to a specified channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendGiphy
SendTypingStartCommand
Sends a typing start event to a specified channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendTypingStart
SendTypingStopCommand
Sends a typing stop event to a specified channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendTypingStop
ShowChannelCommand
Allows a user to show an existing hidden channel. This operation requires the channel to be accessible to the user.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ShowChannel
SendSystemMessageCommand
Sends a system message to a specified channel. This operation available with S2S authorization only.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| S2S | 10 | 30 |
| S2S | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendSystemMessage
TagChannelCommand
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.
### Allowed Auth Scopes
- messaging:TagChannel
MarkUnreadCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 50 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:MarkUnread
UntagChannelCommand
Removes specified tag from the the channel.
### Allowed Auth Scopes
- messaging:UntagChannel
DescribeEventCommand
### Allowed Auth Scopes
- messaging:DescribeEvent
GetDirectChannelIdCommand
Gets the channel ID of an existing or non-existing direct channel between the specified user and another member.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetDirectChannelId
- messaging:read
GetOrCreateDirectChannelCommand
Gets or creates a direct channel between the specified user and another member.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetOrCreateDirectChannel
- messaging:read
CreateGroupChannelCommand
Creates a new group channel with specified members and members to invite.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:CreateGroupChannel
GetInboxStateCommand
Retrieves the user's inbox state to track pinned, tagged, and unread markers.
### Allowed Auth Scopes
- messaging:GetInboxState
- messaging:read
ListInboxTagsCommand
Returns a list of tags associated with the user.
### Allowed Auth Scopes
- messaging:ListInboxTags
- messaging:read
CreateInboxTagCommand
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.
### Allowed Auth Scopes
- messaging:CreateInboxTag
DeleteInboxTagCommand
Deletes an existing tag. This operation is idempotent.
### Allowed Auth Scopes
- messaging:DeleteInboxTag
ListInboxTaggedChannelsCommand
Returns a list of channels associated with the specified tag.
### Allowed Auth Scopes
- messaging:ListInboxTaggedChannels
- messaging:read
UpdateInboxTagCommand
Updates an existing tag. This operation is idempotent.
### Allowed Auth Scopes
- messaging:UpdateInboxTag
InviteCommand
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.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:Invite
CreateKiteChannelCommand
Creates a new kite channel with specified widget or email.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 60 | 20 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:CreateKiteChannel
QueryChannelsCommand
Query channels matched specified query. Allows pagination using limit and offset parameters. Sorted by last message in the channel.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:QueryChannels
- messaging:read
ScheduleExternalFlagAdjustmentJobCommand
Schedules a job to fix the "external" flag for channels in which the user participates.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 20 |
| XBS | 3600 | 600 |
| PBX | 60 | 60 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 60 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:ScheduleExternalFlagAdjustmentJob
GetSmsChannelIdCommand
Gets the channel ID of an existing or non-existing SMS channel
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetSmsChannelId
- messaging:read
GetOrCreateSmsChannelCommand
Gets or creates a SMS channel
### Allowed Auth Scopes
- messaging:GetOrCreateSmsChannel
- messaging:read
GetTelephonyChannelIdCommand
Gets the channel ID of an existing or non-existing telephony channel
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetTelephonyChannelId
- messaging:read
GetOrCreateTelephonyChannelCommand
Gets or creates a telephony channel
### Allowed Auth Scopes
- messaging:GetOrCreateTelephonyChannel
- messaging:read
GetTokenCommand
Retrieve an authorization token for chat.wildix-chat.com
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 10 |
| XBS | 3600 | 60 |
| XBS_ANONYMOUS | 60 | 10 |
| XBS_ANONYMOUS | 3600 | 60 |
### Allowed Auth Scopes
- messaging:GetToken
- messaging:read
GetActionTriggerResultCommand
Get result of the triggered action.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 10 | 10 |
| XBS | 3600 | 600 |
| XBS_ANONYMOUS | 10 | 10 |
| XBS_ANONYMOUS | 3600 | 600 |
| PBX | 10 | 30 |
| PBX | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetActionTriggerResult
SendActionTriggerResultCommand
Send result of the triggered action.
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| PBX | 10 | 30 |
| PBX | 3600 | 1800 |
| XBS_BOT | 10 | 30 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:SendActionTriggerResult
GetWhatsAppChannelIdCommand
Gets the channel ID of an existing or non-existing WhatsApp
### Rate Limits
| Authorization Type | Period (seconds) | Requests by period |
| --- | :---: | :---: |
| XBS | 60 | 50 |
| XBS | 3600 | 600 |
| PBX | 60 | 150 |
| PBX | 3600 | 1800 |
| XBS_BOT | 60 | 150 |
| XBS_BOT | 3600 | 1800 |
### Allowed Auth Scopes
- messaging:GetWhatsAppChannelId
- messaging:read
GetOrCreateWhatsAppChannelCommand
Gets or creates a WhatsApp channel
### Allowed Auth Scopes
- messaging:GetOrCreateWhatsAppChannel
- messaging:read
Libraries
- npm
- Yarn
- pnpm
- Bun
npm install @wildix/xbees-conversations-utils
yarn add @wildix/xbees-conversations-utils
pnpm add @wildix/xbees-conversations-utils
bun add @wildix/xbees-conversations-utils