外呼任务接口

获取外呼任务详情

该接口用于获取指定id的外呼任务信息

请求方法

GET /callout_tasks/:id

请求参数(URL)

参数名 必填 说明
id 外呼任务id

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
callout_task 对象 外呼任务信息,参见外呼任务数据

示例

curl http://demo.udesk.cn/open_api_v1/callout_tasks/1?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "callout_task": {
        "id": 1,
        "name": "CallOutTask",
        "status": 0,
        "description": "测试",
        "created_at": "2017-03-14T14:12:42.000+08:00",
        "customer_ids": [1, 2, 3, 4],
        "agent_ids": [1, 2],
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "task_type": 1,
        "agent_type": 0,
        "queue_ids": null,
        "customer_count": 4,
        "executed_count": 0,
        "success_count": 0,
        "total_executed_count": 0,
        "total_success_count": 0
    }
}

创建外呼任务

该接口用于获取创建外呼任务

请求方法

POST /callout_tasks

请求参数(Request Body)

参数名 类型 必填 说明
callout_task 对象 外呼任务信息,参见外呼任务数据

返回数据

获取外呼任务详情接口相同。

示例

curl http://demo.udesk.cn/open_api_v1/callout_tasks?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X POST \
-H 'content-type: application/json' \
-d '
{
    "callout_task": {
        "name": "CallOutTask",
        "description": "测试",
        "agent_type": 0,
        "agent_ids": [1, 2],
        "task_type": 1,
        "status": 0,
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "customers": [
            {"type":"token", "content":"123456"},
            {"type":"id","content":107387},
            {"type":"email","content":"wxb1@qq.com"},
            {"type":"cellphone","content":"13500010846"}
        ]
    }
}'

返回

{
    "code": 1000,
    "callout_task": {
        "id": 1,
        "name": "CallOutTask",
        "status": 0,
        "description": "测试",
        "created_at": "2017-03-14T14:12:42.000+08:00",
        "customer_ids": [1, 2, 3, 4],
        "agent_ids": [1, 2],
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "task_type": 1,
        "agent_type": 0,
        "queue_ids": null,
        "customer_count": 4,
        "executed_count": 0,
        "success_count": 0,
        "total_executed_count": 0,
        "total_success_count": 0
    }
}

更新外呼任务

该接口用于修改创建外呼任务

请求方法

PUT /callout_tasks/:id

请求参数(URL)

参数名 必填 说明
id 外呼任务id

请求参数(Request Body)

参数名 类型 必填 说明
callout_task 对象 外呼任务信息,参见外呼任务数据

返回数据

获取外呼任务详情接口相同。

示例

curl http://demo.udesk.cn/open_api_v1/callout_tasks/1?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X PUT \
-H 'content-type: application/json' \
-d '
{
    "callout_task": {
        "name": "CallOutTask",
        "description": "测试",
        "status": 0,
        "start_at": "2015-01-01",
        "end_at": "2015-01-31",
        "customers": [
            {"type":"token", "content":"123456"},
            {"type":"id","content":107387},
            {"type":"email","content":"wxb1@qq.com"},
            {"type":"cellphone","content":"13500010846"}
        ]
    }
}'

返回

{
    "code": 1000,
    "callout_task": {
        "id": 1,
        "name": "CallOutTask",
        "status": 0,
        "description": "测试",
        "created_at": "2017-03-14T14:12:42.000+08:00",
        "customer_ids": [1, 2, 3, 4],
        "agent_ids": [1, 2],
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "task_type": 1,
        "agent_type": 0,
        "queue_ids": null,
        "customer_count": 4,
        "executed_count": 0,
        "success_count": 0,
        "total_executed_count": 0,
        "total_success_count": 0
    }
}

删除外呼任务

该接口用于删除指定id的外呼任务

请求方法

DELETE /callout_tasks/:id

请求参数(URL)

参数名 必填 说明
id 外呼任务id

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
id 整型 被删除的外呼任务id

示例

curl http://demo.udesk.cn/open_api_v1/callout_tasks/1?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X DELETE

返回

{
    "code": 1000,
    "id": 1
}

获取外呼任务客户列表

该接口用于获取指定id外呼任务的客户信息

请求方法

GET /callout_tasks/customers

请求参数(Query String)

参数名 必填 说明
id 外呼任务id
page 页码,从1开始,默认为1
per_page 每页数量,默认10,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
customers 数组 客户列表

customers元素的数据结构

属性名 类型 说明
task_id 整型 外呼任务id
id 整型 客户id
nick_name 字符串 客户姓名
cellphones 数组 客户手机列表
agent_id 整型 客服id
call_count 整型 通话数量
result 字符串 通话结果

cellphones元素的结构

属性名 类型 说明
id 整型 唯一标识
content 字符串 电话内容

示例

curl http://demo.udesk.cn/open_api_v1/callout_tasks/customers?id=1&page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "customers": [
        {
            "task_id": 1,
            "id": 1,
            "nick_name": "测试客户",
            "cellphones": [
                {
                    "id": 1,
                    "content": "13000000001"
                }
            ],
            "agent_id": 1,
            "call_count": 0,
            "result": null
        },
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}

获取外呼任务客服列表

该接口用于获取指定id外呼任务的客服信息

请求方法

GET /callout_tasks/agents

请求参数(Query String)

参数名 必填 说明
id 外呼任务id
page 页码,从1开始,默认为1
per_page 每页数量,默认10,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
agents 数组 客服列表

agents元素的数据结构

属性名 类型 说明
id 整型 客服id
name 字符串 客服姓名
customer_count 整型 客户数量
executed_count 整型 执行数量
total_success_count 整型 成功数量
total_executed_count 整型 总执行数量

示例

curl http://demo.udesk.cn/open_api_v1/callout_tasks/agents?id=1&page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "agents": [
        {
            "id": 1,
            "name": "测试客服",
            "customer_count": 1,
            "executed_count": 0,
            "success_count": 0,
            "total_executed_count": 0,
            "total_success_count": 0
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}

数据结构-外呼任务

属性名 类型 可编辑 说明
id 整型 唯一标识
name 字符串 名称
description 字符串 描述
start_at 日期时间 开始时间
end_at 结束时间 结束时间
created_at 日期时间 创建时间
status 整型 状态,0为暂停,1为开启
task_type 整型 任务类型,固定传1
agent_type 整型 是(新建) 坐席,0为全部客服,1为队列,2为自定义
queue_ids 数组 队列ID数组
customers 数组 客户标识数组,标识可以是 id、token、电话或者邮箱,只用于编辑和新建
customer_ids 数组 客户ID数组
agent_ids 数组 是(新建) 客服ID数组
customer_count 整型 客户数量
executed_count 整型 接通数量
success_count 整型 成功数量
total_executed_count 整型 总执行数量
total_success_count 整型 总接通数量

customers元素的结构

属性名 类型 说明
type 字符串 查找条件类型,可以是“id”、“token”、“email”或“cellphone”
content 字符串 查找条件内容