Help Center> Service Tickets> API Reference> API v2 (Recommended)> Service Ticket Management> Creating a Service Ticket
View PDF

Creating a Service Ticket

Function Description

To create a service ticket.

Debugging

You can debug this API in API Explorer.

URI

POST /v2/servicerequest/cases

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Site

No

Integer

Specifies the site.

The value can be 0 (China site) or 1 (International site). If this parameter is left blank, it is 0 by default.

Minimum value: 0

Maximum value: 1

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

x-phone-verifiedid

No

String

Indicates the mobile phone verification serial number. This parameter is mandatory if a non-registered mobile phone number is used to receive notifications.

Minimum length: 1

Maximum length: 32

x-email-verifiedid

No

String

Indicates the email verification ID. This parameter is mandatory if a non-registered email address is used to receive notifications.

Minimum length: 1

Maximum length: 32
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

incident_sub_type_id

No

String

Specifies the service ticket subcategory.

Minimum length: 0

Maximum length: 32

product_category_id

No

String

Specifies the service ticket product type.

Minimum length: 0

Maximum length: 64

business_type_id

Yes

String

Specifies the service ticket problem type.

Minimum length: 0

Maximum length: 512

region_id

No

String

Specifies the region ID.

Minimum length: 0

Maximum length: 64

simple_description

Yes

String

Description of the problem.

Minimum length: 0

Maximum length: 1200

source_id

Yes

String

Specifies the service ticket source.

Minimum length: 0

Maximum length: 32

is_authorized

No

Integer

Specifies whether it is authorized or not.

Minimum value: 0

Maximum value: 1

authorization_content

No

String

Confidential information.

Minimum length: 0

Maximum length: 400

remind_mobile

No

String

Indicates the notification receiving mobile phone number.

Minimum length: 0

Maximum length: 32

remind_mail

No

String

Indicates the notification receiving email address.

Minimum length: 0

Maximum length: 128

remind_time

No

String

Indicates the time when the notification is sent.

Minimum length: 0

Maximum length: 16

project_id

No

String

ProjectId

Minimum length: 0

Maximum length: 64

accessory_ids

No

Array of strings

Specifies the attachment ID list.

extends_map

No

Map<String,Object>

Specifies additional parameters.

extension_map

No

Map<String,Object>

Specifies extended parameters.

severity_id

No

String

Specifies the severity ID.

Minimum length: 0

Maximum length: 64

verify_code

No

String

Specifies the verification code.

Minimum length: 0

Maximum length: 6

area_code

No

String

Specifies the country/region code.

Minimum length: 0

Maximum length: 32

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

incident_id

String

Specifies the service ticket ID.

Minimum length: 0

Maximum length: 64

Request Example

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

{
  "create_case_req" : {
    "incident_sub_type_id" : "123",
    "product_category_id" : "123",
    "business_type_id" : "123",
    "region_id" : "cn-north-1",
    "simple_description" : "test",
    "source_id" : "123",
    "is_authorized" : 1,
    "authorization_content" : "test",
    "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
  }
}

Response Example

Status code: 200

The service ticket number is returned.

{
  "incident_id" : "123"
}

Status Code

Status Code

Description

200

The service ticket number is returned.

Error Code

See here.