记录record io.agentscope.extensions.channel.feishu 2.x

FeishuChannelProperties

public record FeishuChannelProperties( String appId, String appSecret, String encryptKey, String verificationToken, String callbackPath, String apiBase)

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

承载 Feishu 渠道属性数据的记录类型。位于 io.agentscope.extensions.channel.feishu 包。核心成员包括 appId、appSecret、encryptKey、verificationToken、callbackPath、apiBase。

Provider-specific configuration for a single Feishu (飞书 / Lark) channel instance, sourced from the properties block of channels.<id> in agentscope.json.

记录组件摘要Record Component Summary

组件Component	类型Type	说明Description
`appId`	String	执行应用标识相关操作。 Feishu custom-app id (cli_xxx)
`appSecret`	String	执行应用密钥相关操作。 Feishu custom-app secret
`encryptKey`	String	执行 `encryptKey` 方法。 optional Encrypt Key configured in the developer console; when non-blank the callback body is AES-256-CBC encrypted and must be decrypted before parsing
`verificationToken`	String	执行 `verificationToken` 方法。 optional Verification Token configured in the developer console; when non-blank the `token` field of the URL verification challenge is matched against it
`callbackPath`	String	执行回调路径相关操作。 HTTP path Spring exposes the callback under; defaults to `/api/channels/feishu/{channelId}/callback`
`apiBase`	String	执行API 基类相关操作。 override for the Feishu Open API base URL; default `https://open.feishu.cn`

构造器摘要Constructor Summary

构造器Constructor	说明Description
`public` `FeishuChannelProperties(String appId, String appSecret, String encryptKey, String verificationToken, String callbackPath, String apiBase)`	初始化 `FeishuChannelProperties` 实例。 Creates a new instance.

方法摘要Method Summary

方法Method	说明Description
`public static` `FeishuChannelProperties from(String channelId, Map<String, Object> props)` static	创建并返回实例。 Reads a `FeishuChannelProperties` from an arbitrary properties map.
`public boolean isEncrypted()`	判断是否已加密。 Whether AES-256-CBC payload decryption is enabled for this channel.

记录组件详情Record Component Detail

appId

String appId

执行应用标识相关操作。

Feishu custom-app id (cli_xxx)

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

appSecret

String appSecret

执行应用密钥相关操作。

Feishu custom-app secret

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

encryptKey

String encryptKey

执行 encryptKey 方法。

optional Encrypt Key configured in the developer console; when non-blank the callback body is AES-256-CBC encrypted and must be decrypted before parsing

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

verificationToken

String verificationToken

执行 verificationToken 方法。

optional Verification Token configured in the developer console; when non-blank the token field of the URL verification challenge is matched against it

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

callbackPath

String callbackPath

执行回调路径相关操作。

HTTP path Spring exposes the callback under; defaults to /api/channels/feishu/{channelId}/callback

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

apiBase

String apiBase

执行API 基类相关操作。

override for the Feishu Open API base URL; default https://open.feishu.cn

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:35–83

构造器详情Constructor Detail

FeishuChannelProperties

public FeishuChannelProperties(String appId, String appSecret, String encryptKey, String verificationToken, String callbackPath, String apiBase)

初始化 FeishuChannelProperties 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`appId`	String	应用标识（类型 `String`）。The app id.
`appSecret`	String	应用密钥（类型 `String`）。The app secret.
`encryptKey`	String	encrypt 键（类型 `String`）。The encrypt key.
`verificationToken`	String	verification 令牌（类型 `String`）。The verification token.
`callbackPath`	String	回调路径（类型 `String`）。The callback path.
`apiBase`	String	API 基类（类型 `String`）。The api base.

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:43–53

方法详情Method Detail

from

public static FeishuChannelProperties from(String channelId, Map<String, Object> props)

static

创建并返回实例。

Reads a FeishuChannelProperties from an arbitrary properties map.

参数Parameters

名称Name	类型Type	说明Description
`channelId`	String	渠道标识（类型 `String`）。The channel id.
`props`	Map<String, Object>	props（类型 `Map`）。The props.

返回Returns FeishuChannelProperties

返回FeishuChannelProperties。Returns feishu channel properties.

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:56–67

isEncrypted

public boolean isEncrypted()

判断是否已加密。

Whether AES-256-CBC payload decryption is enabled for this channel.

返回Returns boolean

返回布尔值，表示判断结果。Returns a boolean result.

源码Source io/agentscope/extensions/channel/feishu/FeishuChannelProperties.java:70–72