获取指定用户在线状态详情

简要描述

• 获取指定用户处于线上的平台下的 token 数组列表。

请求方式

• post

请求 URL

• {API_ADDRESS}/user/get_users_online_token_detail

Header

header 名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	operationID 用于全局链路追踪
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
  "userIDs": ["2621568666", "2621568663"]
}

字段名	选填	类型	说明
userIDs	必填	array	需要查询的用户 ID 数组

成功返回示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": [
    {
      "userID": "2621568666",
      "status": "online",
      "singlePlatformToken": [
        {
          "platform": "Web",
          "total": 1,
          "token": [
            "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyNjIxNTY4NjY2IiwiUGxhdGZvcm1JRCI6NSwiZXhwIjoxNjk1OTAyOTI1LCJuYmYiOjE2ODgxMjY2MjUsImlhdCI6MTY4ODEyNjkyNX0.ulWW0Fr9n0__1pT9qxWJw9ym8zwosveYYPyyLaUVkU4"
          ]
        }
      ]
    }
  ]
}

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,0 表示成功
errMsg	string	错误简要信息,无错误时为空
errDlt	errDlt	错误详细信息,无错误时为空
data	object	通用数据对象，具体结构见下方
userID	string	用户 ID
status	string	在线状态，online/offline
singlePlatformToken	array	单个平台在线 token 集合
singlePlatformToken.platform	string	在线平台，1->IOS,2->Android,3->Windows,4->OSX,5->Web,5->MiniWeb,7->Linux,8->AndroidPad,9->IPad
singlePlatformToken.total	string	在线总数
singlePlatformToken.token	array	token 数组

失败返回示例

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

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息