本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Amazon Connect 中支持可自定义的小部件片段字段
下表列出了可以自定义的通信小部件片段字段。表格之后的代码示例显示了如何使用片段字段。
片段字段 | 类型 | 描述 | 其他文档 |
---|---|---|---|
|
字符串 |
必填,自动生成 |
不适用 |
|
字符串 |
必填,自动生成 |
不适用 |
|
数组 |
必填,自动生成 |
不适用 |
|
对象 |
自定义您的网站呈现和启动托管小部件图标的方式 |
|
|
函数 |
在您的网站上启用 JWT 安全功能的回调函数 |
此部分前面的第 2 步:指定您希望在其中显示通信小部件的网站域。 |
|
函数 |
初始化联系人时传递客户显示名称 |
|
|
对象 |
覆盖默认 CSS 样式 |
|
|
数字 |
新开始的聊天会话的总时长 |
默认值:1500 - 最小 60,最大:10080 |
|
布尔值 |
启用调试日志 |
默认:false |
|
字符串 |
Connect 可以对支持的 ISO-639 格式语言代码进行翻译。欲了解更多信息,请参阅 https://en.wikipedia。 org/wiki/List_of_iso_639-1_codes。 |
默认语言:en_US。支持的语言:de_DE、en_US、es_ES、fr_FR、id_ID、it_IT、ja_JP、ko_KR、pt_BR、zh_CN |
|
字符串 |
iframe 与客户网站 csp 策略之间的握手值。示例:客户 csp 允许使用 1234 随机数值,引入另一个脚本的 iframe 必须具有相同的 1234 随机数值,这样浏览器才能知道它是 iframe 父站点的可信脚本。 |
默认值:未定义 |
|
对象 |
自定义小部件布局和脚本 |
有关更多信息,请参阅此部分后面的您的 Amazon Connect 聊天插件的其他自定义设置。 |
|
对象 |
无需任何 JWT 设置,直接从片段代码向联系人流传递属性 |
有关更多信息,请参阅聊天初始化时传递联系人属性。 |
|
对象 |
覆盖 Amazon Connect 管理员网站中设置的系统或机器人显示名称和徽标配置。 |
有关更多信息,请参阅如何传递通信小部件的覆盖系统和机器人显示的名称和徽标。 |
|
函数 |
访问 contactId 的回拨函数。例如,添加事件侦听器来处理诸如在浏览器标签页关闭时使用 contactID 调用 StopContact 函数或使用之前的 ContactID 保持聊天持久性等场景。 |
|
|
对象 |
这允许对公开的生命周期活动执行回拨。 有关更多信息,请参阅 amazon-connect-chatjs |
|
|
字符串 |
要发送到新建聊天室的消息。长度限制:最小为 1,最大为 1024。 |
要使用初始消息调用联系流中配置的 Lex 机器人,请通过选择使用信息初始化机器人选项来修改获取客户输入流块。有关更多信息,请参阅如何配置获取客户输入流块。 |
|
对象 |
这会启用对客户进行身份验证流量块 |
有关更多信息,请参阅 启用客户身份验证。 |
|
布尔值 |
为 Lex Bot 消息启用模拟打字指示器。 |
默认:false |
|
函数 |
回调函数,用于从您的后端调用 “开始聊天” API。 |
如需了解更多信息,请参阅带有自定义 “开始聊天 API” 的托管控件用户界面 |
以下示例演示了如何向将聊天小部件添加到网站的 HTML 脚本中添加片段字段。
(function(w, d, x, id) { /* ... */})(window, document, 'amazon_connect', 'widgetId'); amazon_connect('snippetId', 'snippetId'); amazon_connect('styles', /* ... */); amazon_connect('registerCallback', { // Custom event example // WIDGET_FRAME_CLOSED /** * This event is triggered when user clicks on the chat widget close button, * either widget close button was clicked when error in the chat session or normally by the user. * This event can be used for webview use cases to go back to main app * * @param {string} status - The reason for widget closure * - "error_chat": Indicates the user clicked on widget close button due to an error in the chat session * - "close_chat": Indicates the user clicked on widget close button normally by the user */ 'WIDGET_FRAME_CLOSED': (eventName, { status }) => { // You can implement custom logic based on the status value(error_chat or close_chat) if (status == "error_chat") { // handle error chat } else if (status == "close_chat") { // handle close chat } }, // System event example /** * chatDetails: { * contactId: string, * participantId: string, * participantToken: string, * } * data: { * AbsoluteTime?: string, * ContentType?: string, * Type?: string, * ParticipantId?: string, * DisplayName?: string, * ParticipantRole?: string, * InitialContactId?: string * } */ 'PARTICIPANT_JOINED': (eventName, { chatDetails, data }) => { alert(`${data.ParticipantRole} joined the chat.`); }, 'event_Name_3': callback(function), 'event_Name_4': callback(function), // ... }); amazon_connect('initialMessage', 'Your initial message string'); // ... amazon_connect('snippetFieldHere', /* ... */); <script/>