Actions38
- Message Actions
- Message Buzz Message Actions
- Message Batch Message Actions
- Message Image Actions
- Message File Actions
- Message Message Card Actions
- Message Message Reaction Actions
- Group Actions
- Group Group Member Actions
- Group Group Announcement Actions
Overview
The "Create A Group" operation in the Lark Messenger node allows users to create a new group chat within the Lark messaging platform. This is useful for automating team collaboration setups, managing communication channels, or integrating group creation into workflows such as onboarding or project management.
Typical use cases include:
- Automatically creating project-specific groups with predefined members and bots.
- Setting up external or internal discussion groups with custom visibility and membership settings.
- Localizing group names using internationalization support.
- Managing group metadata like avatars, descriptions, labels, and message visibility options.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication: "Tenant Token" or "OAuth2". |
| Avatar | URL or identifier for the group's avatar image. |
| Bot Id List | List of bot IDs to add to the group. |
| Chat Mode | Mode of the chat (e.g., normal, announcement). |
| Chat Type | Type of chat group (e.g., private, public). |
| Description | Text description of the group. |
| External | Boolean indicating if the group is external (true) or internal (false). |
| I 18 N Names | Internationalized group names with keys for languages like en_us, ja_jp, zh_cn. |
| Join Message Visibility | Controls who can see join messages in the group. |
| Labels | List of labels/tags associated with the group. |
| Leave Message Visibility | Controls who can see leave messages in the group. |
| Membership Approval | Specifies if membership requires approval (e.g., auto-approved or manual). |
| Name | The display name of the group. |
| Owner Id | User ID of the group owner. |
| User Id List | List of user IDs to add as members to the group. |
| Custom Body | JSON object allowing full customization of the request body sent to the API, overriding other fields. |
| Options > Use Custom Body | Boolean flag to indicate whether to send the custom JSON body instead of individual parameters. |
Output
The node outputs JSON data representing the response from the Lark API after attempting to create the group. This typically includes details about the newly created group such as its unique ID, status, and any metadata returned by the API.
If the operation supports binary data output (not indicated here), it would represent attachments or media related to the group creation, but this node primarily deals with JSON responses.
Dependencies
- Requires an API key credential for authentication, either via a Tenant Token or OAuth2 token.
- The node communicates with the Lark Suite Open APIs at
https://open.larksuite.com/open-apis. - Proper permissions/scopes must be granted to the API credentials to create groups.
- No additional external dependencies beyond standard HTTP requests.
Troubleshooting
- Authentication errors: Ensure that the provided API key or OAuth2 token is valid and has the necessary permissions.
- Invalid input data: Missing required fields like
nameor invalid formats in lists (e.g.,user_id_list) may cause API errors. - Custom Body conflicts: When "Use Custom Body" is enabled, ensure the JSON structure matches the API specification exactly; otherwise, the request may fail.
- API rate limits: Frequent group creation requests might hit rate limits imposed by Lark's API.
- Network issues: Verify network connectivity and endpoint accessibility.
Common error messages might include:
- Unauthorized or forbidden access due to invalid credentials.
- Validation errors specifying which field is incorrect or missing.
- Rate limit exceeded warnings.
Resolving these usually involves checking credentials, validating input data, and respecting API usage policies.