Submitting a Message
Function Description
To submit a message.
URI
POST /v2/servicerequest/cases/{case_id}/message
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
case_id |
Yes |
String |
Specifies the service ticket ID. Minimum length: 0 Maximum length: 64 |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
message |
Yes |
CreateMessageDoV2 object |
Specifies the message content. |
group_id |
No |
String |
Specifies the group ID. Minimum length: 0 Maximum length: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
content |
Yes |
String |
Specifies the message content. Minimum length: 0 Maximum length: 2000 |
is_authorized |
No |
Integer |
Specifies whether it is authorized or not. Minimum value: 0 Maximum value: 1 |
authorization_content |
No |
String |
Specifies the confidential information. Minimum length: 0 Maximum length: 400 |
accessory_ids |
No |
Array of strings |
Specifies the attachment ID. Minimum length: 1 Maximum length: 32 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. Minimum length: 0 Maximum length: 32 |
error_msg |
String |
Description of the error. Minimum length: 0 Maximum length: 32 |
Request Example
POST https://{endpoint}/v2/servicerequest/cases/case-123/message { "group_id" : "123456", "message" : { "content" : "test", "is_authorized" : 1, "authorization_content" : "test", "accessory_ids" : [ ] } }
Response Example
None
Status Codes
Status Code |
Description |
---|---|
200 |
Code 200 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.