Feishu Node icon

Feishu Node

Feishu Node

Actions106

Overview

This node enables batch sending of messages through the Feishu platform. It supports multiple message types such as text, image, rich text (post), shared group cards, and interactive cards. The node is useful for scenarios where you need to broadcast or send customized messages to multiple users or departments simultaneously within an organization using Feishu.

Practical examples include:

  • Sending company-wide announcements or updates to specific departments.
  • Distributing marketing materials or notifications to selected user groups.
  • Sharing interactive cards with actionable content to enhance engagement.

Properties

Name Meaning
消息类型 (msg_type) Message type to send. Options: 文本 (text), 图片 (image), 富文本 (post), 分享群名片 (share_chat), 卡片 (interactive)
消息内容 (content) JSON structure representing the message content for types: text, image, post, share_chat. Example: {"text":"要发送的文本消息"}
卡片内容 (card) JSON structure defining the interactive card content. Used only when 消息类型 is 卡片 (interactive). Reference: https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/send-feishu-card
部门 ID 列表 (department_ids) JSON array of department IDs to which the message will be sent.
用户 Open_id 列表 (open_ids) JSON array of user Open_id identifiers to receive the message.
用户 User_id 列表 (user_ids) JSON array of user User_id identifiers to receive the message.
用户 Union_id 列表 (union_ids) JSON array of user Union_id identifiers to receive the message.

Output

The node outputs a JSON array where each element corresponds to the result of sending a message for each input item processed. Each output item contains the response data from the Feishu API call related to the batch message sending operation.

If errors occur during execution and "Continue On Fail" is enabled, error details are included in the output JSON under an error field.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Feishu platform.
  • The node depends on Feishu's messaging API endpoints to perform batch message sending.
  • Proper configuration of credentials in n8n is necessary to authorize API requests.

Troubleshooting

  • Common issues:
    • Invalid or expired API credentials causing authentication failures.
    • Incorrectly formatted JSON in message content or card fields leading to API errors.
    • Specifying empty or invalid user or department ID lists resulting in no recipients.
  • Error messages:
    • Errors thrown by the Feishu API are captured and can appear in the output if "Continue On Fail" is enabled.
    • NodeOperationError may be raised if the specified resource-operation combination is not implemented.
  • Resolutions:
    • Verify and update API credentials.
    • Validate JSON structures before inputting them into the node.
    • Ensure recipient ID lists are correctly populated and valid.

Links and References

Discussion