Dialogflow CX Messenger JavaScript

Dialogflow CX Messenger 提供了您可以调用来影响其行为的functions。

renderCustomText

此函数会显示一条简单的文本消息，就像它作为简单的文本响应来自代理或由最终用户输入一样。

参数：

  • string：短信
  • boolean：如果是客服人员发送的消息，则为 true；如果是最终用户发送的消息，则为 false

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.renderCustomText('Custom text', true);

renderCustomCard

此函数会显示一个自定义卡片，就像它来自 Dialogflow Fulfillment 一样。

参数：

  • payload：自定义载荷响应的列表，已在 Fulfillment 部分中定义。

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
const payload = [
  {
    "type": "info",
    "title": "Info item title",
    "subtitle": "Info item subtitle",
    "image": {
      "rawUrl": "https://example.com/images/logo.png"
    },
    "anchor": {
      "href": "https://example.com",
      "target": "_blank"
    }
  }
];
dfMessenger.renderCustomCard(payload);

sendQuery

此函数会向 Dialogflow API 发送查询，并等待响应。这有效地模拟了通常提供给代理对话框的最终用户输入。系统会像处理任何最终用户查询一样处理该响应。

参数：

  • string：文本查询

退货：

  • Promise<void>：异步操作的返回值

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendQuery('Describe shipping costs.');

sendRequest

此函数会向 Dialogflow API 发送请求并等待响应。

参数：

  • string：请求类型，支持 query（另请参阅上文中的 sendQuery）和 event（请参阅自定义事件）
  • any：与请求类型对应的载荷，目前对于这两种受支持的请求类型，载荷均为字符串

退货：

  • Promise<void>：异步操作的返回值

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendRequest('query', 'Describe shipping costs.');

setQueryParameters

此函数会为 Dialogflow API detectIntent 请求的 queryParams 字段设置默认值。其他 Dialogflow CX Messenger 方法可能会替换查询参数中的相应默认值。

参数：

  • object：JSON 数据。如需了解查询参数的架构，请参阅 QueryParameters

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
const queryParameters = {
  parameters: {
  timeZone: "America/New_York"
  }
};
dfMessenger.setQueryParameters(queryParameters);

setContext

此函数会将有关最终用户的生成式个性化信息发送到 Dialogflow。这些信息将在会话的其余时间内保留。

参数：

  • object：JSON 数据，请参阅生成式个性化文档

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
const metadata = {
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {
      model: "Google Pixel 7",
    },
    {
      model: "Google Pixel Tablet",
    },
  ],
};
dfMessenger.setContext(metadata);

clearStorage

此函数会清除代理对话框的永久存储空间。它还会清除客服人员对话框的当前状态。

参数：

  • 无

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearStorage();

clearAuthentication

此函数会清除代理对话框的身份验证。

参数：

  • 无

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearAuthentication();

startNewSession

此函数会在客服人员对话框中启动新会话。它可以保留或重置当前的消息记录。它不会清除用户身份验证。

参数：

名称 类型 说明
args object? 用于配置新会话创建的可选参数。
args.retainHistory boolean? 用于保留历史记录的可选标志。如果设置为 true，系统会保留历史记录，否则会清除历史记录。

退货：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.startNewSession({ retainHistory: true });

openChat

此函数会打开聊天。在 df-messenger-chat-bubble 元素上调用它即可打开聊天。如果聊天对话已打开，则不会执行任何操作。

参数：

  • 无

退货：

  • void

例如

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.openChat();

closeChat

此函数会关闭聊天。在 df-messenger-chat-bubble 元素上调用该方法可关闭聊天。如果聊天已结束，则不会执行任何操作。

参数：

  • 无

退货：

  • void

例如

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.closeChat();

openMinChat

Dialogflow CX Messenger 最小化聊天

此函数会以最小化版本打开聊天窗口。在 df-messenger-chat-bubble 元素上调用它，即可打开最小化聊天。如果聊天已最小化，则不执行任何操作。

参数：

名称 类型 说明
args 对象？ 用于配置最小化聊天的可选参数
args.anchor string? 可选的 anchor，用于配置要将最小化聊天对话打开到的位置。与聊天气泡元素上的 anchor 属性相同的逻辑。默认值为 left-top。
args.showActorImages 布尔值？ 用于显示演员图片的可选标志（如果在 df-messenger-chat-bubble 元素上指定）。默认值为 false。

示例：

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.openMinChat({
  anchor: 'top-left'
});

closeMinChat

关闭最小化的聊天。对 df-messenger-chat-bubble 元素调用它可关闭最小化的对话。如果聊天已结束，则不会执行任何操作。

示例：

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.closeMinChat();