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
This node interacts with the Lark Messenger API to query the overall progress of a batch message. It is useful in scenarios where you send messages in bulk (batch messages) and want to monitor their delivery status or progress. For example, if you have sent a notification to multiple users via a batch message, this node helps you check how many recipients have received or read the message.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
| Batch Message Id | The unique identifier of the batch message whose progress you want to query. |
| Options | Additional options; currently supports "Use Custom Body" (boolean) to specify if a custom request body should be used. |
Output
The node outputs JSON data representing the overall progress of the queried batch message. This typically includes details such as the number of messages sent, delivered, read, or failed within the batch. The exact structure depends on the Lark Messenger API response for batch message progress queries.
No binary data output is indicated.
Dependencies
- Requires access to the Lark Messenger API.
- Requires an API authentication token, either via a Tenant Token credential or OAuth2 credential configured in n8n.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper permissions/scopes must be granted to the API credentials to query batch message statuses.
Troubleshooting
- Invalid or missing Batch Message Id: Ensure the batch message ID is correctly provided and corresponds to an existing batch message.
- Authentication errors: Verify that the selected authentication method is properly configured and the token is valid.
- API rate limits or permission issues: Check that your API credentials have sufficient permissions and are not hitting rate limits.
- Unexpected API responses: If the API returns errors, review the error message for clues (e.g., batch message expired or deleted).
- Using Custom Body option: If enabled, ensure the custom body format matches the API requirements to avoid request failures.