设置群成员禁言状态新版SDK
更新于 2024-02-27
例如，在客户端将群内某成员禁言的操作流程如下图所示。
群成员禁言设置成功后效果如下图所示。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 钉钉群基础信息管理权限 | API Explorer |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Body参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
userIdList | Array of String | 是 | 需要禁言或取消禁言的群成员userId列表。 说明
|
openConversationId | String | 是 | 群ID，通过创建群接口获取 |
muteStatus | Integer | 是 | 禁言状态：
|
muteDuration | Long | 是 | 禁言持续时长，单位：毫秒。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter.openConversationIdDecError | 会话ID解密失败 | 会话ID解密失败 |
400 | invalidParameter.userIdList | 不合法的群成员列表 | 不合法的群成员列表 |
400 | invalidParameter.muteStatusError | 不合法的的禁言状态 | 不合法的的禁言状态 |
400 | invalidParameter.openConversationIdError | 不合法的会话ID | 不合法的会话ID |
400 | cannot.ban.owner | 不允许禁言群主 | 不允许禁言群主 |
400 | cannot.find.user | 找不到该用户 | 找不到该用户 |
400 | invalidGroupParams | 群不存在或者群成员为空 | 群不存在或者群成员为空 |
400 | group.org.checkFailed | 无权限，群不属于当前企业 | 无权限，群不属于当前企业 |
500 | system.error | 系统繁忙，请稍后再试 | 系统繁忙，请稍后再试 |
