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 代理关联的代理 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 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 可选 在输入字段为空时显示的文本。默认值为“询问…”。
bot-actor-image 可选 要用于代理的操作者图片的图片来源。将显示在每组客服人员回复中。
user-actor-image 可选 要用于用户的演员图片的图片来源。将显示在每条用户消息中。

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

Dialogflow 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(如果已指定)。