# 获取成员变更列表
# 接口描述
只有主体对应用处于开启状态时,应用方才能调通本文档中接口拿到该主体相关数据。该接口用于获取成员增 量更新数据,业务方根据自身的需要,按照时间区间进行获取。本接口对于更新区间限制比较严格,请查看注 意事项。
# 请求方法
POST(application/json)
# 请求地址
https://open.wecard.qq.com/cgi-bin/user/get-update-records
# 参数说明
{
"access_token": "XAyFh03UemERYTDzl0GtPpGQ4BDBkJEJ",
"range_start": "2020-11-1 00:00:00",
"range_end": "2020-11-1 23:59:59",
"page": 1,
"page_size":1000
}
参数 | 必填 | 类型 | 实例 | 说明 |
---|---|---|---|---|
access_token | 是 | String | XAyFh03UemERYTDzl0GtPpGQ4BDBkJEJ | 应用凭证 |
range_start | 否 | Datetime | 2020-11-1 00:00:00 | 获取增量更新开始区间,默认为当天0点(开始时间与结束时间需在同一天范围内) |
range_end | 否 | Datetime | 2020-11-1 23:59:59 | 获取增量更新开始区间,默认为当前时间(开始时间与结束时间需在同一天范围内) |
page | 否 | Integer | 1 | 分页页数,默认为1 |
page_size | 否 | Integer | 1000 | 分页条数,默认为1000,最大为1000 |
# 响应说明
{
"errcode": 0,
"errmsg": "ok",
"page": 1,
"page_size": 1000,
"range_start": "2020-11-1 00:00:00",
"range_end": "2020-11-1 23:59:59",
"total": 606,
"list": [
{
"type": "updateUser",
"card_number": "20181818",
"created_at": "2020-11-01 12:03:03"
}
]
}
参数 | 必填 | 类型 | 实例 | 说明 | |
---|---|---|---|---|---|
errcode | 是 | Integer | 0 | 状态码,0为成功,非0为错误 | |
errmsg | 是 | String | success | 状态描述信息 | |
page | 是 | Integer | 1 | 当前获取数据为第几页 | |
page_size | 是 | Integer | 1000 | 当前获取数据的页大小 | |
range_start | 否 | Datetime | 2020-11-1 00:00:00 | 获取增量更新开始区间,默认为当天0点 | |
range_end | 否 | Datetime | 2020-11-1 23:59:59 | 获取增量更新结束区间,默认为当前时间 | |
total | 是 | Integer | 606 | 该组织架构下所有的用户总数 | |
list | type | 是 | String | updateUser | 数据变更类型,addUser为新增,updateUser为修改,deleteUser为删除 |
card_number | 是 | String(32) | 07302590 | 用户电子卡号/学工号 | |
created_at | 是 | Datetime | 2019-12-04 09:00:00 | 事件发生时间 |
# 注意事项
- 私有化部署的主体不能使用上面接口地址,需要根据主体私有化部署域名拼上对应的路径。
- 增量数据具有时效性,过期的增量数据没有过多的意义,本接口限制最多仅能获取一天前的数据。
- 增联更新开始时间和结束时间必须要为同一天
← 获取成员变更事件推送 信息同步概述 →