集成通道支持

Web 聊天	电话	SMS	Slack	Facebook	WhatsApp

• 某些通道集成不会显示音频标题或描述。

字段

source 属性指定的 URL 可以是以下类型之一：

• 任何标准格式（如 MP3 或 WAV）音频文件的 URL。 在网络聊天中，链接的音频剪辑呈现为嵌入式音频播放器。

• 支持的流媒体服务中音频片段的 URL。 在 Web 聊天中，链接的音频剪辑通过将可嵌入播放器用于托管服务来呈现。

  指定用于在浏览器中访问音频文件的 URL （例如 https://soundcloud.com/ibmresearchfallen-star-amped ）。网络聊天会自动将 URL 转换为可嵌入的形式。

  您可以嵌入托管在受支持服务上的音频:

  • SoundCloud
  • 混合云

对于电话集成，URL 必须指定单声道（单声道）和 PCM 编码的音频文件，采样频率为 8000 Hz，每次采样 16 比特。

示例

这个例子播放一个带有标题和描述性文字的音频片段。

{
  "generic":[
    {
      "response_type": "audio",
      "source": "https://example.com/audio/example-file.mp3",
      "title": "Example audio file",
      "description": "An example audio clip returned as part of a multimedia response."
    }
  ]
}

集成通道支持

WebChat

字段

post_back 按钮类型

当用户单击 post_back 按钮时，该按钮会向助手发送响应。 您可以使用 value 和 label 属性来设置要发送的响应。

{
  "response_type": "button",
  "button_type": "post_back",
  "label": "Send message",
  "value": {
    "input": {
      "text": "[Message to send]"
    }
  }
}

custom_event 按钮类型

当用户单击 custom_event 按钮时，将触发随用户定义数据一起配置的定制事件。 您必须创建事件以通过使用定制代码来实现期望的行为。 在 Web 聊天中，您可以使用 messageItemCustom 事件在用户单击按钮时应用期望的行为。

{
  "response_type": "button",
  "button_type": "custom_event",
  "label": "Alert",
  "kind": "danger",
  "custom_event_name": "trigger_alert",
  "user_defined": {
    "message": "[Alert message]"
  }
}

show_panel 按钮类型

当用户单击 show_panel 按钮时，助手会打开一个面板，用户可以使用该面板来获取其他信息或完成任务。

{
  "response_type": "button",
  "button_type": "show_panel",
  "label": "See details",
  "kind": "secondary",
  "panel": {
    "title": "[Product name]",
    "show_animations": true,
    "body": [
      {
        "response_type": "image",
        "source": "https://example.com/image.jpg"
      },
      {
        "response_type": "text",
        "text": "[Product details]"
      }
    ]
  }
}

url 按钮类型

当用户单击 url 按钮时，用户将转至 URL 字段以添加目标 URL。

{
  "response_type": "button",
  "button_type": "url",
  "label": "Visit ibm.com",
  "url": "https://www.ibm.com"
}

集成通道支持

WebChat

字段

可以在面板中呈现 card，但不允许它具有按钮。

示例

以下示例显示了用于构建 card 响应类型的基本结构:

{
  "response_type": "card",
  "body": [
    {
      "response_type": "text",
      "text": "# Heading"
    },
    {
      "response_type": "text",
      "text": "body"
    }
  ]
}

集成通道支持

WebChat

字段

示例

以下示例显示了用于构建 carousel 响应类型的基本结构:

{
  "response_type": "carousel",
  "items": [
    {
      "response_type": "card",
      "body": [
        {
          "response_type": "text",
          "text": "# Heading"
        },
        {
          "response_type": "text",
          "text": "body"
        }
      ]
    },
    {
      "response_type": "card",
      "body": [
        {
          "response_type": "text",
          "text": "# Heading"
        },
        {
          "response_type": "text",
          "text": "body"
        }
      ]
    }
  ]
}

集成通道支持

电话	SMS	Slack	Facebook	WhatsApp

• 指定的通道集成支持 启动 通道传输 (当前，Web 聊天集成是唯一受支持的传输目标)。
• 从电话集成启动通道传输需要同时配置 SMS 集成。

字段

示例

此示例请求从 WhatsApp 到 Web 聊天的传输。 除 channel_transfer 响应外，输出还包含 text 响应，将由传输后的 Web 聊天集成显示。 使用 channels 数组可确保 channel_transfer 响应仅由 WhatsApp 集成 (在传输之前) 处理，而 connect_to_agent 响应仅由 Web 聊天集成 (在传输之后) 处理。

{
  "generic": [
    {
      "response_type": "channel_transfer",
      "channels": [
        {
          "channel": "whatsapp"
        }
      ],
      "message_to_user": "Click the link to connect with an agent using our website.",
      "transfer_info": {
        "target": {
          "chat": {
            "url": "https://example.com/webchat"
          }
        }
      }
    },
    {
      "response_type": "connect_to_agent",
      "channels": [
        {
          "channel": "chat"
        }
      ],
      "message_to_human_agent": "User asked to speak to an agent.",
      "agent_available": {
        "message": "Please wait while I connect you to an agent."
      },
      "agent_unavailable": {
        "message": "I'm sorry, but no agents are online at the moment. Please try again later."
      },
      "transfer_info": {
        "target": {
          "zendesk": {
            "department": "Payments department"
          }
        }
      }
    }
  ]
}

集成通道支持

Web 聊天	电话	WhatsApp

• 有关向 Web 聊天集成添加服务台支持的信息，请参阅 添加联系中心支持。
• 有关向电话集成添加服务台支持的信息，请参阅 配置备份呼叫中心支持。

字段

示例

此示例请求向实时代理进行传输，并指定在传输时要向用户和代理显示的消息。

{
  "generic": [
    {
      "response_type": "connect_to_agent",
      "message_to_human_agent": "User asked to speak to an agent.",
      "agent_available": {
        "message": "Please wait while I connect you to an agent."
      },
      "agent_unavailable": {
        "message": "I'm sorry, but no agents are online at the moment. Please try again later."
      }
    }
  ]
}

集成通道支持

Web 聊天

• 在 Web 交谈中，客户可以通过单击交互式日期选取器或在输入字段中输入日期值来指定日期值。

字段

示例

此示例发送文本响应，该响应要求用户指定日期，然后显示交互式日期选取器。

{
  "generic": [
    {
      "response_type": "text",
      "text": "What day will you be checking in?"
    },
    {
      "response_type": "date"
    }
  ]
}

集成通道支持

电话

字段

command_info.type 字段可以指定以下任何受支持的命令:

• collect: 收集 DTMF 小键盘输入。
• disable_barge_in: 禁用 DTMF 打断，以便客户按键时不会中断电话集成中的回放。
• enable_barge_in：启用双音多频插话，以便客户按下按键即可中断电话集成的播放。
• send: 发送 DTMF 信号。

有关如何使用其中每个命令的详细信息，请参阅 处理电话交互。

示例

此示例显示了带有 collect 命令的 dtmf 响应类型，用于收集 DTMF 输入。 有关更多信息，请参阅 处理电话交互。

{
  "generic": [
    {
      "response_type": "dtmf",
      "command_info": {
        "type": "collect",
        "parameters": {
          "termination_key": "#",
          "count": 16,
          "ignore_speech": true
        }
      },
      "channels": [
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

集成通道支持

电话	SMS

• SMS 集成支持使用 terminateSession 操作命令结束会话。

字段

对于电话集成，您可以使用 channel_options 对象将定制头包含在生成的 SIP BYE 请求中。 有关更多信息，请参阅 结束呼叫。

示例

此示例使用 end_session 响应类型来结束对话。

{
  "generic": [
    {
      "response_type": "end_session"
    }
  ]
}

集成通道支持

WebChat

字段

示例

以下示例显示了用于构建 grid 响应类型的基本结构:

{
  "response_type": "grid",
  "columns": [
    {
      "width": "1"
    },
    {
      "width": "1"
    }
  ],
  "rows": [
    {
      "cells": [
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 1 cell 1"
            }
          ]
        },
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 1 cell 2"
            }
          ]
        }
      ]
    },
    {
      "cells": [
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 2 cell 1"
            }
          ]
        },
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 2 cell 2"
            }
          ]
        }
      ]
    }
  ]
}

集成通道支持

Web 聊天	Facebook

• 当前，Web 聊天集成将忽略 description 和 image_url 属性。 而是在运行时从源动态检索描述和预览图像。

字段

不同的站点对嵌入内容有不同的限制，而生成可嵌入 URL 的过程也不同。 可嵌入 URL 是指可指定为 iframe 元素的 src 属性值的 URL。

例如，要使用 Google 地图嵌入交互式地图，可以使用 Google 地图嵌入 API。 (有关更多信息，请参阅 地图嵌入 API 概述。) 其他站点具有用于创建可嵌入内容的不同进程。

有关使用 Content-Security-Policy: frame-src 来允许嵌入 Web 站点内容的技术详细信息，请参阅 CSP: frame-src。

示例

以下示例嵌入了具有标题和描述的 iframe。

{
  "generic":[
    {
      "response_type": "iframe",
      "source": "https://example.com/embeddable/example",
      "title": "Example iframe",
      "description": "An example of embeddable content returned as an iframe response.",
      "channel_options": {
        "chat": {
          "display": "inline",
          "base_height": 180
        }
      }
    }
  ]
}

集成通道支持

Web 聊天	SMS	Slack	Facebook	WhatsApp	MS 团队

• 某些通道集成不会显示图像标题或描述。

字段

示例

此示例显示带有标题和描述性文本的图像。

{
  "generic":[
    {
      "response_type": "image",
      "source": "https://example.com/image.jpg",
      "title": "Example image",
      "description": "An example image returned as part of a multimedia response."
    }
  ]
}

集成通道支持

Web 聊天	电话	SMS	Slack	Facebook	WhatsApp	MS 团队

• 选项的显示方式因通道集成而异。 可能时支持 preference 字段，但并非所有通道都支持下拉列表或按钮。

字段

示例

此示例提供了两个选项 (Buy something 和 Exit)。

{
  "generic":[
    {
      "response_type": "option",
      "title": "Choose from the following options:",
      "preference": "button",
      "options": [
        {
          "label": "Buy something",
          "value": {
            "input": {
              "text": "Place order"
            }
          }
        },
        {
          "label": "Exit",
          "value": {
            "input": {
              "text": "Exit"
            }
          }
        }
      ]
    }
  ]
}

集成通道支持

Web 聊天	Facebook	WhatsApp

• 通过电话集成，您可以通过在助手输出中包含 SSML break 元素来添加暂停。 有关更多信息，请参阅 Text to Speech 文档。

字段

示例

这个示例发送“用户正在输入”事件，并暂停5秒。

{
    "generic":[
      {
        "response_type": "pause",
        "time": 5000,
        "typing": true
      }
    ]
}

集成通道支持

电话

字段

command_info.type 字段可以指定以下任何受支持的命令:

• configure: 动态更新 Speech to Text 配置。 配置更改只能应用于下一个对话轮次或会话的其余部分。

有关如何使用此命令的信息，请参阅 将高级设置应用于 Speech to Text 服务。

示例

此示例将 speech_to_text 响应类型与 configure 命令配合使用，以将语言模型从 Speech to Text 服务更改为西班牙语，并启用智能格式化。

{
  "generic": [
    {
      "response_type": "speech_to_text",
      "command_info": {
        "type": "configure",
        "parameters": {
          "narrowband_recognize": {
            "model": "es-ES_NarrowbandModel",
            "smart_formatting": true
          }
        }
      },
      "channels":[
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

集成通道支持

电话

字段

目前，可以开始电话集成的以下活动:

• speech_to_text_recognition: 识别语音。 将音频流式传输到 Speech to Text 服务已恢复。
• dtmf_collection: 处理入站 DTMF 信号。

示例

此示例使用 start_activities 响应类型来重新启动识别语音。 由于此命令特定于电话集成，因此 channels 属性仅指定 voice_telephony。

{
  "generic": [
    {
      "response_type": "start_activities",
      "activities": [
        {
          "type": "speech_to_text_recognition"
        }
      ],
      "channels":[
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

集成通道支持

电话

字段

目前，可以停止电话集成的以下活动:

• speech_to_text_recognition: 停止识别语音。 Speech to Text 服务的所有流式音频都已停止。
• dtmf_collection: 停止入站 DTMF 信号的处理。

示例

此示例使用 stop_activities 响应类型来停止识别语音。 由于此命令特定于电话集成，因此 channels 属性仅指定 voice_telephony。

{
  "generic": [
    {
      "response_type": "stop_activities",
      "activities": [
        {
          "type": "speech_to_text_recognition"
        }
      ],
      "channels":[
        {
          "channel":"voice_telephony"
        }
      ]
    }
  ]
}

集成通道支持

Web 聊天

属性和定义

每一行的单元格数必须与标题相同。 如果单元格和标题不匹配，网络聊天在尝试渲染表格时就会出错。

示例

本例以表格形式显示结构化数据。

{
    "generic": [
      {
        "response_type": "table",
        "title": "Data Table",
        "description": "A table with data",
        "headers": ["Column 1", "Column 2"],
        "rows": [
          {
            "cells": ["Row 1, Column 1", "Row 1, Column 2"]
          },
          {
            "cells": ["Row 2, Column 1", "22"]
          }
        ]
      }
    ]
}

集成通道支持

Web 聊天	电话	SMS	Slack	Facebook	WhatsApp

字段

示例

此示例显示向用户发送的问候消息。

{
  "generic": [
    {
      "response_type": "text",
      "values": [
        {
          "text_expression": {
            "concat": [
              {
                "scalar": "Hi, "
              },
              {
                "variable": "step_472"
              },
              {
                "scalar": ". How can I help you?"
              }
            ]
          }
        }
      ],
      "selection_policy": "sequential"
    }
  ]
}  

集成通道支持

电话

字段

command_info.type 字段可以指定以下任何受支持的命令:

• configure: 动态更新 Text to Speech 配置。 配置更改只能应用于下一个对话轮次或会话的其余部分。
• disable_barge_in: 禁用语音打断，以便在客户讲话时不会中断电话集成的回放。
• enable_barge_in：启用语音打断功能，以便客户可以通过说话来中断手机集成的播放。

有关如何使用其中每个命令的详细信息，请参阅 将高级设置应用于 Text to Speech 服务。

示例

此示例将 text_to_speech 响应类型与 configure 命令配合使用，以更改 Text to Speech 服务所使用的语音。

{
  "generic": [
    {
      "response_type": "text_to_speech",
      "command_info": {
        "type": "configure",
        "parameters" : {
          "synthesize": {
            "voice": "en-US_LisaVoice"
          }          
        }
      },
      "channels":[
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

集成通道支持

Web 聊天	电话	SMS	Slack	Facebook	WhatsApp
	*	*

• 通过电话集成，user_defined 响应类型用于发送旧命令 (例如，vgwActForceNoInputTurn 或 vgwActSendSMS)。 有关更多信息，请参阅 处理电话交互。
• 通过 SMS 集成，user_defined 响应类型用于发送操作命令 (例如，terminateSession 或 smsActSendMedia)。

字段

示例

此示例显示用户定义的响应的通用示例。 user_defined 对象可以包含任何有效的 JSON 数据。

{
  "generic":[
    {
      "response_type": "user_defined",
      "user_defined": {
        "field_1": "String value",
        "array_1": [
          1,
          2
        ],
        "object_1": {
          "property_1": "Another string value"
        }
      }
    }
  ]
}

集成通道支持

Web 聊天	SMS	Slack	Facebook	WhatsApp

• 某些通道集成不会显示视频标题或描述。

字段

source 属性指定的 URL 可以是以下类型之一：

• 标准格式（如 MPEG 或 AVI）视频文件的 URL。 在网络聊天中，链接的视频呈现为嵌入式视频播放器。

  不支持 HLS (.m3u8) 和 DASH (MPD) 流式视频。

• 支持服务的视频 URL。 在 Web 聊天中，链接的视频与托管服务的可嵌入播放器呈现。

  指定要在浏览器中查看的视频 URL （例如 https://www.youtube.com/watch?v=52bpMKVigGU ）。网络聊天会自动将 URL 转换为可嵌入的形式。

  您可以嵌入托管在以下服务中的视频：

  • YouTube
  • 脸书
  • Vimeo
  • 抽搐
  • 可流式传输
  • Wistia
  • Vidyard

示例

这个例子显示了一个带有标题和描述性文字的视频。

{
  "generic":[
    {
      "response_type": "video",
      "source": "https://example.com/videos/example-video.mp4",
      "title": "Example video",
      "description": "An example video returned as part of a multimedia response."
    }
  ]
}