Recalling a Message

Updated on 2025-02-10 GMT+08:00

View PDF

Recall a message.

POST /v2/servicerequest/cases/{case_id}/instant-messages/{message_id}/withdraw

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

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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code. Minimum length: 0 Maximum length: 32
error_msg	String	Specifies the error description. Minimum length: 0 Maximum length: 32

POST https://{endpoint}/v2/servicerequest/cases/case_123/instant-messages/message_123/withdraw

null

None

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

Parent topic: Ticket Message Management

Thank you very much for your feedback. We will continue working to improve the documentation.

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