文档首页/ 云客服/ API参考/ Case2.0接口参考/ 工单任务相关接口(V2.0)/ 查询任务列表
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询任务列表

描述

按照条件查询任务列表，支持按照名称模糊查询、状态过滤、级别、处理人等过滤条件，分页查询默认最大分页100条。

接口方法

POST

接口URI

https://域名/service/AICC__Case/1.0.0/openapi/task/list，例如域名是service.besclouds.com。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

string

True

消息正文的类型为JSON

2

access-token

string

True

用户访问租间token，参见调用鉴权接口
表2 请求体参数

序号

名称

参数类型

长度（字节）

是否必选

说明

1

title

string

128

False

任务名称模糊查询

2

status

string

128

False

任务状态

dataType : SingleSelect

枚举值：

  • Completed
  • Pending
  • Processing

3

priority

string

128

False

优先级

dataType : SingleSelect

枚举值：

  • Critical
  • High
  • Medium
  • Low

4

ownerId

string

20

False

任务的责任人id

5

type

string

-

False

关联类型：

取值：

  • Case

6

relateId

string

20

False

如果关联任务类型有值，这里也必须有值

7

start

number

-

True

起始行数。（min:0）

8

limit

number

-

True

本次查询要求返回的行数（min：1，max:100）

9

classification

string

128

False

任务分类类型 （Todo；Processed；Created）

10

contactId

string

20

False

联系人id

11

creatorId

string

20

True

创建人id

12

startTime

string

-

False

创建开始时间，

格式为YYYY-MM-DD HH:mm:ss

13

endTime

string

-

False

创建结束时间，

格式为YYYY-MM-DD HH:mm:ss

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1

taskList

TaskList[]

True

任务信息，该对象的参数说明请参见表4

2

count

number

True

符合条件的总数
表4 Tasklist参数说明

序号

名称

参数类型

是否必选

说明

1

taskId

string

True

任务id

2

taskNo

string

True

任务No

3

title

string

True

任务标题

4

ownerId

string

True

处理人id

5

priority

string

False

优先级

dataType : SingleSelect

枚举值：

  • Critical
  • High
  • Medium
  • Low

6

dueDate

Datetime

False

期望完成时间，时间格式为YYYY-MM-DD HH:mm:ss

7

status

string

True

任务状态

8

description

string

False

任务描述

9

creatorName

string

True

创建人名

10

ownerName

string

False

处理人名

11

creatorId

string

True

创建人id

消息样例

场景描述：查询任务列表

URL：https://域名/service/AICC__Case/1.0.0/openapi/task/list

  • 请求头:
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • 请求体：
{
 "limit": 1,"start": 0
}
  • 响应头：
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • 响应参数：
{
    "resCode": "0",
    "resMsg": "成功",
    "result": {
        "count": 1,
        "taskList": [
            {
                "closedDate": null,
                "contactId": "ciIy0000013y7cC8T2rA",
                "createdDate": "2023-07-07T06:51:35.000Z",
                "creatorId": "10gg00000148QvgpaLAm",
                "creatorName": "liuhuqiong001",
                "description": "test001",
                "dueDate": "2023-07-08 00:00:00",
                "id": "ccqG0000014iXvGKONQO",
                "ownerId": "10gg00000148QvgpaLAm",
                "ownerName": "liuhuqiong001",
                "priority": "Low",
                "relateId": "c6m80000014iXKHqDw3c",
                "status": "Pending",
                "stayDate": null,
                "taskId": "ccqG0000014iXvGKONQO",
                "taskNo": "000000000000000000000000001002",
                "title": "show0612",
                "type": "Case"
            }
        ]
    }
}

相关文档