Lark Messenger icon

Lark Messenger

Lark Messenger Management

Actions38

Overview

This node interacts with the Lark Messenger API to query statistics about a batch message. Specifically, it retrieves the number of users to whom a particular batch message was pushed and how many of those users have read the message. This functionality is useful for monitoring message reach and engagement within an organization using Lark Messenger.

Practical examples include:

  • Tracking the effectiveness of internal announcements by seeing how many employees received and read a batch message.
  • Generating reports on communication outreach in teams or departments.
  • Triggering follow-up actions if a message has low read rates.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: "Tenant Token" or "OAuth2".
Batch Message Id The unique identifier of the batch message to query.
Options Additional optional settings. Currently supports:
- Use Custom Body Boolean flag indicating whether to send a custom request body instead of the default one.

Output

The node outputs JSON data containing statistics about the batch message's delivery and read status. The exact structure typically includes fields such as:

  • Total number of users the batch message was pushed to.
  • Number of users who have read the batch message.

If binary data were involved (e.g., attachments), it would be summarized accordingly, but this node focuses on JSON response data related to message statistics.

Dependencies

  • Requires access to the Lark Messenger API endpoint at https://open.larksuite.com/open-apis.
  • Needs valid authentication credentials, either via a Tenant Token or OAuth2 token.
  • Proper configuration of these credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Authentication errors: Ensure that the provided Tenant Token or OAuth2 credentials are valid and have sufficient permissions to access batch message data.
  • Invalid Batch Message Id: Verify that the batch message ID exists and is correctly input; otherwise, the API will return an error or empty results.
  • API rate limits: Frequent queries might hit API rate limits; consider adding delays or handling rate limit responses gracefully.
  • Use Custom Body option: If enabled incorrectly, the custom body may cause malformed requests leading to API errors. Use this option only if you need to override the default request payload.

Links and References

Discussion