跳转到主要内容
调用本接口,撤回工作通知消息,适用于企业内部应用需要撤回误发的工作通知场景。

接口调用说明

调用本接口,只能撤回24小时内发送的工作通知消息。

权限

服务端API是以应用维度授权的,在创建应用时,系统已默认添加了消息通知权限。
应用类型是否支持调用权限申请方式API Explorer 调试
企业内部应用支持默认开通,无需申请调试
第三方企业应用支持默认开通,无需申请调试
第三方个人应用暂不支持

基本信息

请求方式:POST 请求地址

请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/message/corpconversation/recall
HTTP MethodPOST
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_base-调用企业API时需要具备的基本权限

查询参数

名称类型是否必填示例值描述
access_tokenStringbE74xxxx调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。

请求体

名称类型是否必填示例值描述
agent_idNumber836390886发送消息时使用的微应用的AgentID。 - 企业内部应用,可在开发者后台的应用详情页面查看。image - 第三方企业应用可调用获取企业授权信息接口获取。
msg_task_idNumber256271667526发送消息时钉钉返回的任务ID,调用发送工作通知接口获取task_id参数值。 说明 仅支持撤回24小时内的工作消息通知。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/message/corpconversation/recall" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=404080xxxx4ab30' \
-d 'agent_id=1000' \
-d 'msg_task_id=2000'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/message/corpconversation/recall");
OapiMessageCorpconversationRecallRequest req = new OapiMessageCorpconversationRecallRequest();
req.setAgentId(1000L);
req.setMsgTaskId(2000L);
OapiMessageCorpconversationRecallResponse rsp = client.execute(req, accessToken);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiMessageCorpconversationRecallRequest("https://oapi.dingtalk.io/topapi/message/corpconversation/recall")

req.agent_id=1000
req.msg_task_id=2000
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiMessageCorpconversationRecallRequest;
$req->setAgentId("1000");
$req->setMsgTaskId("2000");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/message/corpconversation/recall");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/message/corpconversation/recall");
OapiMessageCorpconversationRecallRequest req = new OapiMessageCorpconversationRecallRequest();
req.AgentId = 1000L;
req.MsgTaskId = 2000L;
OapiMessageCorpconversationRecallResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
errmsgStringok返回码描述。
errcodeNumber0返回码。

响应体示例

{
  "errcode":0,
  "errmsg":"ok"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errorcode)错误信息描述(errmsg)解决方案
400002agentId不合法或taskId不合法确认agentId或taskId是否正确
500系统异常出现未知的系统异常