有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

接口描述

只有主体对应用处于开启状态时,应用方才能调通本文档中接口拿到该主体相关数据。该接口用于获取成员增 量更新数据,业务方根据自身的需要,按照时间区间进行获取。本接口对于更新区间限制比较严格,请查看注意事项。

请求方法

POST(application/json)

请求地址

https://open.wecard.qq.com/cgi-bin/user/get-update-records

输入参数

参数名称
参数描述
参数类型
是否必填
备注
access_token
应用有效凭证
String
通过获取应用有效凭证接口获取
range_start
获取增量更新开始区间
Datetime
默认为当天0点(开始时间与结束时间需在同一天范围内)
range_end
获取增量更新开始区间
Datetime
默认为当前时间(开始时间与结束时间需在同一天范围内)
page
分页页数
Integer
默认为1
page_size
分页条数
Integer
默认为1000,最大为1000

输出参数

参数名称
参数描述
参数类型
是否必填
备注
errcode
状态码
Integer
0:成功,非0:错误
errmsg
状态描述信息
String
-
page
当前获取数据为第几页
Integer
-
page_size
当前获取数据的页大小
Integer
-
range_start
获取增量更新开始区间,默认为当天0点
Datetime
-
range_end
获取增量更新结束区间,默认为当前时间
Datetime
-
total
该组织架构下所有的用户总数
Integer
-
list
成员变更列表
List
-
list.type
数据变更类型
String
addUser:新增
updateUser:修改
deleteUser:删除
list.card_number
用户学工号
String(32)
-
list.created_at
事件发生时间
Datetime
2019-12-04 09:00:00

示例

输入示例

{
"access_token":"XAyFh03UemERYTDzl0GtPpGQ4BDBkJEJ",
"range_start":"2020-11-1 00:00:00",
"range_end":"2020-11-1 23:59:59",
"page":1,
"page_size":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"
}
]
}
说明
私有化部署的主体不能使用上面接口地址,需要根据主体私有化部署域名拼上对应的路径。
增量数据具有时效性,过期的增量数据没有过多的意义,本接口限制最多仅能获取一天前的数据。
增联更新开始时间和结束时间必须要为同一天。