API 参考 / feishu-integrations

读取项目飞书入站机器人配置

GET /api/v1/projects/{projectId}/integrations/feishu · getProjectFeishuIntegration

读取项目级飞书入站配置。密钥字段(App Secret / Verification Token / Encrypt Key)与 App ID 均不回显明文,只返回 masked/configured 状态;需要 view_project。

鉴权:项目 API Token(Authorization: Bearer wfp_…)。详见 Agent 接入。

参数

projectId(必填)
string

响应字段 · 200

enabled(必填)
boolean
integrationId(必填)
string
subscriptionStatus(必填)
enum —— 事件订阅健康状态,从真实状态派生(不造假绿点):not_configured=未保存配置或未启用;error=已启用且最近一条入站消息处理失败(事件已到达但建缺陷失败);ok=已启用且近期无处理失败。;取值:ok / error / not_configured
subscriptionError
string —— subscriptionStatus=error 时的失败摘要(已脱敏,绝不含密钥);其余状态为空字符串。
lastReceivedAt
string —— 最近一条入站飞书消息的接收时间(ISO 8601,任意处理状态计入;URL 校验 challenge 不算事件不计)。尚未收到任何消息时为空字符串。前端据此展示「最近 N 分钟前」相对时间。
boundMemberCount(必填)
integer —— 已绑定飞书账号的项目成员数(只读聚合)。未接入飞书时为 0。
totalMemberCount(必填)
integer —— 项目 active 成员总数(绑定率分母)。未接入飞书时为 0。
callbackUrl(必填)
string —— 飞书事件订阅回调 URL,用于消息入站;包含 opaque integrationId,重新生成后会变化。
oauthRedirectUrl(必填)
string —— 飞书账号绑定 OAuth 固定重定向 URL,用于开发配置 > 安全设置 > 重定向 URL;不包含 integrationId,不随项目回调 secret 变化。
appIdMasked(必填)
string
appSecretConfigured(必填)
boolean
verificationTokenConfigured(必填)
boolean
encryptKeyConfigured(必填)
boolean
chatId(必填)
string
defaultOwnerId(必填)
string
actorUserId(必填)
string —— 创建 bug 时使用的 GameFlow actor;空表示尚未保存配置。
createdAt(必填)
string
updatedAt(必填)
string

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/projects/{projectId}/integrations/feishu" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "enabled": true,
  "integrationId": "018f3c2e-0000-7000-8000-000000000000",
  "subscriptionStatus": "ok",
  "boundMemberCount": 1,
  "totalMemberCount": 1,
  "callbackUrl": "https://example.com",
  "oauthRedirectUrl": "https://example.com",
  "appIdMasked": "示例文本",
  "appSecretConfigured": true,
  "verificationTokenConfigured": true,
  "encryptKeyConfigured": true,
  "chatId": "018f3c2e-0000-7000-8000-000000000000",
  "defaultOwnerId": "018f3c2e-0000-7000-8000-000000000000",
  "actorUserId": "018f3c2e-0000-7000-8000-000000000000",
  "createdAt": "示例文本",
  "updatedAt": "2026-08-01"
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…