更新时间:2023-12-18 GMT+08:00

创建工单

功能介绍

创建工单

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/servicerequest/cases

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:5000

X-Language

String

语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。

会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。

最小长度:1

最大长度:32

X-Time-Zone

String

环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。

涉及时间的数据会根据环境时区处理。

最小长度:1

最大长度:32

x-phone-verifiedid

String

手机验证序列号id,如果选择非注册手机号提醒,如果是非注册联系方式则必填,通过"查询已验证的列表"接口查询获取

最小长度:1

最大长度:32

x-email-verifiedid

String

邮件验证序列号id,如果选择非注册邮箱提醒,如果是非注册联系方式则必填,通过"查询已验证的列表"接口查询获取

最小长度:1

最大长度:32

表2 请求Body参数

参数

是否必选

参数类型

描述

incident_sub_type_id

String

工单子类,通过"查询工单类目列表"接口获取

最小长度:0

最大长度:32

product_category_id

String

工单产品类型,通过"查询工单类目列表"接口获取

最小长度:0

最大长度:64

business_type_id

String

工单问题类型,通过"查询问题类型列表"接口获取

最小长度:0

最大长度:512

region_id

String

区域ID,根据business_type_id对应工单类型是5则必填,通过"查询问题类型列表"查看

最小长度:0

最大长度:64

simple_description

String

问题描述

最小长度:0

最大长度:1200

source_id

String

工单来源,当前固定为83aeb0f2834c4df49826c781d32a963e

最小长度:0

最大长度:32

remind_mobile

String

提醒手机号

最小长度:0

最大长度:32

remind_mail

String

提醒邮箱

最小长度:0

最大长度:128

remind_time

String

提醒时间

最小长度:0

最大长度:16

project_id

String

ProjectId

最小长度:0

最大长度:64

accessory_ids

Array of strings

附件id列表,"上传附件"接口返回的id

最小长度:1

最大长度:32

数组长度:0 - 5

extends_map

Map<String,Object>

附加参数

extension_map

Map<String,Object>

扩展参数

severity_id

String

严重性id,通过"查询问题严重性列表"接口获取

最小长度:0

最大长度:64

verify_code

String

验证码,如果是非注册联系方式,需要通过"获取验证码"获取验证码

最小长度:0

最大长度:6

area_code

String

国家码

最小长度:0

最大长度:32

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

incident_id

String

工单id

最小长度:0

最大长度:64

请求示例

POST https://{endpoint}/v2/servicerequest/cases

{
  "incident_sub_type_id" : "123",
  "product_category_id" : "123",
  "business_type_id" : "123",
  "region_id" : "cn-north-1",
  "simple_description" : "test",
  "source_id" : "123",
  "remind_mobile" : null,
  "remind_mail" : null,
  "remind_time" : "9:00-18:00",
  "project_id" : null,
  "accessory_ids" : [ ],
  "extends_map" : [ ],
  "extension_map" : [ ],
  "severity_id" : "123",
  "verify_code" : null,
  "area_code" : 86
}

响应示例

状态码: 200

成功返回工单号

{
  "incident_id" : "123"
}

状态码

状态码

描述

200

成功返回工单号

错误码

请参见错误码