Lark Messenger icon

Lark Messenger

Lark Messenger Management

Overview

This node, named "Lark Messenger," is designed to send Buzz messages within the Lark (Feishu) messaging platform. Specifically, the "Send Buzz Messages In Apps" operation allows users to notify or alert a list of users by buzzing a particular message identified by its message ID. This can be useful in scenarios where you want to draw attention to an important message or announcement inside Lark apps.

Practical examples include:

  • Alerting team members about urgent updates on a project message.
  • Notifying users that require immediate action related to a specific conversation.
  • Highlighting announcements or reminders in group chats or channels.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
User Id Type The category/type of user IDs provided. Optional values: open_id, union_id, user_id.
Message Id The unique identifier of the message to be buzzed. This is required.
User Id List A collection of user IDs to receive the buzz notification. Multiple user IDs can be added.
Custom Body A JSON object allowing the user to specify a custom request body instead of the standard format.
Options > Use Custom Body Boolean flag indicating whether to send a custom request body instead of the default one.

Output

The node outputs JSON data representing the response from the Lark API after attempting to send the buzz message. This typically includes success status and any relevant metadata returned by the API.

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

Dependencies

  • Requires access to the Lark (Feishu) Open API endpoint at https://open.larksuite.com/open-apis.
  • Requires either a Tenant Token or OAuth2 credentials for authentication.
  • Proper configuration of these credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Invalid or missing Message Id: The node requires a valid message ID to buzz. Ensure the message ID exists and is correctly input.
  • Authentication errors: If the Tenant Token or OAuth2 credentials are invalid or expired, the API call will fail. Refresh or reconfigure credentials as needed.
  • User Id Type mismatch: Providing an incorrect user ID type may cause the API to reject the request. Confirm the user ID type matches the IDs supplied.
  • Empty User Id List: Sending a buzz without specifying any users will likely result in an error or no action. Make sure to add at least one user ID.
  • Custom Body usage: When using a custom body, ensure the JSON structure matches the API requirements; otherwise, the request may fail.

Links and References

Discussion