禁言消息组全员

调用MuteAllGroupUser对消息组禁言,即开启全员禁言。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String MuteAllGroupUser

系统规定参数。取值:MuteAllGroupUser

AppId String VKL3***

互动消息应用ID。

GroupId String AE35-****-T95F

消息组ID。

OperatorUserId String de1**a0

操作人用户UserId。该用户必须是群组的创建者。

BroadCastType Integer 2

系统消息扩散类型,取值:

  • 0:不扩散。
  • 1:扩散到指定人。
  • 2:扩散到群组。

返回数据

名称

类型

示例值

描述

RequestId String 16A96B9A-****-CB92E68F4CD8

请求ID。

Result Object

返回结果。

Success Boolean true

禁言是否成功,取值:

  • true:成功。
  • false:不成功。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=MuteAllGroupUser
&AppId=VKL3***
&GroupId=AE35-****-T95F
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<MuteAllGroupUserResponse>
    <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>
    <Result>
        <Success>true</Success>
    </Result>
</MuteAllGroupUserResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "16A96B9A-****-CB92E68F4CD8",
  "Result" : {
    "Success" : true
  }
}

错误码

访问错误中心查看更多错误码。