列表查询接口_外呼任务列表查询接口
在现代的呼叫中心和客户关系管理（CRM）系统中，外呼任务是核心功能之一，外呼任务列表查询接口为系统管理员或客户服务代表提供了一种方式来查看、管理和监控外呼活动，下面详细描述这个接口的功能、请求参数、响应格式以及一个示例。
功能描述
该接口允许用户查询当前系统中所有激活的外呼任务，通过这个接口，用户可以获取每个外呼任务的详细信息，包括但不限于任务ID、任务名称、目标客户群、预计开始时间、预计结束时间、当前状态等。
请求参数
以下是此接口可能需要的一些请求参数：
api_key: 用于验证请求者身份的安全密钥。
page: 分页参数，指定返回结果的页数。
limit: 每页显示的结果数量。
status: 过滤条件，根据外呼任务的状态进行筛选（待启动、运行中、已完成）。
date_range: 过滤条件，根据日期范围筛选外呼任务（需要两个参数，开始日期和结束日期）。
order_by: 排序参数，指定结果按照哪个字段进行排序（按开始时间或任务ID）。
响应格式
响应通常以JSON格式返回，包含以下信息：
total: 查询到的外呼任务总数。
tasks: 一个数组，包含具体的外呼任务对象。
每个外呼任务对象可能包含以下字段：
| 字段 | 类型 | 描述 |
task_id |
string | 任务的唯一标识符 |
name |
string | 任务的名称 |
target |
array | 目标客户群列表，通常是客户ID的集合 |
start_time |
datetime | 任务的预计开始时间 |
end_time |
datetime | 任务的预计结束时间 |
status |
string | 当前任务的状态（待启动、运行中、已完成等） |
progress |
integer | 任务完成的百分比 |
created_at |
datetime | 任务创建的时间 |
updated_at |
datetime | 任务最后更新的时间 |
示例
请求示例
GET /api/v1/outboundtasks?api_key=YOUR_API_KEY&page=1&limit=10&status=active HTTP/1.1 Host: yourcrm.com
响应示例
{
"total": 50,
"tasks": [
{
"task_id": "12345",
"name": "Finance Product Promotion",
"target": ["cust1001", "cust1002"],
"start_time": "20230301T10:00:00Z",
"end_time": "20230302T10:00:00Z",
"status": "active",
"progress": 70,
"created_at": "20230228T14:35:00Z",
"updated_at": "20230228T14:35:00Z"
},
{
"task_id": "12346",
"name": "Health Insurance Awareness",
"target": ["cust1003", "cust1004"],
"start_time": "20230305T10:00:00Z",
"end_time": "20230306T10:00:00Z",
"status": "pending",
"progress": 0,
"created_at": "20230228T14:36:00Z",
"updated_at": "20230228T14:36:00Z"
}
// ... 更多任务数据
]
}
相关问题与解答
1、问：如果我只想获取处于“运行中”状态的外呼任务，我应该如何构造请求？
答：您应该将status参数设置为“running”。
```http
GET /api/v1/outboundtasks?api_key=YOUR_API_KEY&status=running HTTP/1.1
Host: yourcrm.com
```
这将返回所有标记为“运行中”的外呼任务。
2、问：如何按照任务的开始时间进行降序排序？
答：要实现这一点，您可以添加order_by参数并设置其值为start_time，同时使用order参数设置为desc。
```http
GET /api/v1/outboundtasks?api_key=YOUR_API_KEY&order_by=start_time&order=desc HTTP/1.1
Host: yourcrm.com
```
这将返回一个任务列表，这些任务按照它们的开始时间从最近到最远进行排序。
原创文章，作者：K-seo，如若转载，请注明出处：https://www.kdun.cn/ask/584443.html
微信扫一扫 