Skip to main content

功能说明

将已经连接至 IM 服务的用户踢下线,支持按 平台设备用户 维度踢用户下线,当前接口仅对当次连接有效,不影响用户后续连接,例如某个用户多个设备登录,在后登录的设备将其他设备踢掉线。

请求说明

请求鉴权:接口需要增加验证 Header,请查看 鉴权说明

请求类型GET

请求限频100次/秒

请求地址:https://请求域名/apigateway/users/kick

Content-Typeapplication/json

请求参数

参数数据类型是否必填参数说明
user_idstring要踢下线的用户 Id
platformsarray按指定设备类型来踢,这个字段非必填,不传时默认踢所有端
device_idsarray需要踢下线的设备唯一标识
extstring扩展字段,该字段会在用户收到被踢通知时,由 SDK 返给业务层,可用于定制化提醒等

请求示例

GET /apigateway/users/kick HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

{
"user_id":"userid1",
"platforms":["iOS","Android"],
"device_ids":["xxxxx","yyyyy"]
}

响应示例

{
"code":0,
"message":"success"
}