跳到主要内容

强制用户下线

简要描述

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

请求方式

  • post

请求 URL

  • {API_ADDRESS}/auth/force_logout
header 名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪,建议使用时间戳,在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例

{
"platformID": 2,
"userID": "4950983283"
}
字段名选填类型说明
platformID必填int用户登录时的终端类型,取值为1-9
userID必填string用户 ID

成功返回示例

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

成功返回示例的参数说明

参数名类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简要信息,为空
errDlterrDlt错误详细信息,为空

失败返回示例

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

失败返回示例的参数说明

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