简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

获取用户列表

更新时间:2022-09-28 07:24:34下载pdf

本文介绍获取用户列表的 API。

接口描述

以用户创建时间为条件,获取开发者账号下的 App 用户数据,数据获取最大时间间隔为 30 天。推荐 start_timeend_time 采用确定的时间范围填充,不传 Null。

接口地址

GET: /v2.0/apps/{schema}/users

请求参数

参数名类型参数位置是否必填说明
schemaStringuritrueApp 渠道标识符。
page_noIntegerquerytrue当前页数。
page_sizeIntegerquerytrue每页的行数。取值范围:0100
usernameStringqueryfalse用户名。
start_timeLongqueryfalse开始时间,以 10 位时间戳表示。
  • 如果 start_time 为 Null ,以 end_time 为参考值。
  • 如果 start_time = end_time = Null,默认 end_time 是当前时间,start_time 是当前时间-30 天。
end_timeLongqueryfalse截止时间,以 10 位时间戳表示。
end_time 为 Null 时,以 start_time 为参考值 。

返回参数

参数名类型说明
resultPagedTotalVO返回结果说明。

result 说明

参数名类型说明
listList返回的值对象集合。
has_moreBoolean判断是否存在更多数据。
  • true:有
  • false:无
totalLong用户总数。

list 说明

参数名类型说明
uidString用户 UID。
usernameString用户名。
mobileString手机号码(仅支持手机号注册用户)。
emailString邮箱(仅支持邮箱注册用户)。
create_timeLong创建时间。
update_timeLong更新时间。
country_codeString国家码。

请求示例

GET: /v2.0/apps/testApp/users?page_no=1&page_size=10&start_time=1602848780&end_time=1603809946

返回示例

{
    "list": [
        {
            "create_time": 1602848780,
            "mobile": "****",
            "uid": "ay15264******aK4Jo",
            "country_code": "86",
            "update_time": 1602848780,
            "username": "****"
        },
        {
            "create_time": 1602848780,
            "uid": "ay1526******09hBOKe",
            "country_code": "86",
            "update_time": 1602848780,
            "email": "****",
            "username": "****"
        }
    ],
    "total": 2,
    "has_more": false
}

错误码

参考 错误码