核心API
核心设置和命令影响整个小部件。
设置
Web Widget (Classic)具有以下核心设置:
例子
<脚本类型="text / javascript">
窗口。zESettings={
webWidget:{
颜色:{主题:“架a300型# 78”}
}
};
脚本>
contactOptions
小部件的contactOptions
对象,它代表一个组件,让用户选择开始聊天或提交票证,有以下设置:
要了解有关联系人选项的更多信息,请参见为终端用户提供多种联系方式在Zendes亚博k帮助中心。
注意:chatLabelOnline
和contactFormLabel
适用于应答机器人频道上显示给最终用户的联系人选项。
例子
<脚本类型="text / javascript">
窗口。zESettings={
webWidget:{
contactOptions:{
启用:真正的,
contactButton:{‘*’:“保持联系”}
}
}
};
脚本>
发射器
小部件的发射器
对象,它代表启动器按钮,具有以下设置:
例子
<脚本类型="text / javascript">
窗口。zESettings={
webWidget:{
发射器:{
chatLabel:{
‘*’:现在聊天的
},
移动:{
labelVisible:真正的
}
}
}
};
脚本>
命令
Web Widget (Classic)有以下核心命令:
清晰的
泽(“webWidget”、“明确”);
清除Web Widget中的所有表单。
参数
没有一个
关闭
泽(“webWidget”、“关闭”);
如果打开了小部件,该命令将关闭小部件并显示启动程序。
参数
没有一个
得到显示
泽(' webWidget: ', '显示');
获取当前小部件显示。根据您启用的特性,该命令显示以下字符串之一:helpCenter
,闲谈,聊天
,contactForm
,说话
,contactOptions
,answerBot
,或隐藏的
。
隐藏
泽(“webWidget”、“隐藏”);
从页面中隐藏小部件的所有部分。您可以在页面加载之前或之后调用它。
参数
没有一个
例子
页面加载前:
<脚本类型="text / javascript">
泽(“webWidget”,“隐藏”);
脚本>
页面加载后:
<按钮onclick="泽('webWidget','隐藏')">隐藏Web小部件按钮>
识别
zE('webWidget', 'identify', data
将最终用户标识到Zendesk。亚博
如果您可以访问最终用户的姓名和电子邮件,请使用此命令将详细信息传递到您的Zendesk Support帐户。亚博
如果用户的电子邮件在您的Zendesk Support帐户中不存在,则创建一个包含详细信息的新用户记亚博录。
用户记录的创建是排队的,在用户记录出现在您的Zendesk Support帐户中之前可能会有几分钟的延迟。亚博但是,在高API流量期间,Identify API调用会受到限制,并且可能会被丢弃,从而导致没有创建用户记录。
识别API调用被限制在几个方面,以防止API滥用:
- IP地址:限制在单个IP地址上识别用户。
- 限制每个帐户创建用户记录:Zendesk Support帐户每天最多创建50,000条用户记录。亚博
- 有效载荷:当Zendesk支持帐户每12小时使用相同亚博的电子邮件地址进行一次以上的API调用时,会受到限制。
在小部件加载时发生Identify API调用。如果在Identify API调用创建用户记录之前提交了票据,则票据中的详细信息将用于创建用户记录。
注意:
Identify API调用只能在首次创建用户记录时指定组织。它不能用于修改现有用户记录上的组织。
识别API只在聊天表单中预填充用户的详细信息(预聊天、离线聊天和更新联系人详细信息表单)。要预先填写任何产品配置中的所有表格,请使用预先填充。
参数
数据
:对象。包含属性名字
,电子邮件
,可选组织
。
当存在无效键、有效键上的无效数据或传递非对象类型时,会出现控制台警告。
例子
<脚本类型="text / javascript">
泽(“webWidget”,“确定”,{
名字:“Akira Kogane”,
电子邮件:'(电子邮件保护)',
组织:“Voltron公司”。
});
脚本>
注意:传递组织仅适用于您的Zendesk Support帐户中的现有组织。亚博它不会创建一个新的组织。
注销
泽(“webWidget”、“注销”);
清除终端用户会话。
参数
没有一个
在开放
zf ('webWidget:on', 'open', callback
在打开小部件时执行回调。
参数
回调
:函数。包含要执行的代码。
例子
<脚本类型="text / javascript">
泽(“webWidget:”,“开放”,函数(){
控制台。日志(“插件已打开!”);
});
脚本>
在关闭
zf ('webWidget:on', 'close', callback
在小部件关闭时执行回调。
参数
回调
:函数。包含要执行的代码。
例子
<脚本类型="text / javascript">
泽(“webWidget:”,“关闭”,函数(){
控制台。日志(“插件已关闭!”);
});
脚本>
在userEvent
zE('webWidget:on', 'userEvent', function(userEvent
在触发用户事件时执行回调。这可以作为一种灵活的方式将第三方分析工具集成到小部件中,并过滤发送到谷歌analytics的事件。此设置甚至可以应用于分析设置用于禁用用户事件跟踪。
参数
回调
:函数。对每个用户事件执行的回调。包含一个参数,userEvent
的对象行动
,属性
,类别
事件的。
属性
是具有给定事件数据的对象还是未定义的
如下所示。
小部件
行动 | 属性 |
---|---|
Web Widget已打开 | 未定义的 |
最小化Web小部件 | 未定义的 |
闲谈,聊天
行动 | 属性 |
---|---|
聊天了 | 未定义的 |
聊天所示 | 未定义的 |
接线员提供的聊天服务 | {代理:<代理显示名称>} |
聊天评价良好 | 未定义的 |
聊天评价差 | 未定义的 |
聊天评级删除 | 未定义的 |
聊天评论提交 | 未定义的 |
聊天请求表单已提交 | {department: <部门名称>}* |
*部门可能未定义。
触点形式
行动 | 属性 |
---|---|
所示联络表格 | {id: <表单id>, name: <表单名称>}** |
已提交联系表格 | {id: <表单id>, name: <表单名称>}** |
**如果票证表单未启用,则属性值为{name: 'contact-form'}
。
帮助中心
行动 | 属性 |
---|---|
显示帮助中心 | 未定义的 |
帮助中心搜索 | {搜索词:<搜索词>} |
帮助中心文章查看 | {id: <文章id>,名称:<文章名称>} |
点击“帮助中心查看原文” | {id: <文章id>,名称:<文章名称>} |
回答机器人
行动 | 属性 |
---|---|
问答机器人文章查看 | {id: <文章id>,名称:<文章名称>} |
说话
行动 | 属性 |
---|---|
讨论所示 | {contactOption: |
通话回呼请求已提交 | 未定义的 |
例子
<脚本类型="text / javascript">
泽(“webWidget:”,“userEvent”,函数(事件){
控制台。日志(事件。类别,事件。行动,事件。属性);
});
脚本>
开放
泽(“webWidget”、“开放”);
强制打开小部件。
参数
没有一个
预先填充
zE('webWidget', 'prefill', data
在Web Widget内的表单上预填充最终用户的详细信息。
参数
数据
:对象。包含一个名字
,电子邮件
和电话
对象。
例子
<脚本类型="text / javascript">
泽(“webWidget”,“预先填充”,{
名字:{
价值:“isamu”,
只读的:真正的/ /可选
},
电子邮件:{
价值:'(电子邮件保护)',
只读的:真正的/ /可选
},
电话:{
价值:“61431909749”,
只读的:真正的/ /可选
}
});
脚本>
重置
泽(“webWidget”,“重置”);
完全重置小部件的状态。为了保持最终用户体验,此API仅在小部件最小化时才起作用。
参数
没有一个
setLocale
zE('webWidget', 'setLocale', data
设置小部件区域设置。
该命令接受locale字符串作为参数。有关支持的区域设置和相关代码的列表,请参见https://support.亚博zendesk.com/api/v2/locales/public.json。
默认情况下,Web Widget (Classic)以与其Web浏览器的浏览器头相匹配的语言显示给最终用户。如果您想强制该小部件在您的网站上以特定语言显示,您可以使用zE('webWidget', 'setLocale', data
指定语言。
请注意:此代码应紧接在Web Widget (Classic)代码段之后。
参数
数据
:字符串。要将小部件区域设置更改为的区域设置字符串。
例子
下面的例子用德语显示这个小部件:
<脚本类型="text / javascript">
泽(“webWidget”,“setLocale”,“德”);
脚本>
显示
泽(“webWidget”,“显示”);
在宿主页面上以隐藏前的状态显示小部件。
默认情况下,小部件在页面加载时显示。你不需要打电话显示
来显示小部件,除非使用隐藏
。
例子
<脚本类型="text / javascript">
泽(“webWidget”,“显示”);
脚本>
切换
泽(“webWidget”、“切换”);
如果小部件已关闭,则打开该小部件,如果已打开则关闭该小部件。
参数
没有一个
updatePath
zf ('webWidget', 'updatePath', data
通过将标题设置为当前用户的页面标题并将url设置为用户的当前url来更新访问者路径。
请注意:此API还更新聊天中的路径。
参数
数据
:对象。该对象接受两个可选的字符串参数标题
和url
。请注意url
参数必须是一个完整的URL,包括方案。
例子
<脚本类型="text / javascript">
泽(“webWidget”,“updatePath”,{
标题:“Voltron”,
url:“https://example.com/voltron”
});
脚本>
updateSettings
zE('webWidget', ' updatessettings ', data
更新小部件的zESettings。它可以一次更新多个设置。
参数
数据
:对象。中定义的结构匹配zESettings
例子
<脚本类型="text / javascript">
泽(“webWidget”,“updateSettings”,{
webWidget:{
闲谈,聊天:{
部门:{
启用:[“金融”,“人力资源”,“销售”],
选择:“销售”
}
}
}
});
脚本>