Creating a Service Ticket
Function
Create a service ticket.
URI
POST /v2/servicerequest/cases
Request 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-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 | Specifies the serial number ID for verification via a mobile phone. It is mandatory for a non-registered mobile number. Its value can be obtained through the API for querying the verified lists. Minimum length: 1 Maximum length: 32 |
x-email-verifiedid | No | String | Specifies the serial number ID for verification via an email. It is mandatory for a non-registered email address. Its value can be obtained through the API for querying the verified lists. Minimum length: 1 Maximum length: 32 |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
incident_sub_type_id | No | String | Specifies the subtype of a service ticket. Its value can be obtained through the API for querying the service ticket category list. Minimum length: 0 Maximum length: 32 |
product_category_id | No | String | Specifies the product category of a service ticket. Its value can be obtained through the API for querying the service ticket category list. Minimum length: 0 Maximum length: 64 |
business_type_id | Yes | String | Specifies the problem type of a service ticket. Its value can be obtained through the API for querying the problem type list. Minimum length: 0 Maximum length: 512 |
region_id | No | String | Specifies the region ID. It is mandatory if business_type_id is 5. Its value can be obtained through the API for querying the problem type list. Minimum length: 0 Maximum length: 64 |
simple_description | Yes | String | Describes the problem. Minimum length: 0 Maximum length: 1200 |
source_id | Yes | String | Specifies the source of the service ticket. Currently, the value is fixed to 83aeb0f2834c4df49826c781d32a963e. Minimum length: 0 Maximum length: 32 |
remind_mobile | No | String | Specifies the notification receiving mobile phone number. Minimum length: 0 Maximum length: 32 |
remind_mail | No | String | Specifies the notification receiving email address. Minimum length: 0 Maximum length: 128 |
remind_time | No | String | Specifies 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. Its value is returned by the API for uploading attachments. Minimum length: 1 Maximum length: 32 Array length: 0 - 5 |
extends_map | No | Map<String,Object> | Specifies additional parameters. |
extension_map | No | Map<String,Object> | Specifies extended parameters. |
severity_id | No | String | Identifies the problem severity of a service ticket. Its value can be obtained through the API for querying the problem severity list. Minimum length: 0 Maximum length: 64 |
verify_code | No | String | Specifies the verification code. If the contact information is not registered, the value of this parameter needs to be obtained through the API for obtaining verification codes. 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
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
{
"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
} Response Example
Status code: 200
The service ticket number is returned if the operation is successful.
{
"incident_id" : "123"
} Status Codes
Status Code | Description |
|---|---|
200 | The service ticket number is returned if the operation is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.

