Querying Messages

Updated on 2022-12-12 GMT+08:00

View PDF

Function

Query messages.

URI

GET /v2/servicerequest/cases/{case_id}/messages

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
case_id	Yes	String	Specifies the service ticket ID. Minimum length: 0 Maximum length: 64

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
group_id	No	String	Specifies the group ID. Minimum length: 0 Maximum length: 64
offset	No	Integer	Specifies the query offset. Minimum value: 0 Maximum value: 65535
limit	No	Integer	Specifies the number of records to be queried. Minimum value: 0 Maximum value: 100

Request Parameters

**Table 3** 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-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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Specifies the total number. Minimum value: 0 Maximum value: 65535
message_list	Array of QueryMessageInfoV2 objects	Specifies the list of messages.

**Table 5** QueryMessageInfoV2
Parameter	Type	Description
type	Integer	Specifies the type. It can be deleted. Minimum value: 0 Maximum value: 1
replier_type	Integer	Specifies the replier type. Minimum value: 0 Maximum value: 3
replier	String	Specifies the replier ID. Minimum length: 0 Maximum length: 64
content	String	Specifies the message content. Minimum length: 0 Maximum length: 400
create_time	String	Specifies the creation time.
replier_name	String	Specifies the replier name. Minimum length: 0 Maximum length: 256
is_first_message	Integer	Specifies whether it is the first message. Minimum value: 0 Maximum value: 1
iam_user_type	Integer	Specifies the sub-user type. Minimum value: 0 Maximum value: 3
accessory_list	Array of SimpleAccessoryV2 objects	Specifies the attachment list.

**Table 6** SimpleAccessoryV2
Parameter	Type	Description
accessory_id	String	Specifies the attachment ID. Minimum length: 0 Maximum length: 64
file_actual_name	String	Specifies the actual name of the attachment. Minimum length: 0 Maximum length: 256

Request Example

POST https://{endpoint}/v2/servicerequest/cases/case-123/messages

null

Response Example

Status code: 200

Code 200 is returned.

{
  "count" : 1,
  "message_list" : [ {
    "type" : 0,
    "replier" : "test",
    "content" : "test",
    "create_time" : "2020-07-09 00:00:00",
    "replier_name" : "test",
    "is_first_message" : 1,
    "iam_user_type" : 0,
    "accessory_list" : [ {
      "accessory_id" : "123",
      "file_actual_name" : "test"
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.

Parent topic: Ticket Message Management

Previous topic: Recalling a Message

Next topic: Querying More Messages

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot