跳到正文
FunCoding

搜索

搜索文档、Skill 和 MCP

消息呈现

用于渠道插件的语义化消息卡片、图表、表格、控件、回退文本和投递提示

消息呈现是 OpenClaw 用于丰富出站聊天 UI 的共享契约。 它让智能体、CLI 命令、审批流程和插件只需描述一次消息 意图,同时由各渠道插件尽可能渲染出最佳的原生形式。

使用呈现功能构建可移植的消息 UI:文本区块、小段上下文/页脚 文本、分隔线、图表、表格、按钮、选择菜单,以及卡片标题/语气。

不要向共享消息工具添加新的提供商原生字段,例如 Discord components、Slack blocks、Telegram buttons、Teams card 或 Feishu card。这些是由渠道插件 所有的渲染器输出。

契约

插件作者从以下位置导入公共契约:

import type {
  MessagePresentation,
  ReplyPayloadDelivery,
} from "openclaw/plugin-sdk/interactive-runtime";

结构:

type MessagePresentation = {
  title?: string;
  tone?: "neutral" | "info" | "success" | "warning" | "danger";
  blocks: MessagePresentationBlock[];
};

type MessagePresentationBlock =
  | { type: "text"; text: string }
  | { type: "context"; text: string }
  | { type: "divider" }
  | { type: "buttons"; buttons: MessagePresentationButton[] }
  | { type: "select"; placeholder?: string; options: MessagePresentationOption[] }
  | {
      type: "chart";
      chartType: "pie";
      title: string;
      segments: Array<{ label: string; value: number }>;
    }
  | {
      type: "chart";
      chartType: "bar" | "area" | "line";
      title: string;
      categories: string[];
      series: Array<{ name: string; values: number[] }>;
      xLabel?: string;
      yLabel?: string;
    }
  | {
      type: "table";
      caption: string;
      headers: string[];
      rows: Array<Array<string | number>>;
      rowHeaderColumnIndex?: number;
    };

type MessagePresentationAction =
  | { type: "command"; command: string }
  | { type: "callback"; value: string }
  | {
      type: "approval";
      approvalId: string;
      approvalKind: "exec" | "plugin";
      decision: "allow-once" | "allow-always" | "deny";
    }
  | {
      type: "question";
      questionId: string;
      optionValue: string;
    }
  | { type: "url"; url: string }
  | {
      type: "web-app";
      url: string;
      widgetId?: string;
    }
  | {
      type: "web-app";
      url?: string;
      widgetId: string;
    };

type MessagePresentationButton = {
  label: string;
  action?: MessagePresentationAction;
  /** Legacy callback value. Prefer action for new controls. */
  value?: string;
  /** @deprecated Use an action with type "url". */
  url?: string;
  /** @deprecated Use an action with type "web-app". */
  webApp?: { url: string };
  /** @deprecated Use an action with type "web-app". */
  web_app?: { url: string };
  priority?: number;
  disabled?: boolean;
  reusable?: boolean;
  style?: "primary" | "secondary" | "success" | "danger";
};

type MessagePresentationOption = {
  label: string;
  action?: Extract<MessagePresentationAction, { type: "command" | "callback" }>;
  /** Legacy callback value. Prefer action for new controls. */
  value?: string;
};

type ReplyPayloadDelivery = {
  pin?:
    | boolean
    | {
        enabled: boolean;
        notify?: boolean;
        required?: boolean;
      };
};

按钮语义:

  • action.type: "command" 通过核心的命令 路径运行原生斜杠命令。将其用于内置命令按钮和菜单。
  • action.type: "callback" 通过渠道的交互 路径传递不透明的插件数据。渠道插件不得将回调数据重新解释为斜杠 命令。
  • action.type: "approval" 标识一项持久的操作员审批、其 明确的 exec 或 plugin 类型,以及请求的决定。渠道插件 将该操作编码为传输层私有回调,并通过 审批服务解析它;不得解析 /approve 命令文本,也不得根据 ID 推断 类型。
  • action.type: "question" 标识实时、由运行时创建的 ask_user 问题中的一个选项。与 approval 一样,这是 OpenClaw 运行时操作; 智能体和插件不得自行生成问题 ID。Telegram、Discord 和 Slack 将其映射为传输层私有的原生回调,并通过 Gateway 网关 解析选择。当问题已回答、已过期或 已取消时,这些渠道会编辑已送达的消息,移除其操作, 并附加最终状态。WhatsApp、Signal 和 iMessage 将最多 四个单选选项渲染为 1️⃣ 至 4️⃣ 表情回应。其他问题 形式会降级为标签文本,用户可以通过纯文本 回复作答。
  • action.type: "url" 打开普通链接。
  • action.type: "web-app" 启动渠道原生 Web 应用。为基于 URL 的应用设置 url,或为启动机制 由渠道所有的 OpenClaw 托管小组件设置 widgetId;至少需要设置其中一个。两者都 存在时,渠道可以优先使用其原生托管小组件启动方式,并在该机制 不可用时使用 URL。
  • value 是旧版不透明回调值。新控件应使用 action, 以便渠道插件无需根据文本猜测即可映射命令和回调。
  • url、webApp 和 web_app 仍作为已弃用的边界输入被接受。 规范化器会保留这些字段,使渲染器能够区分已发布的旧版 语义与显式类型化操作。新的生成方应使用 action。
  • label 是必需的,也用于文本回退。
  • style 仅供参考。渲染器应将不支持的样式映射到安全的 默认样式,而不是导致发送失败。
  • priority 是可选的。当渠道声明了操作数量限制且必须 丢弃部分控件时,核心会优先保留优先级较高的按钮,并在 优先级相同时保持原始顺序。当所有控件都能容纳时,则保留编写时的 顺序。
  • disabled 是可选的。渠道必须通过 supportsDisabled 明确启用;否则 核心会将禁用的控件降级为非交互式回退文本。禁用的 按钮在回退文本中始终只渲染标签,即使它 携带 command 操作。
  • reusable 是可选的。支持可复用原生回调的渠道可以 在成功交互后继续保留该操作。将其用于 刷新、检查或查看更多详情等可重复或幂等操作; 对于普通的一次性审批和破坏性操作,请不要设置它。

选择菜单语义:

  • options[].action 仅接受 command 或 callback;审批和链接操作只能用于按钮。
  • options[].value 是旧版选定应用值。
  • placeholder 仅供参考,没有原生 选择菜单支持的渠道可以忽略它。
  • 如果渠道不支持选择菜单,回退文本会列出各个标签。

图表语义:

  • pie 要求分段值为正数。
  • bar、area 和 line 使用一个有序的 categories 数组。每个序列 必须按相同顺序为每个类别提供恰好一个有限数值。
  • 类别标签和序列名称必须唯一。无效或不完整的图表 区块会在规范化期间被丢弃,而不会静默更改数据。
  • 原生图表渲染通过 presentationCapabilities.charts 明确启用。 其他渠道会以确定性文本形式接收图表标题、坐标轴、类别、序列和值。 这也是无障碍回退形式。

表格语义:

  • caption 是必需的简短标题。headers 必须至少包含一个 唯一且非空的列标签。

  • rows 必须至少包含一行。每行的单元格数量必须与 表头数量完全一致,且每个单元格必须是非空字符串或有限数值。

  • rowHeaderColumnIndex 是可选的从零开始的索引,用于标识原生渲染器 应将其中单元格公开为行标题的列。

  • 表格规范化是原子性的。无效的说明文字、表头、行宽、单元格 或行标题索引会导致整个表格区块被丢弃,而不是截断或修复 其数据。

  • 原生表格渲染通过 presentationCapabilities.tables 明确启用。 其他渠道会以确定性的线性 文本形式接收说明文字和每一行,并折叠内部空白:

    开放销售管道(表格)
    - 客户:Acme;阶段:已赢单;ARR:125000
    - 客户:Globex;阶段:审核;ARR:82000

不存在单独的 report 判别字段。使用 title、 tone、text、context、chart、table 和操作区块组合报告。这样可以让每个 区块都能独立渲染,并使完整报告拥有相同的 确定性文本回退形式。

生成方示例

简单卡片:

{
  "title": "部署审批",
  "tone": "warning",
  "blocks": [
    { "type": "text", "text": "金丝雀版本已准备好晋升。" },
    { "type": "context", "text": "构建 1234,预发布环境已通过。" },
    {
      "type": "buttons",
      "buttons": [
        {
          "label": "批准",
          "action": { "type": "callback", "value": "deploy:approve" },
          "style": "success"
        },
        {
          "label": "拒绝",
          "action": { "type": "callback", "value": "deploy:decline" },
          "style": "danger"
        }
      ]
    }
  ]
}

仅含 URL 的链接按钮:

{
  "blocks": [
    { "type": "text", "text": "发布说明已准备就绪。" },
    {
      "type": "buttons",
      "buttons": [
        {
          "label": "打开说明",
          "action": { "type": "url", "url": "https://example.com/release" }
        }
      ]
    }
  ]
}

Telegram Mini App 按钮:

{
  "blocks": [
    {
      "type": "buttons",
      "buttons": [
        {
          "label": "启动",
          "action": { "type": "web-app", "url": "https://example.com/app" }
        }
      ]
    }
  ]
}

选择菜单:

{
  "title": "选择环境",
  "blocks": [
    {
      "type": "select",
      "placeholder": "环境",
      "options": [
        { "label": "金丝雀", "value": "env:canary" },
        { "label": "生产环境", "value": "env:prod" }
      ]
    }
  ]
}

图表:

{
  "blocks": [
    {
      "type": "chart",
      "chartType": "line",
      "title": "季度收入",
      "categories": ["第一季度", "第二季度", "第三季度"],
      "series": [
        { "name": "产品", "values": [120, 145, 138] },
        { "name": "服务", "values": [80, 95, 104] }
      ],
      "xLabel": "季度",
      "yLabel": "收入"
    }
  ]
}

表格报告:

{
  "title": "销售管道报告",
  "tone": "info",
  "blocks": [
    { "type": "text", "text": "按阶段划分的当前商机。" },
    {
      "type": "table",
      "caption": "开放销售管道",
      "headers": ["客户", "阶段", "ARR"],
      "rows": [
        ["Acme", "已赢单", 125000],
        ["Globex", "审核", 82000]
      ],
      "rowHeaderColumnIndex": 0
    },
    { "type": "context", "text": "已根据 CRM 快照更新。" }
  ]
}

CLI 发送:

openclaw message send --channel slack \
  --target channel:C123 \
  --message "部署审批" \
  --presentation '{"title":"部署审批","tone":"warning","blocks":[{"type":"text","text":"金丝雀版本已准备就绪。"},{"type":"buttons","buttons":[{"label":"批准","value":"deploy:approve","style":"success"},{"label":"拒绝","value":"deploy:decline","style":"danger"}]}]}'

置顶投递:

openclaw message send --channel telegram \
  --target -1001234567890 \
  --message "Topic opened" \
  --pin

使用显式 JSON 的置顶投递:

{
  "pin": {
    "enabled": true,
    "notify": true,
    "required": false
  }
}

渲染器契约

渠道插件在其出站适配器上声明渲染支持:

const adapter: ChannelOutboundAdapter = {
  deliveryMode: "direct",
  presentationCapabilities: {
    supported: true,
    buttons: true,
    selects: true,
    context: true,
    divider: true,
    charts: false,
    tables: false,
    limits: {
      actions: {
        maxActions: 25,
        maxActionsPerRow: 5,
        maxRows: 5,
        maxLabelLength: 80,
        maxValueBytes: 100,
        supportsStyles: true,
        supportsDisabled: false,
      },
      selects: {
        maxOptions: 25,
        maxLabelLength: 100,
        maxValueBytes: 100,
      },
      text: {
        maxLength: 2000,
        encoding: "characters",
        markdownDialect: "discord-markdown",
      },
    },
  },
  deliveryCapabilities: {
    pin: true,
  },
  renderPresentation({ payload, presentation, ctx }) {
    return renderNativePayload(payload, presentation, ctx);
  },
  async pinDeliveredMessage({ target, messageId, pin }) {
    await pinNativeMessage(target, messageId, { notify: pin.notify === true });
  },
};

能力布尔值描述渲染器可将哪些内容呈现为交互式。可选的 limits 描述核心在调用渲染器之前可适配的通用封装:

type ChannelPresentationCapabilities = {
  supported?: boolean;
  buttons?: boolean;
  selects?: boolean;
  context?: boolean;
  divider?: boolean;
  charts?: boolean;
  tables?: boolean;
  limits?: {
    actions?: {
      maxActions?: number;
      maxActionsPerRow?: number;
      maxRows?: number;
      maxLabelLength?: number;
      maxValueBytes?: number;
      supportsStyles?: boolean;
      supportsDisabled?: boolean;
      supportsLayoutHints?: boolean;
    };
    selects?: {
      maxOptions?: number;
      maxLabelLength?: number;
      maxValueBytes?: number;
    };
    text?: {
      maxLength?: number;
      encoding?: "characters" | "utf8-bytes" | "utf16-units";
      markdownDialect?: "plain" | "markdown" | "html" | "slack-mrkdwn" | "discord-markdown";
      supportsEdit?: boolean;
    };
  };
};

核心在渲染前对语义控件应用通用限制。对于原生块数量、卡片大小、URL 限制以及无法在通用契约中表达的提供商特殊行为,渲染器仍负责最终的提供商特定验证和截断。如果限制移除了某个块中的所有控件,核心会将标签保留为非交互式上下文文本,使投递的消息仍具有可见的后备内容。

核心渲染流程

在 CLI 和标准消息操作使用的规范出站路径中,核心:

  1. 规范化呈现载荷。
  2. 解析目标渠道的出站适配器。
  3. 读取 presentationCapabilities。
  4. 当适配器声明相关限制时,应用操作数量、标签长度和选择选项数量等通用能力限制。除非适配器分别明确声明 charts: true 或 tables: true,否则图表块和表格块会转换为确定性文本。
  5. 当适配器能够渲染载荷时,调用 renderPresentation。
  6. 当适配器不存在或无法渲染时,回退为保守的文本。
  7. 通过常规渠道投递路径发送生成的载荷。
  8. 在第一条消息成功发送后,应用 delivery.pin 等投递元数据。

直接使用 ReplyPayload 的渠道本地回复或预览汇聚路径必须进入该规范路径,或者在将载荷投影为纯文本/媒体之前生成相同的呈现后备内容。

核心负责后备行为,使生产方能够保持与渠道无关。渠道插件负责原生渲染和交互处理。

降级规则

呈现内容必须能够安全地发送到功能受限的渠道。

后备文本包括:

  • 将 title 作为第一行
  • 将 text 块作为普通段落
  • 将 context 块作为紧凑的上下文行
  • 将 divider 块作为视觉分隔符
  • 按钮标签,包括链接按钮的 URL
  • 选择选项标签
  • 图表标题、类型、坐标轴、类别、序列和值
  • 表格标题、表头和每一行的值

按钮值的后备可见性

当渠道无法渲染交互式控件时,按钮值和选择值会回退为纯文本。后备行为既保持可用性,又不会泄露不透明的回调数据:

  • command 类型的操作渲染为 label: `command`,使用户可以复制命令并在渠道输入框中手动运行。
  • callback 类型的操作和旧版 value 字段仅渲染标签。不透明的回调值不会暴露在后备文本中。
  • approval 类型的操作仅渲染标签。审批 ID 和决定属于传输数据,不会通过通用标量辅助函数或后备文本暴露。
  • url 操作、由 URL 支持的 web-app 操作以及已弃用的 url / webApp / web_app 输入会在按钮标签旁渲染 URL 文本,因为 URL 面向用户。对于不支持原生小组件启动的渠道,仅限托管小组件的操作仅渲染标签。
  • 选择选项仅渲染标签。底层选项值不会暴露在后备文本中。

在后备 UI 中添加手动命令指引的渠道适配器(例如 Feishu 文档评论说明),必须依据后备渲染器使用的同一组呈现块来判断命令是否存在,确保仅在实际显示手动命令时才显示指引文本。

不受支持的原生控件应降级,而不应导致整个发送操作失败。例如:

  • 禁用内联按钮的 Telegram 会发送文本后备内容。
  • 不支持选择控件的渠道会以文本形式列出选择选项。
  • 不支持原生图表的渠道会以文本形式列出图表数据。
  • 不支持原生表格的渠道会以文本形式列出每一行表格数据。
  • 仅含 URL 的按钮会转换为原生链接按钮或后备 URL 行。
  • 可选的置顶操作失败不会导致已投递的消息失败。

主要例外是 delivery.pin.required: true;如果置顶被要求为必需操作,而渠道无法置顶已发送的消息,投递将报告失败。

提供商映射

当前内置渲染器:

渠道原生渲染目标说明
Discord组件和组件容器为现有的提供商原生载荷生产方保留旧版 channelData.discord.components,但新的共享发送应使用 presentation。
Feishu交互式卡片卡片标题可使用 title;正文应避免重复该标题。
Matrix文本后备加结构化事件字段按钮/选择控件声明为受支持,但目前每个块都渲染为 renderMessagePresentationFallbackText 输出,并通过 com.openclaw.presentation 事件字段传递,而非原生交互式小组件。
Mattermost文本加交互式属性不支持选择控件和分隔符;这些块会降级为文本。
Microsoft TeamsAdaptive Cards同时提供卡片和纯 message 文本时,文本会随卡片一并包含。不支持选择控件、样式和禁用状态。
SlackBlock Kit将 chart 渲染为原生 data_visualization,将 table 渲染为原生 data_table;保留旧版 channelData.slack.blocks,但新的共享发送应使用 presentation。
Telegram文本加内联键盘按钮/选择控件要求目标界面具备内联按钮能力;否则使用文本后备内容。
纯文本渠道文本后备没有渲染器的渠道仍会获得可读的输出。

提供商原生载荷兼容性是为现有回复生产方提供的过渡机制,而不是添加新的共享原生字段的理由。

呈现与 InteractiveReply 的对比

InteractiveReply 是审批和交互辅助函数所使用的较旧内部子集。它支持:

  • 文本
  • 按钮
  • 选择控件

MessagePresentation 是规范的共享发送契约。它新增:

  • 标题
  • 语气
  • 上下文
  • 分隔符
  • 图表
  • 表格
  • 仅含 URL 的按钮
  • 通过 ReplyPayload.delivery 提供通用投递元数据

桥接旧代码时,请使用 openclaw/plugin-sdk/interactive-runtime 中的辅助函数:

import {
  adaptMessagePresentationForChannel,
  applyPresentationActionLimits,
  hasMessagePresentationBlocks,
  interactiveReplyToPresentation,
  isMessagePresentationInteractiveBlock,
  normalizeMessagePresentation,
  presentationPageSize,
  presentationToInteractiveControlsReply,
  presentationToInteractiveReply,
  renderMessagePresentationChartFallbackText,
  renderMessagePresentationFallbackText,
  renderMessagePresentationTableFallbackText,
  resolveMessagePresentationActionValue,
  resolveMessagePresentationButtonAction,
  resolveMessagePresentationControlValue,
  resolveMessagePresentationOptionAction,
} from "openclaw/plugin-sdk/interactive-runtime";

新代码应直接接受或生成 MessagePresentation。现有 interactive 载荷是 presentation 的已弃用子集;运行时仍支持较旧的生产方。

值得了解的未弃用辅助函数:

  • normalizeMessagePresentation(raw) / hasMessagePresentationBlocks(value) 将无类型载荷(例如来自 CLI --presentation 标志的 JSON)验证并强制转换为 MessagePresentation。
  • isMessagePresentationInteractiveBlock(block) 将块的类型收窄为 buttons | select 联合类型。
  • resolveMessagePresentationButtonAction(button) 和 resolveMessagePresentationOptionAction(option) 在接受已弃用边界字段的同时返回规范的类型化 操作。显式的 action 始终优先。
  • resolveMessagePresentationActionValue(action) / resolveMessagePresentationControlValue(control) 仅读取命令/回调 标量值。非标量规范操作绝不会回退到旧版影子 value, 因此审批 ID 和链接目标会保持类型化。
  • renderMessagePresentationChartFallbackText(block) / renderMessagePresentationTableFallbackText(block) 将单个结构化 数据块呈现为确定性文本,供渠道专用回退路径使用。

旧版 InteractiveReply* 类型和转换辅助函数在 SDK 中标记为 @deprecated:

  • InteractiveReply、InteractiveReplyBlock、InteractiveReplyButton 和 InteractiveReplyOption
  • normalizeInteractiveReply(...)
  • hasInteractiveReplyBlocks(...)
  • interactiveReplyToPresentation(...)
  • presentationToInteractiveReply(...)
  • presentationToInteractiveControlsReply(...)
  • resolveInteractiveTextFallback(...)
  • reduceInteractiveReply(...)

presentationToInteractiveReply(...) 和 presentationToInteractiveControlsReply(...) 仍作为旧版渠道实现的呈现器 桥接器提供。新的生成方代码不应调用它们;发送 presentation,并由核心/渠道适配处理呈现。

审批辅助函数也有以呈现为先的替代项:

  • 使用 buildApprovalPresentation(...),而不是 buildApprovalInteractiveReply(...)
  • 使用 buildExecApprovalPresentation(...),而不是 buildExecApprovalInteractiveReply(...)

为保持插件兼容性,这些已发布的构建器仍由命令提供支持。拥有持久审批类型的 Gateway 网关 和内置渠道代码应使用 buildTypedApprovalPresentation(...)、 buildTypedExecApprovalPendingReplyPayload(...) 或 buildTypedPluginApprovalPendingReplyPayload(...),以便传输层接收显式的 approval 操作,而不是从 /approve 文本推断语义。

对于没有文本回退的呈现块(例如仅含分隔线的 呈现),renderMessagePresentationFallbackText(...) 返回空字符串。要求发送正文非空的传输层可以传入 emptyFallback,选择使用最小正文,而不更改默认回退 契约。

投递置顶

置顶属于投递行为,而不是呈现行为。请使用 delivery.pin,而不是 channelData.telegram.pin 等提供商原生字段。

语义:

  • pin: true 会置顶第一条成功投递的消息。
  • pin.notify 默认为 false。
  • pin.required 默认为 false。
  • 可选置顶失败时会降级处理,并保留已发送的消息。
  • 必要置顶失败时,投递会失败。
  • 分块消息会置顶第一个已投递的分块,而不是末尾分块。

对于提供商支持这些操作的现有 消息,手动 pin、unpin 和 pins 消息操作仍然可用。

插件作者检查清单

  • 当渠道能够呈现语义化呈现内容或安全降级时,从 describeMessageTool(...) 声明 presentation。
  • 将 presentationCapabilities 添加到运行时出站适配器。
  • 在运行时代码中实现 renderPresentation,而不是在控制平面插件 设置代码中实现。
  • 不要让原生 UI 库进入热路径设置/目录路径。
  • 已知通用能力限制时,在 presentationCapabilities.limits 上声明 它们。
  • 在呈现器和测试中保留最终平台限制。
  • 为不受支持的图表、表格、按钮、选择器、URL 按钮、标题/文本重复,以及混合 message 与 presentation 发送添加回退测试。
  • 仅当提供商可以置顶已发送消息的 ID 时,才通过 deliveryCapabilities.pin 和 pinDeliveredMessage 添加投递置顶支持。
  • 不要通过共享消息操作架构公开新的提供商原生卡片/块/组件/按钮字段。

相关文档