更新时间:2024-09-24 GMT+08:00
分享

查询工单详情

描述

按照工单id查询工单详情。

接口方法

GET

接口URI

https://域名/service/AICC__Case/1.0.0/openapi/case/{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

caseInfo

object

True

工单基本信息,该对象的参数说明请参见表4 caseInfo参数说明

2

caseTrace

CaseTrace[]

False

工单轨迹,该对象的参数说明请参见表5 CaseTrace参数说明

3

customerInfo

object

False

工单联系人信息,根据id调用联系人查询接口,参见表6

4

tasks

object[]

False

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

5

isFollower

boolean

True

是否关注

表4 caseInfo参数说明

序号

名称

参数类型

是否必选

说明

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

工单附件

25

creatorName

string

True

创建者名

26

ownerName

string

True

处理者名

表5 CaseTrace参数说明

序号

名称

参数类型

是否必选

说明

1

creatorId

string

True

工单处理者id

2

creatorName

string

True

工单处理者名称

3

type

string

True

处理类型:

dataType : SingleSelect

枚举值:

  • Iternal
  • Email
  • SMS
  • CreateTask
  • Social
  • CreateCase

4

relatedId

string

False

关联记录id

5

title

string

False

标题

6

description

string

False

处理描述

7

from

string

False

发送人id

8

fromName

string

False

发送人姓名

9

toAddress

string

False

接收人地址

10

createdDate

string

False

轨迹处理时间

11

attachment

string

False

轨迹附件

表6 customerInfo参数说明

序号

名称

参数类型

是否必选

说明

1

id

string

True

客户id

2

name

string

False

客户名称

3

nickName

string

False

客户昵称

4

gender

string

False

客户性别

5

firstName

string

False

名字

6

middleName

string

False

中间名

7

lastName

string

False

False

姓氏

8

age

string

False

客户年龄

9

birthDay

string

False

客户出生日期

10

title

string

False

标题

11

status

string

False

状态

12

website

string

False

网站

13

bindAccount

string

False

绑定账户

14

address

string

False

标题

15

phone

string

False

电话

16

cellphone

string

False

手机号

17

channel

string

False

渠道

18

customerName

string

False

客户名称

19

description

string

False

客户说明

20

level

string

False

级别

21

organizationId

string

False

组织信息表id

22

picture

string

False

图片

23

remark

string

False

备注

24

email

string

False

邮箱

25

fax

string

False

传真

26

createdDate

DateTime

True

创建时间

27

lastModifiedDate

DateTime

True

最后修改时间

消息样例

场景描述:查询工单详情

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

  • 请求头:
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • 请求体:
{"id": "c6m800000149ndrHRVNQ"}
  • 响应头:
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • 响应参数:
{"resCode": "0", "resMsg": "成功", "result": [   {     "caseInfo": {       "AICC__IsCanced__CST": false,       "AICC__IsSuspend__CST": false,       "AICC__Origin__CST.name": "Email",       "AICC__Priority__CST.name": "Critical",       "AICC__Reason__CST.name": "",       "AICC__State__CST.name": "Processing",       "AICC__Status__CST.name": "y",       "AICC__Type__CST.__objectType": "AICC__CaseType__CST",       "AICC__Type__CST.name": "",       "AICC__test1__CST": null,       "attachment": "",       "caseNo": "000000000000000000000000035013",       "closedDate": null,       "contactId": "ciIy0000012YLAA4Dulc",       "contactPhone": null,       "createdDate": "2023-06-16 16:25:22",       "creatorId": "10gd000000rDybBRYkuu",       "creatorName": "ServiceCloud",       "description": "test",       "dueDate": "2023-06-30 00:00:00",       "extternalNo": null,       "id": "c6m800000149ndrHRVNQ",       "isUpgraded": false,       "origin": "Email",       "ownerId": "10gg000000sGyLvwHvOK",       "ownerName": "ServiceCloud",       "parentId": null,       "priority": "Critical",       "reason": null,       "state": "Processing",       "status": "y",       "stayDate": null,       "suspendAccumulatedTime": null,       "suspendDate": null,       "title": "test",       "type": "cvmC00000149NzxF1ePA"     },     "caseTrace": [       {         "createdDate": "2023-06-16 16:25:22",         "creatorId": "10gd000000rDybBRYkuu",         "creatorName": "ServiceCloud",         "description": null,         "from": null,         "fromName": null,         "relatedId": null,         "title": null,         "toAddress": null,         "type": "CreateCase"       }     ],     "customerInfo": {       "customerInfo": {         "address": {           "addressLine1": null,           "addressLine2": null,           "addressLine3": null,           "addressLine4": null,           "addressLine5": null,           "addtionalAddress": "test",           "area": null,           "block": null,           "buildingNo": null,           "city": null,           "country": null,           "defaultBillingAddress": false,           "defaultShippingAddress": false,           "firstName": null,           "id": "cw8O0000012YLAA6D6g4",           "label": null,           "lastName": null,           "middleName": null,           "phoneNumber1": null,           "phoneNumber2": null,           "province": null,           "roomNo": null,           "street": null,           "subjectId": "ciIy0000012YLAA4Dulc",           "title": null,           "town": null,           "zip": null         },         "age": null,         "bindAccount": [],         "birthDay": null,         "cellPhone1": "555555",         "cellPhone2": null,         "cellPhone3": null,         "channel": null,         "createdDate": "2023-04-17 18:13:53",         "customFied": null,         "customerName": "test5",         "description": null,         "email": "yh5@huawei.com",         "email1": null,         "email2": null,         "fax": null,         "firstName": null,         "gender": "male",         "id": "ciIy0000012YLAA4Dulc",         "lastModifiedDate": "2023-04-17 18:14:51",         "lastName": null,         "level": null,         "middleName": null,         "name": null,         "nickName": null,         "organization": {           "description": null,           "email": null,           "fax": null,           "fixedPhone": null,           "id": "cBbs0000012YLAA3eiVU",           "industry": null,           "logo": null,           "organizationName": "test",           "scale": null,           "summary": null,           "website": null         },         "organizationId": "cBbs0000012YLAA3eiVU",         "phone": null,         "phone1": null,         "phone2": null,         "phone3": null,         "picture": null,         "remark": null,         "status": null,         "title": null,         "userId": null,         "website": null       }     },     "isFollower": false,     "tasks": []   } ]}

相关文档