解除全员禁言

大约 1 分钟

解除全员禁言

功能说明

  • 一键取消对群组全体成员的禁言。
  • 解除禁言后,群成员可以在群组和该群组下的消息话题中正常发送消息。

调用频率上限

100 次/秒/App ID

请求 URL

DELETE https://{host}/app-id/{app_id}/chatgroups/{group_id}/ban

关于请求 URL 中的参数说明,详见 请求 URL 参数介绍

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X DELETE 'https://XXXX/app-id/{app_id}/chatgroups/{groupid}/ban'   \
-H 'Content-Type: application/json'   \
-H 'Accept: application/json'   \
-H 'Authorization: Bearer <YourAppToken>' 

请求 header 参数

关于 Content-TypeAcceptAuthorization 字段的说明,详见 请求 header 参数说明

响应示例

{
  "action": "delete",
  "uri": "https://XXXX/XXXX/XXXX/chatgroups/12XXXX53/ban",
  "entities": [],
  "data": {
    "mute": false
  },
  "timestamp": 1594628899502,
  "duration": 1
}

响应 body 字段

如果返回的 HTTP 状态码为 200,表示请求成功,响应包体中的 data 字段说明如下:

字段类型描述
dataJSON响应实体。
- muteBool是否处于全员禁言状态。
- true:是;
- false:否。

其他字段的说明如下:

字段类型描述
actionString请求方法。
uriString请求 URL。
entitiesJSON Array响应实体。
timestampLongUnix 时间戳,单位为毫秒。
durationInt从发送请求到响应的时长,单位为毫秒。

错误码

如果返回的 HTTP 状态码非 200,表示请求失败,可能提示以下错误码:

HTTP 状态码错误类型错误提示可能原因处理建议
401unauthorizedUnable to authenticate (OAuth)token 不合法,可能过期或 token 错误。使用新的 token 访问。
404resource_not_foundgrpID XX does not exist!群组不存在。使用合法的群 ID。

关于其他错误,你可以参考 响应状态码 了解可能的原因。

上次编辑于: