接口说明

使用说明

本接口用于将指定终端用户从频道踢出。

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
TerminalIds	array	是	用户 ID 列表。	1811xxxx
	string	否	用户 ID 列表，N 的取值：1~30。格式如下所示： `TerminalIds.1=** TerminalIds.2=** ......`	1811****
AppId	string	是	应用 ID，仅支持传单个 ID。可通过控制台创建和查询。	yourAppId
ChannelId	string	是	已加入的频道 ID，仅支持传单个 ID。	yourChannelId

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Terminals	object
Terminal	array<object>	用户 ID 信息列表。
	object	用户 ID 信息。
Code	integer	状态码，成功返回 0，失败返回错误码描述。	0
Message	string	删除终端操作结果。取值： Success：成功。 Failed：失败。	Success
Id	string	用户 ID。	1811****

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Terminals": {
    "Terminal": [
      {
        "Code": 0,
        "Message": "Success",
        "Id": "1811****"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
500	Channel.InternalError	Channel operate internal error
500	Service.InternalError	service internal error
404	Channel.NotExist	Channel not existed
404	Service.NoSignaling	service no signaling

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

变更历史

更多信息，参考变更详情。