取消订阅公共日历新版SDK

更新于 2023-04-06

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，取消订阅公共日历。

接口功能介绍

调用本接口，可取消订阅日历。接口调用效果与下图操作实现的效果一致。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	日历应用中日历写权限	API Explorer
第三方企业应用	支持	日历应用中日历写权限	API Explorer
第三方个人应用	支持	日历应用中日历写权限	API Explorer

请求方法

Header参数

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取。第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。第三方个人应用，调用获取用户token接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。
第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。
第三方个人应用，调用获取用户token接口获取。

Path参数

名称	类型	是否必填	描述
userId	String	是	取消订阅者的unionId。企业内部应用，调用查询用户详情接口获取unionid参数值。第三方企业应用，调用查询用户详情接口获取unionid参数值。第三方个人应用，调用获取用户通讯录个人信息接口获取unionId参数值。
calendarId	String	是	订阅日历的id。企业内部应用，订阅日历的创建者或已订阅日历的人员，可调用查询日历接口获取type类型为subscribed时的日程id参数值。第三方企业应用，订阅日历的创建者或已订阅日历的人员，可调用查询日历接口获取type类型为subscribed时的日程id参数值。第三方个人应用，订阅日历的创建者或已订阅日历的人员，可调用查询日历接口获取type类型为subscribed时的日程id参数值。

名称

类型

是否必填

描述

userId

String

是

取消订阅者的unionId。

企业内部应用，调用查询用户详情接口获取unionid参数值。
第三方企业应用，调用查询用户详情接口获取unionid参数值。
第三方个人应用，调用获取用户通讯录个人信息接口获取unionId参数值。

calendarId

String

是

订阅日历的id。

企业内部应用，订阅日历的创建者或已订阅日历的人员，可调用查询日历接口获取type类型为subscribed时的日程id参数值。
第三方企业应用，订阅日历的创建者或已订阅日历的人员，可调用查询日历接口获取type类型为subscribed时的日程id参数值。
第三方个人应用，订阅日历的创建者或已订阅日历的人员，可调用查询日历接口获取type类型为subscribed时的日程id参数值。

返回参数

名称	类型	描述
result	Boolean	取消订阅操作是否成功，true表示成功。

示例

请求示例

HTTP

Java

Python

PHP

Node.js

返回示例

错误码

HttpCode	错误码	错误信息	说明
400	permissionDenied	用户不在订阅范围	用户不在订阅范围
400	invalidParameter	forwardErrorMessage	参数异常
400	invalidParameter	calendarId cannot be blank	calendarId不能为空
400	invalidParameter	calendar type invalid	日历类型异常

这篇文档是否有帮助？

本页内容