更新时间:2023-11-13 GMT+08:00
分享

查询任务详情

描述

按照任务id查询任务详情。

接口方法

POST

接口URI

https://域名/service/AICC__Case/1.0.0/openapi/task/{id},例如域名是service.besclouds.com。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

string

True

消息正文的类型为JSON

2

access-token

string

True

用户访问租间token,参见调用鉴权接口

表2 请求体参数

序号

名称

参数类型

长度(字节)

是否必选

说明

1

id

string

20

True

任务id

响应说明

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

序号

名称

参数类型

是否必选

说明

1

taskInfo

TaskInfo

True

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

2

taskTrace

CaseTrace[]

False

任务轨迹,该对象的参数说明请参见表5

3

customerInfo

Object

False

联系人信息,该对象的参数说明请参见表6

4

caseInfos

Case

False

关联工单信息,该对象的参数说明请参见表6

表4 TaskInfo参数说明

序号

名称

参数类型

是否必选

说明

1

title

string

True

任务标题

2

description

string

False

任务描述

3

type

string

False

任务关联类型

4

relateId

string

False

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

5

ownerId

string

True

处理人id

6

contactId

string

False

联系人id

7

priority

string

False

优先级

8

dueDate

Datetime

False

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

9

creatorId

string

True

创建人

10

creatorName

string

True

创建人姓名

11

createdDate

Datetime

True

创建时间,时间格式为YYYY-MM-DD HH:mm:ss

12

closedDate

Datetime

False

关闭时间,时间格式为YYYY-MM-DD HH:mm:ss

13

stayDate

Datetime

False

停留时间,时间格式为YYYY-MM-DD HH:mm:ss

14

taskNo

string

False

任务编码

15

ownerName

string

False

处理人名

16

id

string

False

任务id

17

status

string

False

任务状态

18

attachment

string

False

任务附件

表5 CaseTrace参数说明

序号

名称

参数类型

是否必选

说明

1

creatorId

string

True

工单处理者id

2

creatorName

string

True

工单处理者名称

3

type

string

True

处理类型: CreateTask、StatusUpdate

4

relatedId

string

False

关联记录id

5

title

string

False

标题

6

description

string

False

处理描述

表6 Case参数说明

序号

名称

参数类型

是否必选

说明

1

id

string

True

工单id

2

caseNo

string

True

工单编号

3

status

string

True

工单当前流程节点

dataType : SingleSelect

枚举值:

0.Completed(默认值)

其他值业务自定义

4

title

string

False

工单标题

5

priority

string

False

优先级

dataType : SingleSelect

枚举值:

  • Critical
  • High
  • Medium
  • Low

6

parentId

string

False

父工单id

7

ownerId

string

True

处理人id

8

origin

string

True

优先级

dataType : SingleSelect

枚举值:

  • Voice
  • Whatsapp
  • webchat
  • Email

9

isUpgraded

Boolean

True

工单是否升级

10

extternalNo

string

True

外部工单编号

11

dueDate

Datetime

False

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

12

description

string

True

工单描述

13

creatorId

string

True

工单处理者id

14

createdDate

Datetime

True

创建时间,时间格式为YYYY-MM-DD HH:mm:ss

15

contactId

string

False

联系人id

16

reason

string

True

工单原因分类

17

contactPhone

string

False

联系人电话

18

state

string

True

任务状态

dataType : SingleSelect

枚举值:

  • Completed
  • Pending
  • Processing

19

stayDate

string

True

工单当前状态停留时间,时间格式为YYYY-MM-DD HH:mm:ss

20

suspendAccumulatedTime

int

True

工单停留时长,单位分钟,范围1~1439999

21

suspendDate

string

True

工单暂停时间,时间格式为YYYY-MM-DD HH:mm:ss

22

type

string

True

工单类型id,关联CaseType表

23

closedDate

Datetime

False

关闭时间

24

attachment

string

False

工单附件

消息样例

场景描述:查询任务详情

URL:https://域名/service/AICC__Case/1.0.0/openapi/task/{id}

  • 请求头:
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • 请求体:
{
   "id":"ccqG00000138H6u8bTwe"
}
  • 响应头:
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • 响应参数:
    {
        "resCode": "0",
        "resMsg": "成功",
        "result": {
            "caseInfos": [
                {
                    "attachment": "",
                    "caseNo": "000000000000000000000000000006",
                    "closedDate": null,
                    "contactId": "ciIy0000013y7cC8T2rA",
                    "contactPhone": null,
                    "createdDate": "2023-07-07 14:43:15",
                    "creatorId": "10gg00000148QvgpaLAm",
                    "description": "0704test",
                    "dueDate": "2023-07-22 00:00:00",
                    "extternalNo": null,
                    "id": "c6m80000014iXKHqDw3c",
                    "isUpgraded": false,
                    "origin": "Voice",
                    "ownerId": "10gg00000148QvgpaLAm",
                    "parentId": null,
                    "priority": "Low",
                    "reason": null,
                    "state": "Processing",
                    "status": "tttttt",
                    "stayDate": null,
                    "suspendAccumulatedTime": null,
                    "suspendDate": null,
                    "title": "0704test",
                    "type": "cvmC0000014ddysLTCZk"
                }
            ],
            "customerInfo": {
                "customerInfo": {
                    "address": {
                        "addressLine1": null,
                        "addressLine2": null,
                        "addressLine3": null,
                        "addressLine4": null,
                        "addressLine5": null,
                        "addtionalAddress": null,
                        "area": null,
                        "block": null,
                        "buildingNo": null,
                        "city": null,
                        "country": null,
                        "defaultBillingAddress": false,
                        "defaultShippingAddress": false,
                        "firstName": null,
                        "id": "cw8O0000013y7cCDIE4G",
                        "label": null,
                        "lastName": null,
                        "middleName": null,
                        "phoneNumber1": null,
                        "phoneNumber2": null,
                        "province": null,
                        "roomNo": null,
                        "street": null,
                        "subjectId": "ciIy0000013y7cC8T2rA",
                        "title": null,
                        "town": null,
                        "zip": null
                    },
                    "age": null,
                    "bindAccount": [],
                    "birthDay": null,
                    "cellPhone1": "15005167393",
                    "cellPhone2": null,
                    "cellPhone3": null,
                    "channel": null,
                    "createdDate": "2023-06-09 15:33:35",
                    "customFied": null,
                    "customerName": "客户1",
                    "description": null,
                    "email": "customer@huawei.com",
                    "email1": null,
                    "email2": null,
                    "fax": null,
                    "firstName": null,
                    "gender": null,
                    "id": "ciIy0000013y7cC8T2rA",
                    "lastModifiedDate": "2023-06-09 15:33:35",
                    "lastName": null,
                    "level": null,
                    "middleName": null,
                    "name": null,
                    "nickName": null,
                    "organization": {
                        "description": null,
                        "email": null,
                        "fax": null,
                        "fixedPhone": null,
                        "id": "cBbs0000013y7cBnkKMS",
                        "industry": null,
                        "logo": null,
                        "organizationName": "公司",
                        "scale": null,
                        "summary": null,
                        "website": null
                    },
                    "organizationId": "cBbs0000013y7cBnkKMS",
                    "phone": null,
                    "phone1": null,
                    "phone2": null,
                    "phone3": null,
                    "picture": null,
                    "remark": null,
                    "status": null,
                    "title": null,
                    "website": null
                }
            },
            "taskInfo": {
                "attachment": "",
                "closedDate": null,
                "contactId": "ciIy0000013y7cC8T2rA",
                "createdDate": "2023-07-07 14:51:35",
                "creatorId": "10gg00000148QvgpaLAm",
                "creatorName": "10gg00000148QvgpaLAm",
                "description": "test001",
                "dueDate": "2023-07-08 00:00:00",
                "id": "ccqG0000014iXvGKONQO",
                "ownerId": "10gg00000148QvgpaLAm",
                "ownerName": "liuhuqiong001",
                "priority": "Low",
                "relateId": "c6m80000014iXKHqDw3c",
                "status": "Pending",
                "stayDate": null,
                "taskNo": "000000000000000000000000001002",
                "title": "test002",
                "type": "Case"
            },
            "taskTrace": [
                {
                    "creatorId": "10gg00000148QvgpaLAm",
                    "creatorName": "10gg00000148QvgpaLAm",
                    "description": null,
                    "relatedId": null,
                    "title": null,
                    "type": "CreateTask"
                }
            ]
        }
    }
分享:

    相关文档

    相关产品