将指定用户从群组中踢出

调用KickLiveMessageGroupUser将指定用户从群组中踢出。

使用说明

调用本接口前,您必须已经调用CreateLiveMessageGroup创建互动消息群组。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String KickLiveMessageGroupUser

系统规定参数。取值:KickLiveMessageGroupUser

AppId String demo

需要踢人的互动消息应用ID。

GroupId String grouptest

需要处理的群组的GroupID。

KickoffUser String uid1

需要踢出去的用户。

DataCenter String cn-shanghai

数据中心,需要与CreateLiveMessageApp中的数据中心一致,当前支持上海(取值为cn-shanghai)、新加坡(取值为ap-southeast-1)。

返回数据

名称

类型

示例值

描述

RequestId String 97168878-5288-10CE-AE56-E2D1627F****

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=KickLiveMessageGroupUser
&AppId=demo
&GroupId=grouptest
&KickoffUser=uid1
&DataCenter=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

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

<KickLiveMessageGroupUserResponse>
    <RequestId>97168878-5288-10CE-AE56-E2D1627F****</RequestId>
</KickLiveMessageGroupUserResponse>

JSON格式

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

{
  "RequestId" : "97168878-5288-10CE-AE56-E2D1627F****"
}

错误码

HttpCode

错误码

错误信息

描述

400 InputInvalid %s. 输入参数不合法
403 NoAuth %s. 没有权限
404 ResourceNotExist %s. 请求资源不存在,请检查后重新尝试
500 ServerError %s. 未知错误,请稍后重试或提交工单咨询。

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