Actions290
- Task Actions
- Direct API Actions
- CRM Actions
- User Actions
- SPA Actions
- Activity Actions
- Automation Actions
- Document Generator Actions
- Data Storage Actions
- Get Entity
- Add Entity
- Update Entity
- Delete Entity
- Get Entity Rights
- Get Entity Sections
- Add Entity Section
- Update Entity Section
- Delete Entity Section
- Get Entity Item
- Add Entity Item
- Update Entity Item
- Delete Entity Item
- Get Entity Item Properties
- Add Entity Item Property
- Update Entity Item Property
- Delete Entity Item Property
- Chat Actions
- User Field Actions
- File Actions
- User Field Config Actions
- Duplicate Actions
- Timeline Actions
- Disk Actions
- Upload File
- Download File
- Delete File
- Get File Info
- List Files
- Create Folder
- Delete Folder
- Get Storage Info
- Get Storages
- Get Storage
- Get Folders
- Get Folder
- Add Folder
- Update Folder
- Copy Folder
- Move Folder
- Rename Folder
- Get Files
- Get File
- Copy File
- Move File
- Rename File
- Share Item
- Get Shared Items
- Get Sharing Rights
- Update Sharing Rights
- Workflow Actions
- Status Actions
- Calendar Actions
- Chatbot Actions
- Events Actions
- Lists Actions
- Product Actions
- Open Lines Actions
- Telephony Actions
- Register External Call
- Finish External Call
- Hide External Call
- Show External Call
- Search CRM Entities
- Attach Call Record
- Get External Line
- Add External Line
- Update External Line
- Delete External Line
- Get Voximplant Statistics
- Get Voximplant Line
- Get Voximplant SIP Connector
- Get Voximplant SIP Line
- Add Voximplant SIP Line
- Update Voximplant SIP Line
- Delete Voximplant SIP Line
- Message Service Actions
- Notify Actions
Overview
This node interacts with the Bitrix24 platform, specifically providing operations related to chatbots within Bitrix24. The "List Chat Users" operation under the "Chatbot" resource retrieves a list of users participating in a specified chat. This is useful for scenarios where you need to manage or analyze chat participants, such as monitoring active users, sending targeted messages, or managing user permissions within chats.
Practical examples include:
- Fetching all users in a customer support chat to send announcements.
- Auditing chat membership for compliance or reporting.
- Integrating chat user data into other workflows or CRMs.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key. |
| Bot ID | Identifier of the chatbot performing the operation. |
| Chat ID | Identifier of the chat whose users are to be listed. |
| Options | Additional optional parameters that can customize the request, including: |
| - Client ID | Client identifier for the request. |
| - Open Line ID | Identifier for an open communication line. |
| - Language ID | Language code for localization. |
| - Bot Description | Description text for the bot. |
| - Bot Avatar | URL pointing to the bot's avatar image. |
| - Command Description | Description of a command (if applicable). |
| - Is Common | Boolean flag indicating if a command is common. |
| - Is Hidden | Boolean flag indicating if a command is hidden. |
| - Allow Extranet | Boolean flag to allow extranet access. |
| - Message Type | Type of message sent or processed: "Text" or "System". |
| - Attachments | JSON array describing attachments to include. |
| - Keyboard Buttons | JSON array defining keyboard layout/buttons. |
| - URL Preview | Boolean to enable or disable URL preview in messages. |
| - Custom Parameters | JSON object for any additional custom parameters. |
| - Access Token | Access token string for authentication purposes. |
Output
The node outputs an array of items, each containing a json field with the data returned from Bitrix24. For the "List Chat Users" operation, this typically includes details about each user in the chat, such as user IDs, names, roles, and possibly status information depending on Bitrix24's API response.
If the node supports binary data output (not explicitly shown here), it would represent files or media associated with chat users or messages, but this operation primarily deals with JSON user data.
Dependencies
- Requires connection to Bitrix24 via one of the supported authentication methods: OAuth2, webhook URL, or API key.
- Needs proper configuration of credentials in n8n corresponding to the chosen authentication method.
- Relies on Bitrix24 API endpoints to fetch chat user data.
- No additional external libraries beyond those bundled with the node are required.
Troubleshooting
- Authentication errors: Ensure the selected authentication method is correctly configured with valid credentials or tokens.
- Invalid Bot ID or Chat ID: Verify that the provided Bot ID and Chat ID exist and the bot has permission to access the chat.
- API rate limits or connectivity issues: Bitrix24 may throttle requests; handle retries or check network connectivity.
- Malformed JSON in options: If using JSON fields like attachments or keyboard buttons, ensure the JSON syntax is correct to avoid parsing errors.
- Error messages from Bitrix24 API: These will be surfaced in the output if "Continue On Fail" is enabled; otherwise, they cause execution failure. Review error details for missing permissions or invalid parameters.