JSON 格式
触发器表示为具有以下属性的 JSON 对象。
| 名称 | 类型 | 只读 | 描述 |
| name | 字符串 | 否 | 触发器的名称 |
| enabled | 整数 | 否 | 触发器是否已启用 |
| description | 字符串 | 否 | 触发器的描述 |
| 定义 | 对象 | no | 触发器的定义。有关详情，请参阅下面的触发器定义。 |
触发器定义
注意：定义在更新触发器中不可编辑。
有关每个触发器的详细描述，请参阅触发器条件和操作参考。
触发器可使用 JSON 简单定义。每个触发器都是一个带有 3 个键的 JSON 对象：
| 触发器定义键 | 描述 |
| 活动日志 | （JSON 字符串）为此触发器激活的事件类型。有关事件列表，请参阅触发器事件。 |
| 条件 | （JSON 列表）此触发器执行其操作所必须满足的条件。有关更多详情，请参阅条件类型 |
| 操作 | action（JSON 列表）满足条件时要执行的操作列表。有关更多详情，请参阅触发器操作。 |
触发器事件
您可以使用以下活动日志：
| 触发器事件 | 描述 |
| page_Enter | 当访问者加载在线交谈小组件时，会触发此事件。 |
| chat_requested | 当访问者请求在线交谈时会触发此事件。 |
| chat_message | 当访问者发送在线交谈消息时，会触发此事件。 |
条件活动日志
您可以使用以下条件：
| 条件类型 | 描述 |
| 或 | 检查是否满足任意条件 |
| 和 | 检查是否满足所有条件 |
条件变量运算符
您可以将以下运算符用于条件变量。运算符可能不可用于不同的变量。
| 运算符 | 描述 |
| EQ | 等于 |
| neq | 不等于 |
| lt | 小于 |
| gt | 大于 |
| lte | 小于或等于 |
| gte | 大于或等于 |
| 图标包含 | 包含 |
| 尼古丁含有 | 不包含 |
| 包含 | 包含（区分大小写） |
| ncontains | 不包含（区分大小写） |
| 正则表达式 | 正则表达式匹配（区分大小写） |
| iregex | 正则表达式 |
条件变量
您可以使用以下变量：
时间和日期变量
| 类型 | 描述 |
| @hour_of_day | 一天中的时间（UTC 时区），0 到 23 |
| @day_of_week | 一周中的日子。0 = 周一，6 = 周日 |
| @visitor_time_on_page | 访问者停留在当前页面上的秒数 |
| @visitor_time_on_site | 访问者停留在您网站上的秒数 |
| 仍然在现场 | 检查下一个条件之前的延迟（秒数） |
| 仍然在页面上 | 检查下一个条件之前的延迟（秒数） |
访问者位置
| 类型 | 描述 |
| @visitor_ip | 访问者的 IP 地址（xxx.xxx.xxx.xxx） |
| @visitor_hostname | 访问者 IP 地址的主机名称 |
| @visitor_city | 访问者来自的城市 |
| @visitor_region | 访问者来自的地区 |
| @visitor_country_code | 访问者的两字母国家代码 |
| @visitor_country_name | 访问者来自的国家 |
上一次访问信息
| 类型 | 描述 |
| @visitor_prefore_visits | 访问者之前访问的次数。第一次访问 = 0 |
| @visitor_prefore_chats | 访问者与专员在线交谈的次数。第一次在线交谈 = 0 |
页面信息
| 类型 | 描述 |
| @visitor_page_url | 访问者当前访问页面的 URL |
| @visitor_page_title | 访问者当前访问页面的标题 |
| @visitor_page_count | 访问者查看的页面数。第一页 = 1 |
| @推荐人 | 访问者访问的上一个页面 URL |
访问者信息
| 类型 | 描述 |
| @visitor_name | 访问者名称 |
| @visitor_email | 访问者的电邮 |
| @visitor_推荐人 | 访问者的引用 URL（当其进入您的网站时） |
| @visitor_search_engine | 引用的搜索引擎（如适用） |
| @visitor_search_terms | 引用的搜索词（如适用） |
| @visitor_tags | 工单标签名称（由操作“设置工单标签”设置） |
| @visitor_triggered | 如果访问者已触发（由操作“设置已触发”设置），则为“true” |
| @visitor_department_id | 访问者的部门（由操作“设置访问者部门”或 JavaScript API 设置） |
访问者软件/计算机
| 类型 | 描述 |
| @visitor_user_agent | 访问者浏览器的用户代理字符串 |
| @visitor_browser | 访问者的浏览器 |
| @visitor_platform | 访问者的操作系统/平台 |
在线状态
| 类型 | 描述 |
| @account_status | 您的帐户状态（在线/离开/离线） |
| @visitor_status | 访问者的状态（在线/空闲/离线） |
在线交谈相关信息
| 类型 | 描述 |
| @visitor_requesting_chat | 如果是访问者请求的在线交谈，则为“true” |
| @visitor_served | 如果当前专员已为访问者提供服务，则为“true” |
| @部门 | 访问者在在线交谈请求表格中选择的部门（名称） |
| @visitor_served | 如果当前专员已为访问者提供服务，则为“true” |
| @sender | 消息发送人的姓名 |
| @sender_type | 'agent' 或 'visitor' |
| @message | 发送的消息 |
触发器操作
| 操作 | 参数 | 描述 |
| sendMessageToVisitor | 专员姓名和消息（字符串） | 给访问者发送消息 |
| setTriggered | True/false（布尔值） | 设置访问者的“已触发”标志 |
| 等待 | Duration (in secs) (number) | 等待指定的秒数，如果访问者仍在线，则执行列表中的下一个操作 |
| addTag | 工单标签名称（字符串） | 为访问者添加一个工单标签，该工单标签在面板访问者列表中可见 |
| 移除工单标签 | 工单标签名称（字符串） | 从访问者的会话中移除标签 |
| 禁止访问者 | 原因（字符串） | 禁止访问者，有原因 |
| 禁止 IP | 原因（字符串） | 禁止访问者的 IP 地址，原因 |
| setName | 访问者名称（字符串） | 设置访问者的名称 |
| setDepartment | 部门 ID（数字） | 设置访问者当前的部门 |
| 设置注释 | 注释（字符串） | 为访问者设置一条注释，该注释在面板中可见，并且是永久性的 |
| 附加注释 | 注释（字符串） | 附加注释到访问者当前注释的末尾 |
获取所有触发器
GET /api/v2/triggers
列出帐户的所有触发器。
已允许
Owner
Administrator
使用 cURL
curlhttps://www.zopim.com/api/v2/triggers\
-v -u {email_address}:{password}
响应范例
HTTP/1.1 200 好
Content-Type：application/json
[
{
"name" ："Good Trigger",
"enabled" ：1、
"description" ：“访问者已输入页面”
}，
{
"name" ："更好的触发器"，
"enabled" ：1、
"description" ：“访问者请求在线交谈”
}
]
获取触发器
GET /api/v2/triggers/{trigger_name}
允许帐户所有者/管理员按名称检索触发器。
已允许
Owner
Administrator
使用 cURL
curlhttps://www.zopim.com/api/v2/triggers/{trigger_name}\
-v -u {email_address}:{password}
响应范例
HTTP/1.1 200 好
Content-Type：application/json
{
"name" ："Good Trigger",
"enabled" ：1、
"description" ："访问者请求在线交谈",
}
创建触发器
POST /api/v2/triggers
允许帐户所有者/管理员在帐户中添加触发器。
已允许
Owner
Administrator
使用 cURL
curlhttps://www.zopim.com/api/v2/triggers\
-d '{
"name" ："Good Trigger",
"enabled" ：1、
"description" ：“访问者请求在线交谈”
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type:application/json"
响应范例
HTTP/1.1 201 已创建
Content-Type：application/json
{
"name" ："Good Trigger",
"enabled" ：1、
"description" ："访问者请求在线交谈",
}
将消息发送到特定的页面/目录
发送自动消息到特定 URL 或目录
curlhttps://www.zopim.com/api/v2/triggers\
-d '{
"name" ："Strape Shoe",
"enabled" ：1、
"description" ："发送 Stripe Shoe 的折扣代码",
"define" : {
"event" : "page_Enter",
"condition" : [
"and"、
[
"icontains",
"@visitor_page_url"、
"s Stripdesk"
]，
[
"silonOnPage",
20
]
]，
"actions" : [
[
"sendMessageToVisitor",
"Timmy",
“我们有一个折扣代码给您！在您下次结帐时使用 DISCOUNT10”
]
]
}
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type:application/json"
有关触发器的详细配置，请前往帐户的触发器页面
更新触发器
PUT /api/v2/triggers/{trigger_name}
允许帐户所有者/管理员更新触发器的数据。
已允许
Owner
Administrator
使用 cURL
curlhttps://www.zopim.com/api/v2/triggers/{trigger_name}\
-d '{
"name" ："Best Trigger",
"description" ：“访问者已请求新在线交谈”
}' \
-v -u {email_address}:{password} \
-X PUT -H "Content-Type:application/json"
响应范例
HTTP/1.1 200 好
Content-Type：application/json
{
"name" ："Best Trigger",
"enabled" ：1、
"description" ："访问者已请求新建在线交谈",
}
删除触发器
DELETE /api/v2/triggers/{trigger_name}
允许帐户所有者/管理员删除触发器。
已允许
Owner
Administrator
使用 cURL
curlhttps://www.zopim.com/api/v2/triggers/{trigger_name}\
-v -u {email_address}:{password} -X DELETE
响应范例
HTTP/1.1 204 OK
Content-Type：application/json
翻译免责声明：本文章使用自动翻译软件翻译，以便您了解基本内容。 我们已采取合理措施提供准确翻译，但不保证翻译准确性
如对翻译准确性有任何疑问，请以文章的英语版本为准。