Dialogflow CX Messenger HTML 自定义

您可以对聊天对话框应用许多 HTML 自定义设置。

HTML 聊天元素选项

df-messenger 元素的子元素可以是以下任一元素:

  • df-messenger-chat:代理对话始终处于打开状态
  • df-messenger-chat-bubble:代理对话可以通过打开或关闭气泡按钮打开或关闭

df-messenger 的 HTML 自定义设置

df-messenger HTML 元素具有以下特性 (Attribute):

属性 输入政策
agent-id 必填 与 Dialogflow CX 代理关联的代理 ID。
allow-feedback 可选 设置为 all,以允许最终用户针对代理的回答提供 反馈
language-code 必填 默认语言代码
project-id 必填 代理的项目 ID。
location 可选 代理的区域。默认值为 global
intent 可选 聊天对话框打开时将调用的自定义事件。您可以使用将为此事件调用的事件处理脚本,并生成第一条代理消息。
oauth-client-id 可选 OAuth 身份验证所必需的。默认值为 null。如果未提供该值且启用了 Dialogflow CX Messenger 未经身份验证的访问权限,未经身份验证的用户可以与代理互动。如果提供了该值,代理对话框将叠加“请求身份验证”(文本可控制,请参阅 request-auth-text 通知),这要求用户先登录,然后才能使用代理。
storage-option 可选 指定对话消息的本地存储。如果消息不应存储,请使用 none。使用 none 会在页面刷新或重新加载时清除所有消息。默认为 sessionStorage
session-ttl 可选 设置为以秒为单位的时长,以保持会话,必须严格低于 86400(1 天),默认值为 1800(30 分钟)。
url-allowlist 可选 允许从以英文逗号分隔的网址前缀列表中加载图片。HTML 或 Markdown 响应中使用的图片网址必须以列出的前缀之一开头。使用 * 可允许所有网址。
max-query-length 可选 定义文本查询的最大长度。如果值为负数,则长度不受限制。默认值为 256。其他文档

df-messenger-chat 的 HTML 自定义设置

Dialogflow CX Messenger 屏幕截图

df-messenger-chat HTML 元素具有以下特性 (Attribute):

属性 输入政策
chat-title 可选 聊天框的标题,显示在聊天框上方。
chat-subtitle 可选 聊天框的副标题,显示在聊天框上方,位于 chat-title 下方。
chat-title-icon 可选 聊天框标题中显示的图标,显示在聊天框上方,默认位于 chat-title 的左侧。
bot-writing-text 可选 代理正在撰写时显示的文本。
bot-writing-image 可选 代理正在撰写时显示的图片。优先级高于 bot-writing-text
request-auth-text 可选 如果需要身份验证,则为按钮文本。
placeholder-text 可选 输入字段为空时显示的文本。默认值为“Ask something…”。
bot-actor-image 可选 用于代理的参与者图片的图片来源。将显示在每组代理响应中。
user-actor-image 可选 用于用户的参与者图片的图片来源。将显示在每条用户消息中。

df-messenger-chat-bubble 的 HTML 自定义设置

Dialogflow CX Messenger 屏幕截图

df-messenger-chat-bubble HTML 元素具有与 df-messenger-chat 相同的属性,以及以下其他属性:

属性 输入政策
expanded 可选 布尔值,用于确定聊天是否最初处于打开状态。如果未设置,聊天将记住其上次状态。
chat-icon 可选 聊天气泡的图标。必须是公开可用的 URI。
chat-close-icon 可选 聊天气泡的关闭图标。必须是公开可用的 URI。
chat-collapse-icon 可选 标题栏中收起按钮的图标。必须是公开可用的 URI。
anchor 可选 定义聊天对话框相对于打开或关闭气泡的位置。该值是两个方向字词(topbottomleftright),以 - 分隔。默认值为 top-left。第一个方向定义锚点,第二个方向定义远离气泡的主要展开方向。例如:top-left 位于气泡顶部,并向左和向上(远离气泡)展开。
chat-width 可选 定义聊天窗口的宽度。数值(以像素为单位)。默认值为 320 像素。
chat-height 可选 定义聊天窗口的高度。数值(以像素为单位)。默认值为 480 像素。
allow-fullscreen 可选 定义聊天窗口是否可以全屏打开。如果设置为 always,则会针对所有屏幕尺寸以全屏模式打开。如果设置为 small,则会针对屏幕尺寸小于 500 像素的屏幕以全屏模式打开,否则会以普通窗口的形式打开。如果设置了 chat-widthchat-heightanchor,则可能会替换这些属性。
minimized 可选 确定聊天是否最初以最小化形式打开。使用与 anchor 相同的逻辑。如果指定了,则会在加载时执行初始 intent