Triggers API - 逸创云客服开发者平台-全渠道智能云客服系统-工单系统/云呼叫中心/移动客服/微信客服/邮件客服

开发者首页 SSO单点登录 Restful API 网页客服组件API IOS SDK 安卓 SDK

Triggers 触发器接口

JSON格式

Name	Type	Comment
id	integer	创建触发器时系统自动分配
url	string	此触发器的url地址
title	string	触发器的标题
status	bool	该触发器是否被启用，"true"or"false"
conditions	Condition	触发器被触发的条件
actions	Action	触发器触发后，执行的动作
created_at	date	触发器创建时间

JSON示例


{
	"trigger": {
	   "id": 985,
	   "url": "https://{subdomain}.kf5.com/apiv2/triggers/985.json",
	   "title": "提醒工单发起人已收到工单",
	   "status": true,
	   "sort": 2,
	   "created_at": "2016-05-10 14:02:39",
	   "conditions":  { ... },
	   "actions":  { ... }
	}
}

条件格式


{
       "conditions": {
	 "all": [
		{"source": "status","operator": "changed_to","value": "3"},
		{"source": "group_id","operator": "is_not","value": "219"},
	],
	 "any": [
		{"source": "priority","operator": "less_than","value": "0"}
	]
  }
}

条件最外层包裹的all 与 any，表示条件包含的两种逻辑，当满足符合设置的条件时，触发器开始生效。

Name	Type	Comment
all	array	AND逻辑，其中所包含的条件，必须全部满足
any	array	OR逻辑，其中所包含的条件，必须满足任一或多个

每一个条件内部都包含以下属性

Name	Type	Comment
source	string	条件来源，例如"工单状态""工单发起人"等
operator	string	操作符，例如"小于""改变为"等
value	string	所设定的值，例如"受理中""已关闭"等

所有条件列表

下列表格列出了所有条件的描述和对应的操作符以及各自的设定值。

Source	Operator	Value
status(工单：状态)	is(是) is_not(不是) less_than(小于) greater_than(大于) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	0(尚未受理) 1(受理中) 2(等待回复) 3(已解决) 4(已关闭)
type_id(工单：类型)	is(是) is_not(不是) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(空)(-) 0(问题) 1(失误) 2(故障) 3(任务)
priority(工单：优先级)	is(是) is_not(不是) less_than(小于) greater_than(大于) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(空)(-) 0(低) 1(中) 2(高) 3(紧急)
group_id(工单：受理客服组)	is(是) is_not(不是) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(空)(-) (current_groups)(当前客服组) 数字表示该客服组id，例如 219(电话语音客服组)
requester_id(工单：发起人)	is(是) is_not(不是) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(current_user)(当前用户) 数字表示该用户id，例如 1310(语音客服3)
assignee_id(工单：受理客服)	is(是) is_not(不是) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(空)(-) (current_user)(当前用户) 数字表示该用户id，例如 1315(语音客服8)
source(工单：提交来源)	is(是) is_not(不是)	web(网页表单) tab(反馈组件留言) chat(KCHAT交谈) weibo(新浪微博) api(API接口) mobile(手机端) email(邮件) voicemail(语音留言Voicemail) inbound(电话呼入) outbound(电话呼出)
recipient(工单：收件邮箱)	is(是)	例如 support@b.kf5.co(support@b.kf5.co)
score(工单：满意度)	is(是) is_not(不是) less_than(小于) greater_than(大于) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(空)(-) 1(不满意) 2(不太满意) 3(一般) 4(满意) 5(非常满意)
tags(工单：标签)	contain_at_least_one(至少包含以下中的一个) not_contain(不包含)	多个标签填写请用空格隔开，例如产品A 售后
description(工单：问题描述)	contain(包含) not_contain(不包含)	例如服务咨询
comment_is_public(工单：评论)	is(是)	1(公开) 0(私密)
{ticket}(工单)	is(是)	created(被创建) updated(被更新) pushed(被催单)
{current_user}(当前用户)	is(是)	agent(客服) enduser(普通用户) 数字表示该用户id，例如 1315(语音客服8)
organization(发起人：公司组织)	is(是) is_not(不是) changed(已改变) changed_to(改变为...) changed_from(从...改变) not_changed(未改变) not_changed_to(未改变为...) not_changed_from(不是从...改变)	(空)(-) 数字表示公司组织id，例如 159(电话组织)
{language}(发起人：语音)	is(是) is_not(不是)	zh_cn(简体中文) en(English)
field_数字(自定义字段标题，支持下拉字段)	is(是) is_not(不是)	(空)(-) 自定义字段的值

Source

Operator

Value

status(工单：状态)

is(是)

is_not(不是)

less_than(小于)

greater_than(大于)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

0(尚未受理)

1(受理中)

2(等待回复)

3(已解决)

4(已关闭)

type_id(工单：类型)

is(是)

is_not(不是)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(空)(-)

0(问题)

1(失误)

2(故障)

3(任务)

priority(工单：优先级)

is(是)

is_not(不是)

less_than(小于)

greater_than(大于)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(空)(-)

0(低)

1(中)

2(高)

3(紧急)

group_id(工单：受理客服组)

is(是)

is_not(不是)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(空)(-)

(current_groups)(当前客服组)

数字表示该客服组id，例如

219(电话语音客服组)

requester_id(工单：发起人)

is(是)

is_not(不是)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(current_user)(当前用户)

数字表示该用户id，例如

1310(语音客服3)

assignee_id(工单：受理客服)

is(是)

is_not(不是)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(空)(-)

(current_user)(当前用户)

数字表示该用户id，例如

1315(语音客服8)

source(工单：提交来源)

is(是)

is_not(不是)

web(网页表单)

tab(反馈组件留言)

chat(KCHAT交谈)

weibo(新浪微博)

api(API接口)

mobile(手机端)

email(邮件)

voicemail(语音留言Voicemail)

inbound(电话呼入)

outbound(电话呼出)

recipient(工单：收件邮箱)

is(是)

例如

support@b.kf5.co(support@b.kf5.co)

score(工单：满意度)

is(是)

is_not(不是)

less_than(小于)

greater_than(大于)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(空)(-)

1(不满意)

2(不太满意)

3(一般)

4(满意)

5(非常满意)

tags(工单：标签)

contain_at_least_one(至少包含以下中的一个)

not_contain(不包含)

多个标签填写请用空格隔开，例如

产品A 售后

description(工单：问题描述)

contain(包含)

not_contain(不包含)

例如

服务咨询

comment_is_public(工单：评论)

is(是)

1(公开)

0(私密)

{ticket}(工单)

is(是)

created(被创建)

updated(被更新)

pushed(被催单)

{current_user}(当前用户)

is(是)

agent(客服)

enduser(普通用户)

数字表示该用户id，例如

1315(语音客服8)

organization(发起人：公司组织)

is(是)

is_not(不是)

changed(已改变)

changed_to(改变为...)

changed_from(从...改变)

not_changed(未改变)

not_changed_to(未改变为...)

not_changed_from(不是从...改变)

(空)(-)

数字表示公司组织id，例如

159(电话组织)

{language}(发起人：语音)

is(是)

is_not(不是)

zh_cn(简体中文)

en(English)

field_数字(自定义字段标题，支持下拉字段)

is(是)

is_not(不是)

(空)(-)

自定义字段的值

动作格式


{
	"actions": [
		{
			"source": "email_user",
			"value": "(requester)",
			"subject": "[{{account.name}}]  工单: {{ticket.title}} 已被解决",
			"body": "请点击以下链接查看该工单处理或继续回复工单：{{ticket.url}}"
		},
		{
			"source": "field_757",
			"value": "99",
			"subject": null,
			"body": null
		}
	]
}

每一个动作包含以下属性

Name	Type	Comment
source	string	动作来源，例如"工单状态""工单发起人"等
value	string	所设定的值，例如"受理中""已关闭"等
subject	string	主题。当执行通知邮件时，可以填写此选项
body	string	内容。当执行通知邮件或者内部提醒时，可以填写此选项

所有动作列表

下列表格列出了所有动作的描述和对应的设定值。

Action	Value
status(工单：状态)	0(尚未受理) 1(受理中) 2(等待回复) 3(已解决) 4(已关闭)
type_id(工单：类型)	(空)(-) 0(问题) 1(失误) 2(故障) 3(任务)
priority(工单：优先级)	(空)(-) 0(低) 1(中) 2(高) 3(紧急)
group_id(工单：受理客服组)	(空)(-) (current_groups)(当前客服组) 数字表示该客服组id，例如 219(电话语音客服组)
assignee_id(工单：受理客服)	(空)(-) (current_user)(当前用户) 数字表示该用户id，例如 1315(语音客服8)
inturn_assign(工单：客服组的客服轮流受理)	数字表示该客服组id，例如 219(电话语音客服组)
tags(工单：添加工单标签)	多个标签填写请用空格隔开，例如产品A 售后
ccs(添加工单副本)	(assignee)(工单受理客服) 数字表示该用户id，例如 1315(语音客服8)
field_数字(自定义字段标题，支持下拉字段)	(空)(-) 自定义字段的值
score(工单：满意度)	(空)(-) 1(不满意) 2(不太满意) 3(一般) 4(满意) 5(非常满意)
email_user(通知：发邮件给用户)	(current_user)(当前用户) (requester)(工单发起人) (assignee)(工单受理客服) 数字表示该用户id，例如 1315(语音客服8)
email_group(通知：发邮件给客服组)	(assigned_group)(受理客服组) 数字表示该客服组id，例如 1315(语音客服8)
message_user(通知：发内部提醒(后台/微信助手/APP)给客服)	(assignee)(工单受理客服) 数字表示该客服id，例如 1315(语音客服8)
message_user(通知：发内部提醒(后台/微信助手/APP)给客服组)	(assigned_group)(工单受理客服组) 数字表示该客服组id，例如 135(管理客服组)
target(通知：发送消息到指定目标)	webhook的id(webhook的标题)

其中，通知动作都有body选项，在发送邮件的通知动作中，可以设置subject选项

触发器列表


GET /apiv2/triggers.json

返回所有触发器，触发器按SORT倒序，ID正序排列

调用权限

admin

curl示例

curl https://{subdomain}.kf5.com/apiv2/triggers.json \
  -v -u {email_address}:{password}

返回示例

Status: 200 OK
{
    "triggers":
        {
            "id": 985,
            "url": "https://{subdomain}.kf5.com/apiv2/triggers/985.json",
            "title": "提醒工单发起人已收到工单",
            "status": true,
            "sort": 2,
            "created_at": "2016-05-10 14:02:39",
            "conditions":  { ... },
            "actions":  { ... }
        }
}

查看指定ID的触发器

GET /apiv2/triggers/{id}.json

调用权限

admin

curl示例

curl https://{subdomain}.kf5.com/apiv2/triggers/{id}.json \
  -v -u {email_address}:{password}

返回示例

Status: 200 OK
{
    "triggers":
        {
            "id": 1215,
            "url": "https://{subdomain}.kf5.com/apiv2/triggers/1215.json",
            "title": "email: 提示工单发起人 工单有回复",
            "status": false,
            "sort": 0,
            "created_at": "2016-05-15 13:22:12",
            "conditions": { ... },
            "actions":  { ... }
        }
}

查看启用的触发器列表

GET /apiv2/triggers/active.json

调用权限

admin

curl示例

curl https://{subdomain}.kf5.com/apiv2/triggers/active.json \
  -v -u {email_address}:{password}

返回示例

Status: 200 OK
{
    "triggers": 
        {
            "id": 985,
            "url": "https://{subdomain}.kf5.com/apiv2/triggers/985.json",
            "title": "提醒工单发起人已收到工单",
            "status": true,
            "sort": 2,
            "created_at": "2016-05-10 14:02:39",
            "conditions":  { ... },
            "actions":  { ... }
        }
}

在线客服电话咨询返回顶部

开发者平台

说明与示例

Restful API 接口

V1老版本API

Triggers 触发器接口

JSON格式

JSON示例

条件格式

所有条件列表

动作格式

所有动作列表

触发器列表

调用权限

curl示例

返回示例

查看指定ID的触发器

调用权限

curl示例

返回示例

查看启用的触发器列表

调用权限

curl示例

返回示例