Lark Messenger icon

Lark Messenger

Lark Messenger Management

Actions38

Overview

This node integrates with Lark Messenger to manage group chats, specifically allowing users or bots to be added to a group chat. It is useful in scenarios where you want to programmatically manage membership of group conversations, such as onboarding new team members into project channels or adding service bots for automation within a chat group.

Practical examples include:

  • Automatically adding newly hired employees to relevant department group chats.
  • Adding notification bots to group chats to post updates or alerts.
  • Managing membership dynamically based on external triggers or workflows.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: "Tenant Token" (using a tenant-level API token) or "OAuth2" (using OAuth2 authentication flow).
Chat Id The unique identifier of the group chat where users or bots will be added. This is required and must be a valid group ID.
Id List A collection of user or bot IDs to add to the group chat. Multiple IDs can be specified.
Custom Body An optional JSON body that can be used to override the default request payload when adding users or bots.
Use Custom Body Boolean option to toggle whether to use the custom JSON body instead of the standard parameters.

Output

The node outputs JSON data representing the response from the Lark Messenger API after attempting to add users or bots to the specified group chat. This typically includes success status, any error messages, and details about the updated group membership.

If binary data were involved (not indicated here), it would represent files or media related to the operation, but this node focuses solely on JSON responses.

Dependencies

  • Requires access to Lark Messenger's Open API.
  • Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
  • Network connectivity to https://open.larksuite.com/open-apis is necessary.

Troubleshooting

  • Invalid Chat Id: If the provided group chat ID is incorrect or does not exist, the API will return an error. Verify the chat ID format and existence.
  • Authentication Errors: Using invalid or expired tokens will cause authentication failures. Ensure credentials are correctly set up and valid.
  • Empty or Invalid Id List: Providing no user/bot IDs or malformed IDs will result in errors. Confirm that the list contains valid identifiers.
  • API Rate Limits: Frequent calls may hit rate limits imposed by Lark Messenger. Implement retries or backoff strategies if needed.
  • Custom Body Misconfiguration: When using the custom body option, ensure the JSON structure matches the API requirements to avoid request failures.

Links and References

Discussion