消息撤回 API
API 层面支持消息撤回功能。
调用验证
详情参见 REST API 概述的 鉴权方式 说明。
消息撤回
调用地址
DELETE v4/push/withdraw/{msg_id}
调用限制
- 撤回只支持一天内的消息。
- 不支持重复撤回。
请求参数说明
名称 | 是否必选 | 说明 |
---|---|---|
msg_id | Y | 消息推送返回的msg_id |
请求示例
请求报头
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
此代码块在浮窗中显示
返回示例
成功返回
< 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"
}
此代码块在浮窗中显示
失败返回
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
此代码块在浮窗中显示
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
此代码块在浮窗中显示
错误码
Code | HTTP | 描述 | Error Message | 详细解释 |
---|---|---|---|---|
无 | 200 | 正确返回 | nil | 成功状态码 |
21003 | 400 | 参数异常 | Parameter value is invalid,加上具体的错误信息 | Parameter value is invalid,加上具体的错误信息 |