取消订阅文件变更事件

POST

/v1.0/storage/events/unsubscribe

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

调用本接口，取消订阅文件变更事件。

调用本接口，可取消订阅企业或指定存储空间的事件订阅，取消之后，对应范围内的文件变更事件将不再推送。

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	企业存储文件变更事件订阅写权限	API Explorer
第三方企业应用	支持	企业存储文件变更事件订阅写权限	API Explorer
第三方个人应用	暂不支持	企业存储文件变更事件订阅写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
400	paramError.scope	%s	参数错误-scope
400	paramError.scopeId	%s	参数错误-scopeId
403	permissionDenied	%s	用户缺少订阅事件的权限
500	systemError	%s	系统错误
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/storage/events/unsubscribe?unionId=String' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "scopeId" : "String",
  "scope" : "String"
}'

响应示例

{
    "success": true
}

请求参数

Query 参数

unionId

string

必需

操作者unionId。

企业内部应用，调用查询用户详情接口获取unionid参数值。

第三方企业应用，调用查询用户详情接口获取unionid参数值。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

scopeId

string

必需

订阅范围对应的ID。当scope参数值为ORG时，scopeId对应的是企业corpId。企业内部应用，请参考基础概念-CorpId。第三方企业应用，请参考基础概念-CorpId。当scope为SPACE时，scopeId对应的是存储空间ID。企业内部应用，可调用添加空间接口获取id。第三方企业应用，可调用添加空间接口获取id。

scope

string

必需

订阅范围。 ORG：企业 SPACE：空间

示例