Feishu bot

Feishu (Lark) is a team chat platform used by companies for messaging and collaboration. This plugin connects Mayros to a Feishu/Lark bot using the platform’s WebSocket event subscription so messages can be received without exposing a public webhook URL.

Plugin required

Install the Feishu plugin:

bashCopy
mayros plugins install @apilium/mayros-feishu

Local checkout (when running from a git repo):

bashCopy
mayros plugins install ./extensions/feishu

Quickstart

There are two ways to add the Feishu channel:

Method 1: onboarding wizard (recommended)

If you just installed Mayros, run the wizard:

bashCopy
mayros onboard

The wizard guides you through:

1. Creating a Feishu app and collecting credentials
2. Configuring app credentials in Mayros
3. Starting the gateway

✅ After configuration, check gateway status:

• mayros gateway status
• mayros logs --follow

Method 2: CLI setup

If you already completed initial install, add the channel via CLI:

bashCopy
mayros channels add

Choose Feishu, then enter the App ID and App Secret.

✅ After configuration, manage the gateway:

• mayros gateway status
• mayros gateway restart
• mayros logs --follow

Step 1: Create a Feishu app

1. Open Feishu Open Platform

Visit Feishu Open Platform and sign in.

Lark (global) tenants should use https://open.larksuite.com/app and set domain: "lark" in the Feishu config.

2. Create an app

1. Click Create enterprise app
2. Fill in the app name + description
3. Choose an app icon

3. Copy credentials

From Credentials & Basic Info, copy:

• App ID (format: cli_xxx)
• App Secret

❗ Important: keep the App Secret private.

4. Configure permissions

On Permissions, click Batch import and paste:

jsonCopy
{
  "scopes": {
    "tenant": [
      "aily:file:read",
      "aily:file:write",
      "application:application.app_message_stats.overview:readonly",
      "application:application:self_manage",
      "application:bot.menu:write",
      "contact:user.employee_id:readonly",
      "corehr:file:download",
      "event:ip_list",
      "im:chat.access_event.bot_p2p_chat:read",
      "im:chat.members:bot_access",
      "im:message",
      "im:message.group_at_msg:readonly",
      "im:message.p2p_msg:readonly",
      "im:message:readonly",
      "im:message:send_as_bot",
      "im:resource"
    ],
    "user": ["aily:file:read", "aily:file:write", "im:chat.access_event.bot_p2p_chat:read"]
  }
}

5. Enable bot capability

In App Capability > Bot:

1. Enable bot capability
2. Set the bot name

6. Configure event subscription

⚠️ Important: before setting event subscription, make sure:

1. You already ran mayros channels add for Feishu
2. The gateway is running (mayros gateway status)

In Event Subscription:

1. Choose Use long connection to receive events (WebSocket)
2. Add the event: im.message.receive_v1

⚠️ If the gateway is not running, the long-connection setup may fail to save.

7. Publish the app

1. Create a version in Version Management & Release
2. Submit for review and publish
3. Wait for admin approval (enterprise apps usually auto-approve)

Step 2: Configure Mayros

Configure with the wizard (recommended)

bashCopy
mayros channels add

Choose Feishu and paste your App ID + App Secret.

Configure via config file

Edit ~/.mayros/mayros.json:

json5Copy
{
  channels: {
    feishu: {
      enabled: true,
      dmPolicy: "pairing",
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
          botName: "My AI assistant",
        },
      },
    },
  },
}

If you use connectionMode: "webhook", set verificationToken. The Feishu webhook server binds to 127.0.0.1 by default; set webhookHost only if you intentionally need a different bind address.

Configure via environment variables

bashCopy
export FEISHU_APP_ID="cli_xxx"
export FEISHU_APP_SECRET="xxx"

Lark (global) domain

If your tenant is on Lark (international), set the domain to lark (or a full domain string). You can set it at channels.feishu.domain or per account (channels.feishu.accounts.<id>.domain).

json5Copy
{
  channels: {
    feishu: {
      domain: "lark",
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
        },
      },
    },
  },
}

Step 3: Start + test

1. Start the gateway

bashCopy
mayros gateway

2. Send a test message

In Feishu, find your bot and send a message.

3. Approve pairing

By default, the bot replies with a pairing code. Approve it:

bashCopy
mayros pairing approve feishu <CODE>

After approval, you can chat normally.

Overview

• Feishu bot channel: Feishu bot managed by the gateway
• Deterministic routing: replies always return to Feishu
• Session isolation: DMs share a main session; groups are isolated
• WebSocket connection: long connection via Feishu SDK, no public URL needed

Access control

Direct messages

• Default: dmPolicy: "pairing" (unknown users get a pairing code)

• Approve pairing:

  bashCopy
  mayros pairing list feishu
  mayros pairing approve feishu <CODE>
  

• Allowlist mode: set channels.feishu.allowFrom with allowed Open IDs

Group chats

1. Group policy (channels.feishu.groupPolicy):

• "open" = allow everyone in groups (default)
• "allowlist" = only allow groupAllowFrom
• "disabled" = disable group messages

2. Mention requirement (channels.feishu.groups.<chat_id>.requireMention):

• true = require @mention (default)
• false = respond without mentions

Group configuration examples

Allow all groups, require @mention (default)

json5Copy
{
  channels: {
    feishu: {
      groupPolicy: "open",
      // Default requireMention: true
    },
  },
}

Allow all groups, no @mention required

json5Copy
{
  channels: {
    feishu: {
      groups: {
        oc_xxx: { requireMention: false },
      },
    },
  },
}

Allow specific users in groups only

json5Copy
{
  channels: {
    feishu: {
      groupPolicy: "allowlist",
      groupAllowFrom: ["ou_xxx", "ou_yyy"],
    },
  },
}

Get group/user IDs

Group IDs (chat_id)

Group IDs look like oc_xxx.

Method 1 (recommended)

1. Start the gateway and @mention the bot in the group
2. Run mayros logs --follow and look for chat_id

Method 2

Use the Feishu API debugger to list group chats.

User IDs (open_id)

User IDs look like ou_xxx.

Method 1 (recommended)

1. Start the gateway and DM the bot
2. Run mayros logs --follow and look for open_id

Method 2

Check pairing requests for user Open IDs:

bashCopy
mayros pairing list feishu

Common commands

Note: Feishu does not support native command menus yet, so commands must be sent as text.

Gateway management commands

Troubleshooting

Bot does not respond in group chats

1. Ensure the bot is added to the group
2. Ensure you @mention the bot (default behavior)
3. Check groupPolicy is not set to "disabled"
4. Check logs: mayros logs --follow

Bot does not receive messages

1. Ensure the app is published and approved
2. Ensure event subscription includes im.message.receive_v1
3. Ensure long connection is enabled
4. Ensure app permissions are complete
5. Ensure the gateway is running: mayros gateway status
6. Check logs: mayros logs --follow

App Secret leak

1. Reset the App Secret in Feishu Open Platform
2. Update the App Secret in your config
3. Restart the gateway

Message send failures

1. Ensure the app has im:message:send_as_bot permission
2. Ensure the app is published
3. Check logs for detailed errors

Advanced configuration

Multiple accounts

json5Copy
{
  channels: {
    feishu: {
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
          botName: "Primary bot",
        },
        backup: {
          appId: "cli_yyy",
          appSecret: "yyy",
          botName: "Backup bot",
          enabled: false,
        },
      },
    },
  },
}

Message limits

• textChunkLimit: outbound text chunk size (default: 2000 chars)
• mediaMaxMb: media upload/download limit (default: 30MB)

Streaming

Feishu supports streaming replies via interactive cards. When enabled, the bot updates a card as it generates text.

json5Copy
{
  channels: {
    feishu: {
      streaming: true, // enable streaming card output (default true)
      blockStreaming: true, // enable block-level streaming (default true)
    },
  },
}

Set streaming: false to wait for the full reply before sending.

Multi-agent routing

Use bindings to route Feishu DMs or groups to different agents.

json5Copy
{
  agents: {
    list: [
      { id: "main" },
      {
        id: "clawd-fan",
        workspace: "/home/user/clawd-fan",
        agentDir: "/home/user/.mayros/agents/clawd-fan/agent",
      },
      {
        id: "clawd-xi",
        workspace: "/home/user/clawd-xi",
        agentDir: "/home/user/.mayros/agents/clawd-xi/agent",
      },
    ],
  },
  bindings: [
    {
      agentId: "main",
      match: {
        channel: "feishu",
        peer: { kind: "direct", id: "ou_xxx" },
      },
    },
    {
      agentId: "clawd-fan",
      match: {
        channel: "feishu",
        peer: { kind: "direct", id: "ou_yyy" },
      },
    },
    {
      agentId: "clawd-xi",
      match: {
        channel: "feishu",
        peer: { kind: "group", id: "oc_zzz" },
      },
    },
  ],
}

Routing fields:

• match.channel: "feishu"
• match.peer.kind: "direct" or "group"
• match.peer.id: user Open ID (ou_xxx) or group ID (oc_xxx)

See Get group/user IDs for lookup tips.

Configuration reference

Full configuration: Gateway configuration

Key options:

dmPolicy reference

Supported message types

Receive

• ✅ Text
• ✅ Rich text (post)
• ✅ Images
• ✅ Files
• ✅ Audio
• ✅ Video
• ✅ Stickers

Send

• ✅ Text
• ✅ Images
• ✅ Files
• ✅ Audio
• ⚠️ Rich text (partial support)