跳到主要内容

强制用户下线

简要描述

  • 强制用户从某个终端退出登录,客户端SDK会收到onKickedOffine回调事件。

请求方式

  • post

请求URL

  • http://x.x.x.x:10002/auth/force_logout
header名示例值选填类型说明
operationID1646445464564必填stringoperationID用于全局链路追踪
tokeneyJhbxxxx3Xs必填string管理员token

请求参数示例

{
"platformID": 2,
"userID": "4950983283"
}
字段名选填类型说明
platformID必填int平台ID, 1:IOS,2:Android,3:Windows,4:OSX,5:Web,6:MiniWeb,7:Linux,8:Android Pad,9:IPad,10:admin
userID必填string用户ID

成功返回示例

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

成功返回示例的参数说明

参数名类型说明
errCodeint错误码,0表示成功
errMsgstring错误简要信息,无错误时为空
errDlterrDlt错误详细信息,无错误时为空
dataobject通用数据对象,具体结构见下方

失败返回示例

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息