Feishu

The Feishu channel connects over a WebSocket long connection, so it needs no public callback URL and works from a local or intranet deployment. The Feishu channel currently supports:

Interactive card approval: when an agent calls a tool that needs approval, it asks for confirmation as a card in Feishu; click a button to allow or deny;
Streaming replies: the agent’s answer updates within a single message as it is generated;
Multimodal input: receive images, files, and voice messages from users and pass them to the agent;
Markdown: replies render as Markdown, and overly long content is split automatically.

Connecting takes three steps: create an app on the Feishu Open Platform and get its credentials, start an agent service to host the channel, then add the Feishu channel in the management UI.

Prerequisites

The Feishu channel depends on lark-oapi, installed with the channel extra:

Install the dependency

pip install "agentscope[channel]"

Create the app

Create and configure the bot on the Feishu Open Platform; it takes a few minutes.

Create a custom app

In the developer console, create a “custom app” and fill in its name and icon.

Record the App ID and App Secret

On the “Credentials & Basic Info” page, copy the App ID and App Secret to fill into the channel config later. The App Secret is a secret; keep it safe.

Enable the bot capability

Under “Add features”, enable “Bot” so the app can send and receive messages.

Subscribe to events (long connection)

On the “Events & callbacks” page, set the delivery method to long connection, with no callback URL. Subscribe to the “receive message” event im.message.receive_v1; card approval also needs the card callback event card.action.trigger.

Request permissions

Under “Permissions & Scopes”, request the message permissions: receive messages, and send messages as the app (both DMs and groups). If you want to list the bot’s groups while configuring routing, also request the group-list permission. Refer to the Feishu docs for the exact scopes.

Publish a version

Create and publish an app version so it becomes available in your organization. You can then add the bot to a group or DM it directly.

Start the agent service

A channel runs on top of an agent service. Start the service with create_app and declare the accepted channel types via channels. Channels depend on a message bus (message_bus); use InMemoryMessageBus for single-machine development, and switch to RedisMessageBus for multi-process or multi-node deployment.

Start an agent service that hosts the channel

from agentscope.app import create_app
from agentscope.app.channel import FeishuChannel
from agentscope.app.message_bus import InMemoryMessageBus
from agentscope.app.storage import RedisStorage
from agentscope.app.workspace_manager import LocalWorkspaceManager

app = create_app(
    storage=RedisStorage(host="localhost", port=6379),
    # In-memory bus for single-machine dev; switch to RedisMessageBus for multi-node
    message_bus=InMemoryMessageBus(),
    workspace_manager=LocalWorkspaceManager(basedir="./workspaces"),
    channels=[FeishuChannel],   # channel types this service accepts
)
# After starting with uvicorn, the channel feature is ready
# uvicorn.run(app, host="0.0.0.0", port=8000)

Add the channel

In the management UI (see the sample frontend examples/web_ui), add a channel through a visual form, with no config to write by hand.

Create a channel and pick Feishu

On the channel management page, create a channel and choose “Feishu” as the platform type.

Fill in the credentials

Enter the App ID and App Secret from the previous step into the credential form.

Configure routing rules

Choose which agent handles messages and how sessions are scoped. See Message routing for what the rules mean.

Save and enable

Save and enable the channel; the service opens the Feishu long connection immediately and the bot comes online. Add it to a group or start a DM to begin.

The management UI maps onto the /channels endpoints; call them directly when you need to create channels programmatically. See the API part of this chapter for the fields.

Platform config

The Feishu channel has a few platform-specific switches:

Field	Description	Default
`only_at_reply`	In group chats, reply only when the bot is @mentioned. DMs are unaffected and always answered	`true`
`show_thinking`	Include the model’s reasoning in the reply	`false`
`show_tool_process`	Include tool calls and results in the reply	`false`

If you want the bot to join group discussions freely like any member, turn only_at_reply off; leaving it on (the default) keeps the bot from being too active in groups.

Verify and troubleshoot

Check the channel status in the management UI, or call GET /channels/{id}/status to confirm the long connection is established.
If the bot doesn’t respond in a group, first check only_at_reply and the @-mention behavior, then check that the message-receive permission was requested and published with the version.
If the bot never comes online, check the App ID / App Secret and that event subscription is set to the long-connection method.

Message routing

Route different groups to different agents.

Discord

Connect Discord with the same flow.

Get Started

Building Blocks

Agent as Service

Others

Prerequisites

Create the app

Start the agent service

Add the channel

Platform config

Verify and troubleshoot

Further reading

Message routing

Discord

​Prerequisites

​Create the app

​Start the agent service

​Add the channel

​Platform config

​Verify and troubleshoot

​Further reading

Message routing

Discord

Prerequisites

Create the app

Start the agent service

Add the channel

Platform config

Verify and troubleshoot

Further reading