Message Recall API

The API layer supports the message recall feature.

Authentication

For details, refer to the Authentication Methods section in the REST API Overview.

DELETE v4/push/withdraw/{msg_id}

Name	Required	Description
msg_id	Y	The `msg_id` returned by the message push

Request Header

DELETE /v4/push/withdraw/1828256757 Authorization: Basic (base64 auth string) Accept: application/json

              
              DELETE /v4/push/withdraw/1828256757
 Authorization: Basic (base64 auth string)
 Accept: application/json

This code block in the floating window

Successful Response

< HTTP/1.1 200 OK < Content-Type: application/json { "request_id": "", "msg_id": "1180003" }

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "request_id": "",
    "msg_id": "1180003"
}

This code block in the floating window

Failure Response

HTTP/1.1 400 BAD REQUEST Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 400 BAD REQUEST
 Content-Type: application/json; charset=utf-8

This code block in the floating window

{ "error": { "code": 21003, "message": "Parameter value is invalid,msg_id not exist" } }

              
              {
    "error": {
        "code": 21003,
        "message": "Parameter value is invalid,msg_id not exist"
    }
}

This code block in the floating window

Code	HTTP	Description	Error Message	Detailed Explanation
None	200	Successful return	nil	Success status code
21003	400	Parameter error	Parameter value is invalid, along with specific error information	Parameter value is invalid, along with specific error information