※注意:调用接口时需增加subdomain 参数
获取外呼任务列表
该接口用于获取公司下所有手动外呼任务列表
请求方法
GET /open_api_v1/outbound_task
请求参数
参数名 |
必填 |
说明 |
pageNum |
否 |
页码,默认第一页 |
pageSize |
否 |
每页大小,默认100 |
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
执行结果说明 |
执行成功为OK,其他情况返回对应异常信息 |
paging |
对象 |
分页信息 |
data |
对象数组 |
外呼任务列表信息,任务ID、任务名称、创建时间 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 100,
"total": 100
},
"data": [
{
"id": 271,
"name": "外呼任务1",
"createdAt": "2020-07-07T16:53:45.000+08:00"
},
{
"id": 272,
"name": "客户和外呼业务字段映射",
"createdAt": "2020-07-07T16:57:28.000+08:00"
}
]
}
获取外呼任务详情
该接口用于获取指定id的外呼任务信息
请求方法
GET /open_api_v1/outbound_task/{id}
请求参数(URL)
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
字符串类型 |
执行成功为OK,其他情况返回对应异常信息 |
data |
对象类型 |
外呼任务详情 |
data
属性名 |
类型 |
说明 |
id |
整型 |
唯一标识 |
name |
字符串 |
名称 |
description |
字符串 |
描述 |
startAt |
日期时间 |
任务开始时间 |
endAt |
结束时间 |
任务结束时间 |
createdAt |
日期时间 |
创建时间 |
status |
字符串 |
状态,not_start为未开始,processing为进行中,expired为已过期,pause为暂停 |
importMethod |
字符串 |
导入策略-导入方式,open为导入客户中心,close为不导入客户中心 |
holdImportRepeat |
字符串 |
导入策略,update为更新导入表单中重复部分,not_update为放弃导入表单中重复部分 |
distributionStrategy |
字符串 |
客户坐席分配策略,average为平均分配(默认),balance为负载均衡分配,manual为手动分配 |
hideNumber |
布尔 |
是否掩码,true为掩码,false为不掩码(默认) |
taskFilter |
对象 |
外呼任务过滤器,如下 |
agentIds |
数组 |
客服ID数组 |
customerCount |
整型 |
客户数量 |
executedCount |
整型 |
任务执行数,每个联系单中客户只统计一次 |
connectedCount |
整型 |
任务接通数,每个联系单中客户只统计一次 |
sucRate |
浮点类型 |
执行成功率 |
numberFilterStrategy |
字符串 |
号码策略-过滤设置,默认为repeatNumber |
questionnaireId |
整型 |
外呼任务绑定调查问卷模板ID |
calloutNoteTemplateId |
整型 |
外呼任务关联外呼业务信息模板ID |
taskFilter
属性名 |
类型 |
说明 |
calloutTaskId |
整型 |
所属外呼任务 |
conditions |
对象数组 |
过滤器条件信息,如下 |
defaultCondition |
对象 |
默认过滤器,如下 |
conditions|defaultCondition
属性名 |
类型 |
说明 |
id |
整型 |
过滤器id |
name |
字符串 |
过滤器名称 |
agentIds |
数组 |
使用该过滤器的坐席 |
option |
字符串 |
过滤器类型,all_condition为满足以下全部条件,any_condition为满足任意条件,defaultCondition没有该值 |
condition |
对象 |
过滤器条件,defaultCondition时没有该值 |
condition
属性名 |
类型 |
说明 |
fieldName |
字符串 |
过滤器需要使用的字段 |
operation |
字符串 |
条件类型 |
value |
字符串 |
条件的值 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"id": 570,
"name": "任务呢",
"startAt": "2021-03-23T15:23:23.000+08:00",
"endAt": "2021-03-24T15:23:23.000+08:00",
"createdAt": "2021-03-22T15:26:12.000+08:00",
"status": "not_start",
"taskId": 570,
"customerId": 8915,
"cellphone": "13812344321",
"agentIds": [
19,
57
],
"questionnaireId": 1,
"distributionStrategy": "average",
"calloutNoteTemplateId": 8,
"hideNumber": true,
"description": "描述",
"numberFilterStrategy": "repeatNumber",
"customerCount": 0,
"importMethod": "open",
"holdImportRepeat": "update",
"sucRate": 0.0,
"taskFilter": {
"calloutTaskId": 570,
"active": 1,
"permission": "",
"permissionId": null,
"groupName": null,
"creator": null,
"conditions": [
{
"name": "客户名称过滤",
"id": 2,
"agentIds": [
19,
57
],
"option": "all_condition",
"condition": [
{
"fieldName": "name",
"operation": "is",
"value": "客户名称"
}
]
}
],
"defaultCondition": {
"name": "客户数据",
"id": 1,
"agentIds": [
19,
57
],
"option": null,
"condition": null
}
},
"executedCount": 0,
"connectedCount": 0
}
}
创建外呼任务
该接口用于获取创建外呼任务
请求方法
POST /open_api_v1/outbound_task
请求参数(Request Body)
属性名 |
类型 |
新建必填 |
说明 |
name |
字符串 |
是 |
名称 |
description |
字符串 |
|
描述 |
startAt |
日期时间 |
是 |
开始时间 |
endAt |
结束时间 |
是 |
结束时间 |
numberFilterStrategy |
字符串 |
|
号码策略-过滤设置,默认为repeatNumber |
distributionStrategy |
字符串 |
是 |
客户坐席分配策略,average为平均分配(默认),balance为负载均衡分配,manual为手动分配 |
hideNumber |
布尔类型 |
|
是否掩码,true为掩码,false为不掩码(默认) |
agentIds |
数组 |
|
客服ID数组 |
questionnaireId |
整型 |
|
外呼任务绑定调查问卷模板ID |
calloutNoteTemplateId |
数组 |
|
外呼任务关联外呼业务信息模板ID |
taskFilter |
对象 |
|
外呼任务过滤器 |
taskFilter
属性名 |
类型 |
说明 |
calloutTaskId |
整型 |
所属外呼任务 |
conditions |
对象数组 |
过滤器条件信息,如下 |
defaultCondition |
对象 |
默认过滤器,如下 |
conditions|defaultCondition
属性名 |
类型 |
说明 |
name |
字符串 |
过滤器名称 |
agentIds |
数组 |
使用该过滤器的坐席 |
option |
字符串 |
过滤器类型,all_condition为满足以下全部条件,any_condition为满足任意条件,defaultCondition没有该值 |
condition |
对象 |
过滤器条件,defaultCondition时没有该值 |
condition
属性名 |
类型 |
说明 |
fieldName |
字符串 |
过滤器需要使用的字段 |
operation |
字符串 |
条件类型 |
value |
字符串 |
条件的值 |
返回数据
与获取外呼任务详情相同。
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-X POST \
-H 'content-type: application/json' \
-d '
{
"name": "Outbound missions in 20211229175404",
"description": " 无",
"agentIds": [
573
],
"distributionStrategy": "average",
"hideNumber": false,
"numberFilterStrategy": "repeatNumber",
"calloutNoteTemplateId": 3,
"questionnaireId": 101,
"startAt": "2021-12-07 09:00:00",
"endAt": "2021-12-25 09:07:44",
"taskFilter": null
}'
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"id": 988,
"userId": 18,
"name": "Outbound missions in 20211229175404",
"startAt": "2021-12-07 09:00:00",
"endAt": "2021-12-25 09:07:44",
"taskType": null,
"agentType": null,
"status": "not_start",
"agentIds": [
573
],
"queueIds": null,
"questionnaireId": 101,
"customFieldId": null,
"distributionStrategy": "average",
"calloutNoteTemplateId": 3,
"hideNumber": false,
"isRepeatCustomerTask": null,
"focusCalloutNoteFieldId": null,
"distributionBasis": null,
"isNumberMask": null,
"description": " 无",
"customDistribution": null,
"numberFilterStrategy": "repeatNumber",
"calloutTaskCustomerFilter": null,
"customerCount": null,
"sucRate": 0.0,
"importMethod": "open",
"holdImportRepeat": "update",
"taskFilter": null,
"connectedCount": 0,
"executedCount": 0
}
}
更新外呼任务
该接口用于修改外呼任务
请求方法
PUT /open_api_v1/outbound_task/{id}
请求参数(URL)
请求参数(Request Body)
属性名 |
类型 |
新建必填 |
说明 |
name |
字符串 |
是 |
名称 |
description |
字符串 |
|
描述 |
startAt |
日期时间 |
是 |
开始时间 |
endAt |
结束时间 |
是 |
结束时间 |
distributionStrategy |
字符串 |
是 |
客户坐席分配策略,average为平均分配(默认),balance为负载均衡分配,manual为手动分配 |
hideNumber |
布尔类型 |
|
是否掩码,true为掩码,false为不掩码(默认) |
agentIds |
数组 |
|
客服ID数组 |
taskFilter |
对象 |
|
外呼任务过滤器 |
taskFilter
属性名 |
类型 |
说明 |
calloutTaskId |
整型 |
所属外呼任务 |
conditions |
对象数组 |
过滤器条件信息,如下 |
defaultCondition |
对象 |
默认过滤器,如下 |
conditions|defaultCondition
属性名 |
类型 |
说明 |
name |
字符串 |
过滤器名称 |
agentIds |
数组 |
使用该过滤器的坐席 |
option |
字符串 |
过滤器类型,all_condition为满足以下全部条件,any_condition为满足任意条件,defaultCondition没有该值 |
condition |
对象 |
过滤器条件,defaultCondition时没有该值 |
condition
属性名 |
类型 |
说明 |
fieldName |
字符串 |
过滤器需要使用的字段 |
operation |
字符串 |
条件类型 |
value |
字符串 |
条件的值 |
返回数据
与获取外呼任务详情接口相同。
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-X PUT \
-H 'content-type: application/json' \
-d '
{
"name": "外呼任务n",
"description": "创建新外呼任务",
"agentIds": [
19,
57
],
"distributionStrategy": "balance",
"hideNumber": true,
"startAt": "2021-03-22 16:46:15",
"endAt": "2021-03-24 16:46:15"
}'
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"id": 121,
"name": "外呼任务哦",
"startAt": "2021-03-22T16:46:15.000+08:00",
"endAt": "2021-03-24T16:46:15.000+08:00",
"createdAt": "2021-03-22T18:07:19.000+08:00",
"status": "not_start",
"taskId": 112,
"customerId": 8915,
"cellphone": "13812344321",
"agentIds": [
19,
57
],
"queueIds": null,
"questionnaireId": 6,
"distributionStrategy": "balance",
"calloutNoteTemplateId": 4,
"hideNumber": true,
"description": "创建新外呼任务",
"customDistribution": null,
"numberFilterStrategy": "repeatNumber",
"customerCount": 0,
"importMethod": "open",
"holdImportRepeat": "update",
"sucRate": 0.0,
"taskFilter": null,
"executedCount": 0,
"connectedCount": 0
}
}
删除外呼任务
该接口用于删除指定id的外呼任务
请求方法
DELETE /open_api_v1/outbound_task/{id}
请求参数(URL)
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
执行结果说明 |
执行成功为OK,其他情况返回对应异常信息 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-X DELETE
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false
}
获取外呼任务联系单列表
该接口用于用于获取指定外呼任务下所有联系单列表
请求方法
GET /open_api_v1/outbound_task/{taskId}/contact_lists
请求参数(URL)
请求参数
参数名 |
必填 |
说明 |
pageNum |
否 |
分页页码,默认为1 |
pageSize |
否 |
分页大小,默认为10 |
keyword |
否 |
可根据联系单关键字搜索 |
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
执行结果说明 |
执行成功为OK,其他情况返回对应异常信息 |
paging |
对象 |
分页信息 |
data |
对象数组 |
联系单信息,如下 |
data
属性名 |
类型 |
说明 |
id |
整型 |
联系单ID |
name |
字符串 |
联系单名称 |
status |
字符串 |
联系单状态,not_start为未开始,processing为进行中,expired为已过期,pause为暂停 |
taskId |
整型 |
所属外呼任务ID |
customerCount |
整数 |
该联系单下所有客户数 |
connectRate |
字符串 |
联系单中客户执行成功率 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1/contact_lists?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 4,
"total": 4
},
"data": [
{
"id": 28,
"name": "联系单28",
"status": "processing",
"taskId": 112,
"customerCount": 0,
"connectRate": "0%"
}
]
}
获取外呼任务客户列表
该接口用于获取指定id外呼任务的客户信息
请求方法
GET /open_api_v1/outbound_task/customers
请求参数(Query String)
参数名 |
必填 |
说明 |
taskId |
是 |
外呼任务id |
contactListId |
否 |
联系单ID |
pageNum |
否 |
页码,默认为1 |
pageSize |
否 |
每页大小,默认为10,最大为100 |
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
执行结果说明 |
执行成功为OK,其他情况返回对应异常信息 |
paging |
对象 |
分页信息 |
data |
对象 |
任务数据 |
data元素的数据结构
属性名 |
类型 |
说明 |
taskId |
整型 |
外呼任务中子任务的id |
id |
整型 |
任务数据ID,区别于客户ID,分配坐席时使用该ID |
name |
字符串 |
客户姓名 |
cellphones |
数组 |
客户手机列表 |
agentId |
整型 |
客服id |
executedCount |
整型 |
执行次数 |
executedResult |
字符串 |
执行结果 |
contactListId |
整型 |
联系单ID |
cellphones元素的结构
属性名 |
类型 |
说明 |
name |
字符串 |
对应的英文字母 |
content |
字符串 |
电话号码 |
title |
字符串 |
联系方式对应名称 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/customers?company_id=1000002&subdomain=demo&taskId=1&pageNum=1&pageSize=10&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 10,
"total": 1
},
"data": [
{
"id": 391,
"taskId": 112,
"contactListId": 26,
"customerId": 8915,
"name": "这是一个客户",
"cellphone": "13812344321",
"cellphones": null,
"agentId": null,
"executedCount": null,
"executedResult": null
}
]
}
获取外呼任务客服列表
该接口用于获取指定id外呼任务的客服信息
请求方法
GET /open_api_v1/outbound_task/callout_tasks/agents
请求参数(Query String)
参数名 |
必填 |
说明 |
taskId |
是 |
外呼任务id |
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
执行结果说明 |
执行成功为OK,其他情况返回对应异常信息 |
data |
对象 |
客服数据 |
agents元素的数据结构
属性名 |
类型 |
说明 |
id |
整型 |
客服id |
name |
字符串 |
客服姓名 |
customerCount |
整型 |
客户数量 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/agents?company_id=1000002&subdomain=demo&taskId=1&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": [
{
"id": 114,
"name": "xxx",
"customerCount": 0
}
]
}
创建联系单
该接口用于创建联系单
请求方法
POST /open_api_v1/outbound_task/contact_list
请求参数
参数名 |
必填 |
说明 |
taskId |
是 |
外呼任务ID |
contactListName |
是 |
联系单名称 |
customers |
|
客户信息数组,可以为客户ID、token、邮箱、手机号;也可以支持传复杂对象数组 |
agentIds |
否 |
待分配任务数据的坐席 |
customerSource |
否 |
客户来源渠道:邮箱(email)、手机号(phone)、id(id)、token(apiToken),默认为手机号 |
customers参数
参数名 |
必填 |
说明 |
value |
是 |
可以为客户ID、token、邮箱、手机号 |
title |
否 |
客户名称 |
TextField_1 |
否 |
自定义文本字段,对应【管理中心】-【客户字段】中自定义字段中的字段ID |
SelectField_1 |
否 |
自定义字段,对应【管理中心】-【客户字段】中自定义字段中的字段ID;若字段为下拉字段时,值为下拉选项的值;字段为多选时,多个值直接使用英文逗号分隔;若字段为级联字段时,值之间使用英文“|”分割,比如:北京市|西城区|和谐路 |
返回数据
属性名 |
类型 |
说明 |
Id |
整型 |
联系单ID |
contactListName |
字符串 |
联系单名称 |
taskId |
整型 |
所属外呼任务ID |
status |
字符串 |
联系单状态,0为未开始,1为进行中,2为已过期,3为暂停 |
示例
curl -X POST \
https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-H 'content-type: application/json' \
-d '{
"taskId": 988,
"contactListName": "联系单名称",
"agentIds": [
348
],
"customers": [
{
"value": "aa@email.com",
"title": "客户名称-8",
"TextField_8": "单行文本字段呢",
"SelectField_12": "D选项",
"TextField_9": "2022-08-03 13:23",
"SelectField_13": "上单,打野",
"TextField_16": "13:23:45",
"TextField_17": "618001",
"TextField_18": "31400101001",
"SelectField_17": "天津市|和平区"
}
],
"customerSource": "email"
}'
返回结果
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"id": 1094,
"contactListName": "Contact form created in 20211229175404",
"status": "not_start",
"taskId": 988
}
}
更新联系单
该接口用于更新联系单
请求方法
PUT /open_api_v1/outbound_task/contact_list/{id}
请求参数
参数名 |
必填 |
说明 |
id |
是 |
联系单ID |
customers |
|
客户信息数组,可以为客户ID、token、邮箱、手机号;也可以支持传复杂对象数组 |
customerSource |
否 |
客户来源渠道:邮箱(email)、手机号(phone)、id(id)、token(apiToken),默认为手机号 |
customers参数
参数名 |
必填 |
说明 |
value |
是 |
可以为客户ID、token、邮箱、手机号 |
title |
否 |
客户名称 |
TextField_1 |
否 |
自定义文本字段,对应【管理中心】-【客户字段】中自定义字段中的字段ID |
SelectField_1 |
否 |
自定义字段,对应【管理中心】-【客户字段】中自定义字段中的字段ID;若字段为下拉字段时,值为下拉选项的值;字段为多选时,多个值直接使用英文逗号分隔;若字段为级联字段时,值之间使用英文“|”分割,比如:北京市|西城区|和谐路 |
返回数据
属性名 |
类型 |
说明 |
Id |
整型 |
联系单ID |
status |
字符串 |
联系单状态,0为未开始,1为进行中,2为已过期,3为暂停 |
示例
curl -X PUT \
https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-H 'content-type: application/json' \
-d '{
"customers": [
{
"value": "24097",
"title": "客户名称-8",
"TextField_8": "单行文本字段呢",
"SelectField_12": "D选项",
"TextField_9": "2022-08-03 13:23",
"SelectField_13": "上单,打野",
"TextField_16": "13:23:45",
"TextField_17": "618001",
"TextField_18": "31400101001",
"SelectField_17": "天津市|和平区"
}
],
"customerSource": "id"
}'
返回结果
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"id": 1094,
"status": "not_start"
}
}
删除联系单
该接口用于删除联系单
请求方法
DELETE /open_api_v1/outbound_task/contact_list/{id}
请求参数
示例
curl -X DELETE \
https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-H 'content-type: application/json'
返回结果
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"id": 1094,
"contactListName": "Contact form created in 20211229175404",
"status": "not_start",
"taskId": 988
}
}
获取外呼业务信息模板列表
该接口用于获取外呼业务信息模板列表
请求方法
GET /open_api_v1/outbound_task/template/call_out_notes
请求参数
属性名 |
必填 |
说明 |
pageNum |
否 |
页码 |
pageSize |
否 |
每页大小,默认为10,最大为100 |
返回数据
属性名 |
类型 |
说明 |
succeed |
布尔类型 |
是否执行成功 |
message |
执行结果说明 |
执行成功为OK,其他情况返回对应异常信息 |
paging |
对象 |
分页信息 |
data |
对象数组 |
外呼业务模板,如下 |
data元素的数据结构
属性名 |
类型 |
说明 |
id |
整型 |
外呼业务模板ID |
name |
字符串 |
外呼业务模板名称 |
示例
curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/template/call_out_notes?company_id=1000002&subdomain=demo&pageNum=1&pageSize=10&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 10,
"total": 1
},
"data": [
{
"id": 1,
"name": "测"
}
]
}
分配客户到坐席
该接口用于分配客户到坐席
请求方法
PUT /open_api_v1/outbound_task/distribution
请求参数
参数名 |
必填 |
说明 |
agents |
是 |
待分配坐席ID数组 |
customerTaskIds |
|
待分配客户数组,任务数据ID |
taskId |
否 |
外呼任务ID |
assignOption |
否 |
分配方式,1为平均分配(默认),4为直接分配 |
示例
curl -X PUT \
https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/distribution?company_id=1000002&subdomain=demo&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-H 'content-type: application/json' \
-d '{
"taskId": "988",
"customerTaskIds": [
60673
],
"agentIds": [
573
]
}'
返回结果
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false
}