获取用户列表

更新时间：2023-05-22 06:38:12下载pdf

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

接口描述

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

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
schema	String	uri	true	App 渠道标识符。
page_no	Integer	query	true	当前页数。
page_size	Integer	query	true	每页的行数。取值范围：`0` 到 `100`。
username	String	query	false	用户名。
start_time	Long	query	false	开始时间，以 10 位时间戳表示。如果 `start_time` 为 Null ，以 `end_time` 为参考值。如果 `start_time` = `end_time` = Null，默认 `end_time` 是当前时间，`start_time` 是当前时间-30 天。
end_time	Long	query	false	截止时间，以 10 位时间戳表示。当 `end_time` 为 Null 时，以 `start_time` 为参考值。

返回参数

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

result 说明

参数名	类型	说明
list	List	返回的值对象集合。
has_more	Boolean	判断是否存在更多数据。 `true`：有 `false`：无
total	Long	用户总数。

list 说明

参数名	类型	说明
uid	String	用户 UID。
username	String	用户名。
mobile	String	手机号码（仅支持手机号注册用户）。
email	String	邮箱（仅支持邮箱注册用户）。
create_time	Long	创建时间。
update_time	Long	更新时间。
country_code	String	国家码。

请求示例

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
}

错误码

参考错误码。

上一篇获取用户信息