文档首页/ 云客服/ API参考/ Case2.0接口参考/ 工单处理接口(V2.0)/ 创建工单
更新时间：2025-03-07 GMT+08:00
查看PDF
分享

创建工单

描述

创建工单机机接口。

接口方法

POST

接口URI

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

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

string

True

消息正文的类型为JSON

2

access-token

string

True

用户访问租间token，access-token获取参见鉴权配置机机接口(SaaS集成)
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

caseInfo

Object

True

工单信息，该对象的参数说明请参见表3

caseInfo列出来的字段只是任意工单都需要的一些标准字段，其他字段是可以根据工单对应的模板动态扩展。
表3 caseInfo参数说明

序号

名称

参数类型

长度（字节）

是否必选

说明

1

title

string

128

True

工单标题

2

description

string

20000

True

工单描述

3

type

string

20

True

工单类型，工单类型id

4

ownerId

string

20

False

工单的责任人，工单自动分配时可以不填写，创建工单接口中根据分配逻辑自动分配责任人

5

isAtuoAssigned

boolean

-

True

是否自动分配

6

priority

string

-

False

优先级，Low/Medium/High/Critical

7

origin

string

-

False

工单来源，Voice/Whatapp/webchat/Email

8

dueDate

DateTime

-

False

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

9

contactId

string

20

True

工单对应的联系人

10

attachment

string

-

False

附件大小不能超过5M，数量不超过5个，支持jpg 、png 、pdf 、jpeg 、gif、doc、docx格式

11

creatorId

string

20

True

创建人

12

contactPhone

string

20

False

联系人电话

13

beId

string

20

False

CRM客户较多，beId用于区分客户大区

如果创建工单涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

响应说明

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

序号

名称

参数类型

是否必选

说明

1

caseId

string

True

工单记录id

消息样例

场景描述：创建工单

URL：https://域名/service/AICC__Case/1.0.0/openapi/case

  • 请求头:
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • 请求体： 
    {
    "caseInfo": {
        "description": "testOpenApi",
        "type": "cvmC0000014Oc9jgT7ZI",
        "origin": "Voice",
        "dueDate": "2023-07-30 00:00:00",
        "isAutoAssigned": true,
        "priority": "Low",
        "title": "test",
        "contactId": "ciIy0000013y7cC8T2rA",
        "state": "Processing",
        "creatorId": "10gg00000148PCjKVDAu",
        "contactPhone": "15151852650"
    }
}
  • 响应头：
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • 响应参数：
{
"resCode": "0",
  "resMsg": "成功",
  "result": {"caseId":"coiO0000014hmYpZIqYq"}
}