Withdraw message - Jiguang Docs

Message withdrawn. v1

API Overview

Functional description

Message withdrawn. API In support of withdrawal, within 24 hours.

Call API After that,UMS The undistributed information in the system will be suspended and the channel will be diverted to withdraw the interface and withdraw it (if access supports)

Call Address

POST https://api.ums.jiguang.cn/v1/retract/{msgid}

Call Authentication

HTTP Header(head) Key/Value Yes:

Authorization: Basic base64_auth_string

of which base64_auth_string The generation algorithm is:base64(ChannelKey:MasterSecret) That's right. ChannelKey Add a colon and add MasterSecret Collapse string. Do it again. base64 Convert.

Request parameters

msgid Only 1 ID value is allowed to be returned after the requested message was successfully sent msgid

> POST https://api.ums.jiguang.cn/v1/retract/v:1t:1603707455p:27133n:2HTTP/1.1> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

          > POST https://api.ums.jiguang.cn/v1/retract/v:1t:1603707455p:27133n:2HTTP/1.1> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

This code block is shown in the floating window

Return parameters

Parameters	Type	Options	Annotations
code	int	Required	Business Return Code, successful as 0
message	string	Required	Business returns details. success, when failure returns to the specific cause of failure

Request or return HTTP code 200

{ "code":0, "message":"success" }

          {
 "code":0,
 "message":"success"
}

This code block is shown in the floating window

Request failed will return HTTP code 400 description

{ "code":1015055, "message":"消息已经被撤回" }

          {
 "code":1015055,
 "message":"消息已经被撤回"
}

This code block is shown in the floating window

Statement of effects of withdrawal

Channel	Support	Statement of effects of withdrawal
AppJPushA cloud.	Yes.	Abort UMS Undistributed information within the system; AbortJPushUnsent Message on Server Undo displayed unclicked messages from the deviceend (need) JPush SDK Version support)
AppJPushPrivate clouds	Yes.	Abort UMS Undistributed information within the system; AbortJPushUnsent Message on Server Undo displayed unclicked messages from the deviceend (need) JPush SDK Version support)
SMS	Yes	Abort only UMS Undispatched messages from the system
Wesson. Official Account	Partial support	Template messages, subscription notifications are not supported, text messages (for future support) support deletion
Wesson. Mini-program	Yes	Abort only UMS Undispatched messages from the system
Mail	Yes	Abort only UMS Undispatched messages from the system
Paying for life.	Partial support	Template message not supported, text message (future support) supported for deletion
Nail.	Yes.	Abort UMS Undistributed information within the system; Retrieve displayed messages from the end of the device
Corporate Wisdom	Yes.	Abort UMS Undistributed information within the system; Retrieve displayed messages from the end of the device

Call Back

Call API Please refer to the return code.Business Return Code