选择应用类型
第三方企业应用开发

企业内部群禁言或解除禁言新版SDK

更新于 2023-01-18设置企业内部群禁言或者解除企业内部群禁言。

例如,某专属钉钉组织,企业内部群cid为cid123,调用本接口可以设置群cid123群禁言或解除禁言。实现效果与以下产品操作类似,拥有专属安全-群管理权限的管理员登录钉钉管理后台 > 专属钉钉 > 专属安全 > 群管理中查看的信息,可以将未禁言的群设置为禁言,或将已设置禁言的群解除禁言,如图

权限

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

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持专属钉钉群写权限API Explorer
第三方企业应用支持专属钉钉群写权限API Explorer
第三方个人应用暂不支持专属钉钉群写权限暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Body参数

名称

类型

是否必填

描述

openConverationId

String

群ID,获取方式如下

  1. 拥有专属安全-群管理权限的管理员登录钉钉管理后台 > 专属钉钉 > 专属安全 > 群管理中读取,如图。

  2. 通过接口获取。

banWordsType

Integer

操作类型。

  • 0:解除禁言

  • 1:开启禁言

返回参数

名称

类型

描述

code

String

返回码。

cause

String

结果。

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

HttpCode

错误码

错误信息

说明

400

not.inner.group

当前群不是内部群

当前群不是内部群

400

illegal.parameter.cid

openConverationId参数错误

参数漏填或者格式错误

400

illegal.parameter.type

banWordsType参数错误

参数漏填或者格式错误

400

org.not.match

群的归属组织与操作传入组织不匹配

群的归属组织与操作传入组织不匹配

点击纠错