调用KickOff从IMPaaS或互动PaaS移除指定用户的登录态,并发一条通知给这些登录的设备,可指定将某个端踢下线。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String KickOff

系统规定参数,取值:KickOff

AppId String apitest

App ID。IMPaaS或互动PaaS租户的ID。

RequestParams Object

将指定用户踢下线请求体。

AppUid String 950000010

被踢的用户ID。

AppKeys Array of String 12345

被踢的客户端AppKey。

Information String 您已被系统强制下线!

下线文案。被踢后通知给对方的提示文案。

返回数据

名称 类型 示例值 描述
RequestId String C02635EE-C867-4CC0-9DE0-E4497378F720

请求ID。

Code String User.xxx

错误码。

Message String Error Message

错误信息。

示例

请求示例

http(s)://live-interaction.aliyuncs.com/?AppId=apitest
&RequestParams={"AppUid":"950000010","AppKeys":["12345"],"Information":"您已被系统强制下线!"}
&公共请求参数

正常返回示例

XML格式

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

<RequestId>C02635EE-C867-4CC0-9DE0-E4497378F720</RequestId>
<Code>User.xxx</Code>
<Message>Error Message</Message>

JSON格式

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

{
  "RequestId" : "C02635EE-C867-4CC0-9DE0-E4497378F720",
  "Code" : "User.xxx",
  "Message" : "Error Message"
}

错误码

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