IM 登录/登出记录查询

更新时间: 2024/05/24 15:19:34

网易云信 IM 服务端支持用户登录/登出事件记录的查询功能。

登录/登出事件记录查询

功能描述

  • 根据时间段查询用户的登录登出记录,每次最多返回 100 条。
  • 不提供分页支持,第三方需要根据时间段来查询。

调用前提

该 API 需要开通登录登出事件记录查询功能才能正常使用,且不支持查询开通前的登录登出事件记录。

若未开通,请前往云信控制台开通。配置路径:选择待开通该功能的应用,然后进入IM 即时通讯 > 功能配置 > 全局功能 > 登录登出事件记录查询

登录登出事件记录查询.png

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/history/queryUserEvents.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数
类型
必须说明
accid String要查询用户的accid
begintimeString开始时间,毫秒级
endtime String截止时间,毫秒级
limit int本次查询的记录数量上限(最多100条),小于等于0,或者大于100,会提示参数错误
reverse int1按时间正序排列,2按时间降序排列。其它返回参数414错误。默认是按降序排列

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk***mgq3" -H "Nonce: 4tggg***3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=11111&begintime=1448948957018&endtime=1448955895518&limit=50' 'https://api.netease.im/nimserver/history/queryUserEvents.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{ 
  "code":200, 
  "size":xxx,//总共记录数 
  "events": 
  [ 
    { 
      "accid":"t4",	//用户accid 
      "timestamp":1452058433412, //发生时间,ms 
      "eventType":2,	//2表示登录,3表示登出 
      "clientIp":"8.8.8.8", //用户clientip 
      "sdkVersion":12, //sdk 版本 
      "clientType":"IOS", //终端 
      "deviceId":"a4789a14-8ef3-4a3d-9ab3-8fdc9e54f112", //设备ID,可选字段
      "customTag":"自定义tag", //登录时设置的自定义tag,可选字段
      "code":200	//登录成功状态,200表示成功 
    }, 
    { 
      "accid":"t4",	//用户accid 
      "timestamp":1452058381580,	//发生时间,ms 
      "eventType":3,	//2表示登录,3表示登出 
      "clientIp":"8.8.8.8", //用户clientip 
      "sdkVersion":12, //sdk 版本 
      "clientType":"IOS", //终端 
      "deviceId":"a4789a14-8ef3-4a3d-9ab3-8fdc9e54f112", //设备ID,可选字段
      "customTag":"自定义tag", //登录时设置的自定义tag,可选字段
      "code":200	//登录成功状态,200表示成功 
    } 
  ] 
} 

状态码

该接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 登录/登出事件记录查询
  • 功能描述
  • 调用前提
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 状态码