取消日程

调用该接口取消日程，只能取消通过创建日程接口创建的日程。

重要

为提升接口的使用体验，提供更加规范的接口，钉钉针对日程相关接口进行了升级。本接口文档已于2021年11月09日迁移至历史文档（不推荐）目录下，接口不会下线。

  • 新版和旧版日程API的ID体系不同，不能混合使用，推荐使用新版日程接口。

  • 已接入的用户建议您根据自身实际情况评估是否切换至新接口。

  • 新接入的用户建议直接使用新接口删除日程。

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

是

重要

暂不支持新增申请。

—

第三方企业应用

否

—

—

第三方个人应用

否

—

—

基本信息

请求方式：POST

请求地址：https://oapi.dingtalk.com/topapi/calendar/v2/event/cancel

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

是

6d1bxxxx

调用服务端API的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

calendar_id

String

是

primary

日历ID。

目前仅支持传primary表示修改当前用户“我的日程”下的日程。

event_id

String

是

053E8xxxx

加密后的日程ID。

agentid

Number

否

1212

应用对应的AgentId。

返回参数

名称

类型

示例值

描述

success

Boolean

true

是否成功。

errcode

Number

0

返回码。

errmsg

String

ok

返回码描述。

request_id

String

zbbs6uxpei1r

请求ID。

示例

请求示例（HTTP）

POST https://oapi.dingtalk.com/topapi/calendar/v2/event/cancel?access_token=ACCESS_TOKEN

请求正文

{
    "agentid": 923680251,
    "event_id": "053ExxxxA1FE",
    "calendar_id": "primary"
}

请求示例（JAVA SDK）

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/calendar/v2/event/cancel");
OapiCalendarV2EventCancelRequest req = new OapiCalendarV2EventCancelRequest();
req.setCalendarId("primary");
req.setEventId("053ExxxxA1FE");
req.setAgentid(923680251L);
OapiCalendarV2EventCancelResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "success": true,
    "request_id": "3wiymoeilfb6"
}