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

Recalling a Message

Function

Recall a message.

URI

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

Request Parameters

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

Response Parameters

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

Example Request

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

null

Example Response

None

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.