消息撤回 v1

API 概述

功能说明

消息撤回 API 支持撤回 24 小时内发出的消息

调用 API 后,UMS 将中止系统内未下发的消息,并调通道撤回接口进行撤回(如果通道支持)

调用地址

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

调用验证

HTTP Header(头)里加一个字段( Key/Value 对):

Authorization: Basic base64_auth_string

其中 base64_auth_string 的生成算法为:base64(ChannelKey:MasterSecret)
即,对 ChannelKey 加上冒号,加上 MasterSecret 拼装起来的字符串,再做 base64 转换。

请求参数

msgid 为请求发送消息成功后返回的 ID 值,一次仅允许传 1 个 msgid

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

返回参数

参数 类型 选项 说明
code int 必填 业务返回码,成功为为 0
message string 必填 业务返回详情,成功是为 success,失败时将返回具体的失败原因

请求成功即返回 HTTP code 200

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

请求失败将返回 HTTP code 400 与错误原因

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

撤回效果说明

通道 是否支持 撤回效果说明
App极光推送公有云
  • 中止 UMS 系统内未下发的消息;
  • 中止极光推送服务器中未下发的消息
  • 从设备端撤销已展示但未被点击的消息(需 JPush SDK 版本支持)
App极光推送私有云
  • 中止 UMS 系统内未下发的消息;
  • 中止极光推送服务器中未下发的消息
  • 从设备端撤销已展示但未被点击的消息(需 JPush SDK 版本支持)
短信 仅中止 UMS 系统内未下发的消息
微信公众号 部分支持 模板消息、订阅通知不支持,图文消息(未来支持)支持删除
微信小程序 仅中止 UMS 系统内未下发的消息
邮件 仅中止 UMS 系统内未下发的消息
支付宝生活号 部分支持 模板消息不支持,图文消息(未来支持)支持删除
钉钉
  • 中止 UMS 系统内未下发的消息;
  • 从设备端撤回已展示的消息
企业微信
  • 中止 UMS 系统内未下发的消息;
  • 从设备端撤回已展示的消息

调用返回

调用 API 后的返回码请参考业务返回码


Copyright 2011-2020, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.