更新时间:2022-12-29 GMT+08:00
分享

消息撤回

功能介绍

该接口用于撤回公众号消息。

仅支持文本卡片消息接口,应用卡片消息接口 ,图片消息接口,图文消息接口四个接口的消息撤回。

接口约束

调试

您可以在API Explorer中调试该接口。

URL

POST https://open.welink.huaweicloud.com/api/messages/v1/recall

请求消息

请求头部见表1

表1 请求头部

参数

是否必选

参数类型

描述(值)

x-wlk-Authorization

String

access_token

Content-Type

String

application/json

请求参数见表2

表2 请求参数

请求参数说明:

参数

参数类型

必填

说明

itemId

String

消息ID(来自于发送消息时返回的itemId值)

响应消息

正常返回结果:

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

异常返回结果:

{
    "code": "51111",
    "message": "需要撤回的消息不存在"
}

请求示例

  • 请求参数示例
{
   "itemId":"4856da9c-ba75-4166-bc7c-fbc6c2693948"
}

返回值

返回参数说明:

参数

说明

code

数据正常返回“0”,如果发生错误,会返回对应的错误码。

message

返回信息,包括接口请求发生错误时的详细信息。

错误码

错误码

说明

51100

不支持跨租户操作

51111

需要撤回的消息不存在

51112

没有找到消息所在的公众号

51113

没有找到消息所在的租户

51114

撤回失败, 没有找到该消息接收者

相关文档