创建自动外呼任务
该接口用于创建自动外呼任务
请求方法
POST /cc_ad_tasks
请求参数
| 参数名 |
类型 |
必填 |
说明 |
| name |
字符串 |
是 |
外呼任务名称 |
| description |
字符串 |
否 |
外呼任务描述 |
| task_type |
整型 |
是 |
外呼任务类型，参见任务类型说明 |
| user_group_id |
整型 |
是 |
外呼任务客服组id |
| force_policy_id |
整型 |
否 |
路由策略ID，决定该电话使用那个智能路由。 默认路由 |
| priority |
整型 |
否 |
优先级 (1-100) 默认10 |
| working_time_id |
整型 |
否 |
任务执行时间段工作时间ID |
| recall_policy |
字符串 |
否 |
发起重呼的通话结果的类型列表，参见数据结构-通话结果类型列表 |
| recall_count |
整型 |
否 |
重呼次数 默认0 |
| recall_interval |
字符串 |
否 |
重呼间隔 格式 "1,2,3" 第1次60秒 第2次120秒 第3次180秒 默认600秒 |
| follow_on_policy |
字符串 |
否 |
发起续播的通话结果类型，参见数据结构-通话结果类型列表 |
| callout_number |
字符串 |
否 |
中继号（外呼显号）号码 |
| call_limit |
字符串 |
否 |
任务并发数，取值不能超过callout_number所限定的任务并发数 |
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
| id |
整型 |
外呼任务ID |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks?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": "外呼任务",
"description": "这是外呼任务",
"task_type": 1,
"user_group_id": 100,
"force_policy_id": 1,
"priority": 10,
"working_time_id": 1,
"recall_policy": "customer_missed",
"recall_count": 6,
"recall_interval": "1,2,3,4,5,6",
"follow_on_policy": "customer_missed",
"callout_number": "021002002020",
"call_limit": "10"
}'
返回
{
"code": 1000,
"id": 1
}
更新自动外呼任务
该接口用于更新自动外呼任务名称和描述
请求方法
PUT /cc_ad_tasks/:id
请求参数
| 参数名 |
必填 |
说明 |
| name |
是 |
外呼任务名称 |
| description |
否 |
外呼任务描述 |
| callout_number |
否 |
中继号（外呼显号）号码 |
| call_limit |
否 |
任务并发数 |
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/1?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": "外呼任务修改",
"description": "这是要修改外呼任务",
"callout_number": "021002002020",
"call_limit": "10"
}'
返回
{
"code": 1000,
}
获取自动外呼任务列表
该接口用于获取自动外呼任务列表
请求方法
GET /cc_ad_tasks
请求参数
| 参数名 |
必填 |
类型 |
说明 |
限制 |
| page |
否 |
整型 |
页码，从1开始，默认为1 |
|
| per_page |
否 |
整型 |
每页数量，默认10，最大100 |
|
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
| cc_ad_tasks |
数组 |
外呼任务信息，参见数据结构-自动外呼任务 |
| meta |
对象 |
分页信息，详见通用数据 |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks?page=1&per_page=10&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"code": "1000",
"cc_ad_tasks": [
{
"id": 1,
"name": "自动外呼",
"description": "自动外呼任务描述",
"task_type": 2,
"user_group_id": 100,
"customer_count": 100000,
"callout_number": "057126200039",
"created_at": "2017-10-21 11:22:33",
"status": 1,
"execute_customer_count": 100000,
"customer_answer_count": 100000,
"agent_answer_count": 100000,
"call_success_rate": "1.0",
"agent_answer_rate": "1.0",
"agent_use_rate": "1.0",
"disturb_rate": "0.0",
"minute_call_rate": "1.0",
"minute_agent_use_rate": "1.0",
"minute_disturb_rate": "0.0"
}
],
"meta": {
"current_page": 1,
"total_pages":1,
"total_entries": 1
}
}
获取自动外呼任务详情
该接口用于查询单条外呼任务详情
请求方法
GET /cc_ad_tasks/:id
请求参数
无
返回结果
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/1?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"code": 1000,
"item": {
"id": 16,
"name": "等待外呼",
"status": 2,
"call_limit": 10,
"callout_number": "05712620039",
"task_type": 1,
"force_policy_id": 45,
"user_group_id": 323,
"description": null,
"created_at": "2017-11-02T20:13:40.000+08:00",
"schedule_id": null,
"redial_times": 0,
"redial_guide": ["1", "1"],
"redial_scene": ["phone_busy", "phone_outline"],
"redial_multi_scene": ["phone_busy"],
"priority": 10,
"force_policy_name": "自动外呼",
"schedule_name": null,
"customer_count": 2,
"execute_customer_count": 6,
"customer_answer_count": 0,
"agent_answer_count": 0,
"call_success_rate": "0.0",
"agent_answer_rate": "0",
"agent_use_rate": "0.0",
"disturb_rate": "0",
"minute_call_rate": "1.0",
"minute_agent_use_rate": "0.0",
"minute_disturb_rate": "0.0"
}
}
为自动外呼任务导入号码
该接口用于为指定的自动外呼任务添加号码，每次最多导入 300 条，调用频率不得超过 1 次/秒
请求方法
POST /cc_ad_tasks/add_numbers
Content Type
application/json
请求参数
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
| successful_count |
整型 |
成功导入的号码数量 |
| unsuccessful_count |
整型 |
导入失败的号码数量 |
| unsuccessful_numbers |
数组 |
导入失败的号码列表，结构详见数据结构-导入失败的号码结构 |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/add_numbers?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 '
{
"id": 1,
"numbers": [
{"cellphone": "13223004567", "name": "测试号码1", "description": "号码描述信息1"},
{"cellphone": "13223004568", "name": "测试号码2", "description": "号码描述信息2"},
{"cellphone": "13223004569", "name": "测试号码3", "description": "号码描述信息3",
"custom": {"公司": "Udesk", "地址": "北京市"}
}
]
}'
如果有3条记录均导入成功，则返回
{
"code": 1000,
"successful_count": 3,
"unsuccessful_count": 0,
"unsuccessful_numbers": []
}
注意事项
- 自动外呼任务只有在关闭状态下才允许添加号码
- 请注意号码池的限额：每次API导入最多允许添加300个号码，每个自动外呼任务最多允许100万个号码，每个公司最多允许1000万个号码
- 添加号码API 调用频率不超过1次/秒
获取自动外呼任务的号码池
该接口用于返回指定的自动外呼任务的号码池列表，每次最多返回500条记录
请求方法
GET /cc_ad_tasks/numbers
请求参数
| 参数名 |
必填 |
类型 |
说明 |
| id |
是 |
整型 |
自动外呼任务id |
| start_number_id |
否 |
整型 |
起始的号码池号码ID，默认为0，注：只返回号码ID大于此值的号码池 |
返回结果
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/numbers?id=12292&start_number_id=2&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返回
{
"code": 1000,
"numbers": [
{
"id": 3,
"name": "测试号码3",
"cellphone": "13989001200",
"description": "号码3的描述",
"call_count": 0,
"customer_answer_count": 0,
"agent_answer_count": 0
},
{
"id": 14,
"name": "测试号码14",
"cellphone": "13989001201",
"description": "号码14的描述",
"call_count": 0,
"customer_answer_count": 0,
"agent_answer_count": 0
}
],
"meta": {
"record_size": 2,
"max_number_id": 14
}
}
自动外呼任务号码重播
请求方法
POST /cc_ad_tasks/recall
请求参数
| 参数名 |
必填 |
类型 |
说明 |
| id |
是 |
整型 |
外呼任务ID |
| number |
是 |
字符串 |
重播的电话号码 |
| after_at |
是 |
字符串 |
重播的开始时间 格式 YYYY-MM-DDTHH:MM:SSZ |
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
| message |
字符串 |
执行结果说明 |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/recall?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 '
{
"id":1,
"number":"13412341234",
"after_at":"2019-02-08T15:30:02+08:00"
}'
返回
{
"code": 1000,
"message": "重播成功"
}
自动外呼任务号码续播
请求方法
POST /cc_ad_tasks/follow_on
请求参数
| 参数名 |
必填 |
类型 |
说明 |
| id |
是 |
整型 |
外呼任务ID |
| called |
是 |
字符串 |
已经拨打的电话号码 |
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
| message |
字符串 |
执行结果说明 |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/follow_on?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 '
{
"id": 1,
"called": "13223004570"
}'
返回
{
"code": 1000,
"message": "续播成功"
}
自动外呼任务启动/关闭
请求方法
POST /cc_ad_tasks/:id/open
请求参数
| 参数名 |
必填 |
类型 |
说明 |
| open |
是 |
布尔型 |
true/false |
| callout_number |
否 |
字符串 |
中继号码 |
返回结果
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，1000代表成功 |
| message |
字符串 |
执行结果说明 |
示例
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/1/open?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 '
{
"open": true/false,
"callout_number": "01086465047"
}'
返回
{
"code": 1000
}
数据结构-自动外呼任务
| 属性 |
说明 |
示例 |
类型 |
| id |
任务id |
1 |
整型 |
| name |
任务名称 |
'自动外呼' |
字符串 |
| description |
任务描述 |
'这是自动外呼任务' |
字符串 |
| task_type |
任务类型 |
1 |
整型 |
| callout_number |
外呼号码 |
"01086465047" |
字符串 |
| user_group_id |
客服组id |
100 |
整型 |
| customer_count |
客户数量 |
100000 |
整型 |
| created_at |
创建时间 |
'2017-11-22 10:32:33' |
日期时间 |
| status |
状态 |
1 |
整型 |
| execute_customer_count |
执行数量 |
100000 |
整型 |
| customer_answer_count |
客户接听数 |
100000 |
整型 |
| agent_answer_count |
客服接听数 |
100000 |
整型 |
| call_success_rate |
外呼成功率 |
'0.67' |
字符串 |
| agent_answer_rate |
坐席接听率 |
'0.32' |
字符串 |
| disturb_rate |
骚扰率 |
'0.0' |
字符串 |
| agent_use_rate |
坐席使用率 |
'1.0' |
字符串 |
| minute_call_rate |
10分钟接通率 |
'1.0' |
字符串 |
| minute_agent_use_rate |
10分钟骚扰率 |
'1.0' |
字符串 |
| minute_disturb_rate |
10分钟坐席使用率 |
'1.0' |
字符串 |
任务类型说明(task_type)
| 取值 |
中文名称 |
| 1 |
精准外呼 |
| 2 |
比例外呼 |
| 3 |
预测外呼 |
| 4 |
简单IVR(语音播报，不入队) |
状态说明(status)
数据结构-导入自动外呼号码的结构
| 属性 |
类型 |
说明 |
必填 |
| cellphone |
字符串 |
电话号,支持多号码使用逗号分隔 |
是 |
| name |
字符串 |
姓名 |
否 |
| description |
字符串 |
描述 |
否 |
| custom |
对象 |
自定义数据,结构详见数据结构-导入自动外呼号码的自定义数据 |
否 |
数据结构-导入失败的号码结构
| 属性 |
类型 |
说明 |
| cellphone |
字符串 |
电话号 |
| name |
字符串 |
姓名 |
| description |
字符串 |
描述 |
| custom |
对象 |
自定义数据 |
| reason |
字符串 |
失败原因 |
数据结构-号码池结构
| 属性 |
类型 |
说明 |
| id |
整型 |
号码ID |
| name |
字符串 |
姓名 |
| cellphone |
字符串 |
电话号 |
| description |
字符串 |
描述 |
| call_count |
整型 |
呼叫次数 |
| customer_answer_count |
整型 |
客户接听次数 |
| agent_answer_count |
整型 |
客服接听次数 |
数据结构-号码池额外信息
| 属性 |
类型 |
说明 |
| record_size |
整型 |
本次请求返回的号码数量 |
| max_number_id |
整型 |
本次请求返回的最大号码ID(当 record_size 为0时，该值为 null)，可作为下次请求的start_number_id |
数据结构-导入自动外呼号码的自定义数据
自定义字段的数量不能超过10个
| 属性 |
类型 |
说明 |
必填 |
| 字段1 |
字符串 |
字段名称可以自定义 |
是 |
| 字段2 |
字符串 |
字段名称可以自定义 |
否 |
| 字段3 |
字符串 |
字段名称可以自定义 |
否 |
| .... |
字符串 |
字段名称可以自定义 |
否 |
| 字段10 |
字符串 |
字段名称可以自定义 |
否 |
数据结构-通话结果类型列表
| 取值 |
中文名称 |
| customer_missed |
客户未接 |
| agent_missed |
客服未接 |
| customer_breakout |
客户速挂 |
| phone_outline |
话机离线 |
| phone_busy |
话机占线 |
数据结构-自动外呼任务详情
| 属性 |
说明 |
示例 |
类型 |
| id |
任务id |
1 |
整型 |
| name |
任务名称 |
'自动外呼' |
字符串 |
| status |
状态 |
1 |
整型 |
| call_limit |
并发限制 |
1 |
整型 |
| callout_number |
外呼号码 |
"01086465047" |
字符串 |
| task_type |
任务类型 |
1 |
整型 |
| force_policy_id |
路由策略ID |
1 |
整型 |
| user_group_id |
客服组ID |
100 |
整型 |
| description |
任务描述 |
'这是自动外呼任务' |
字符串 |
| created_at |
创建时间 |
'2017-11-22 10:32:33' |
日期时间 |
| schedule_id |
工作时间ID |
1 |
整型 |
| redial_times |
重呼次数 |
0 |
整型 |
| redial_guide |
重呼间隔 |
["1", "1"] |
数组 |
| redial_scene |
重呼策略 |
["phone_busy", "phone_outline"] |
数组 |
| redial_multi_scene |
续播策略 |
["phone_busy"] |
数组 |
| priority |
优先级 |
10 |
整型 |
| force_policy_name |
路由策略名称 |
"自动外呼" |
字符串 |
| schedule_name |
工作时间名称 |
"工作时间" |
字符串 |
| customer_count |
客户数量 |
100000 |
整型 |
| execute_customer_count |
执行数量 |
100000 |
整型 |
| customer_answer_count |
客户接听数 |
100000 |
整型 |
| agent_answer_count |
客服接听数 |
100000 |
整型 |
| call_success_rate |
外呼成功率 |
'0.67' |
字符串 |
| agent_answer_rate |
坐席接听率 |
'0.32' |
字符串 |
| disturb_rate |
骚扰率 |
'0.0' |
字符串 |
| agent_use_rate |
坐席使用率 |
'1.0' |
字符串 |
| minute_call_rate |
10分钟接通率 |
'1.0' |
字符串 |
| minute_agent_use_rate |
10分钟骚扰率 |
'1.0' |
字符串 |
| minute_disturb_rate |
10分钟坐席使用率 |
'1.0' |
字符串 |
code错误码说明
| 错误码 |
message信息 |
exception:message信息 |
描述 |
| 2000 |
未知错误 |
unknown attribute: working_time_id |
参数{working_time_id}值为空 |
|
|
undefined method `size' for nil:NilClass |
必填参数{numbers}未导入或为空值 |
| 2005 |
没有找到该资源 |
Couldn't find CcAdTask with id=12 [WHERE cc_ad_tasks.company_id = ?] |
参数{id}错误，未匹配到值 |
|
|
Couldn't find CcAdTask without an ID |
参数{id}错误，未匹配到值 |
| 206203 |
参数task_type不合法 |
略 |
必填参数{task_type}未填写或值在取值范围外 |
| 206204 |
参数user_group_id不合法 |
略 |
必填参数{user_group_id}未填写或值在取值范围外 |
| 206205 |
参数name不合法 |
略 |
必填参数{name}未填写或值在取值范围外 |
| 206206 |
参数force_policy_id不合法 |
略 |
参数{force_policy_id}的值在取值范围外 |
| 206207 |
参数working_time_id不合法 |
略 |
参数{force_policy_id}的值在取值范围外 |
| 501004 |
启动的外呼任务，不可以导入号码 |
略 |
此自动外呼任务处于启动状态中 |
| 501015 |
参数open不能为空，且必须是true/false |
略 |
参数{open}的值不是取值范围内的true或false |
| 501016 |
该任务正在关闭中，无须重复关闭 |
略 |
该自动外呼任务已处于关闭状态 |
| 501032 |
号码非法 |
略 |
必填参数{number}未填写或为取值范围外的值 |
| 501033 |
重播开始时间格式不对 |
略 |
必填参数{after_at}未填写或格式错误 |
| 501035 |
自动外呼任务开启中,无须重复开启 |
略 |
该自动外呼任务已处于开启状态 |
| 503001 |
不是当前公司的合法中继号 |
略 |
参数{callout_number}的值错误，不在取值范围内 |
| 503002 |
不符合目前外呼显号的并发限制数 |
略 |
参数{call_limit}的值超过参数{callout_number}对应的中继号的并发上限 |