获取用户列表1.0.0

拥有此API的权限集
用户管理-查询

请求方式及url

  • 请求方式：POST
  • 请求头：Content-Type:application/json
  • 接口地址：https://api.xiaoe-tech.com/xe.user.batch.get/1.0.0
  • 频率限制：10秒3000次
  • 注：该接口最大获取前10000条数据，如果想获取更多数据请使用获取用户列表2.0.0

在线调试工具

请求

响应

请求参数

参数名 必选 类型 说明
access_token 是 string 专属token
phone 否 string 手机号，与nickname和name不同时生效，优先级：高
nickname 否 string 昵称, 与phone和name不同时生效, 优先级中
name 否 string 姓名, 与nickname和phone不同时生效, 优先级低
tag_id 否 string 标签ID, 数据JSON格式
from 否 string 用户来源：0-微信、1-sdk、2-字节跳动、3-百度、4-飞书企业内训、5-小班课app、6-通用h5、7-微博、8-B端导入、9-手机号注册、10-QQ
user_type 否 string 用户类型:0-全部，1-黑名单，2-超级会员
last_paytime_start 否 string 查询支付起始时间 yyyy-MM-dd
last_paytime_end 否 string 查询支付截至时间 yyyy-MM-dd
min_pay_sum 否 string 查询支付最小金额
max_pay_sum 否 string 查询支付最小金额
min_punch_count 否 int 查询支付最小次数
max_punch_count 否 int 查询支付最大次数
user_created_start 否 string 查询用户创建起始时间 yyyy-MM-dd
user_created_end 否 string 查询用户创建截止时间 yyyy-MM-dd
page 是 int 页码，表示第几页，从1开始
page_size 是 int 每页条数，最大50条

请求示例

 {
  "access_token": "xxxxxxxx",
  "page": 1,
  "page_size": 3
}

返回参数

参数名 类型 说明
code int 状态码：0-成功，其他为错误
message string 对返回码的文本描述内容
data.list array 用户列表
data.list.user_id string 用户id
data.list.user_nickname string 用户昵称
data.list.bind_phone string 绑定手机号
data.list.collect_phone string 采集手机号
data.list.avatar string 头像
data.list.from string 用户来源
data.list.pay_sum float 消费总额（元）
data.list.punch_count int 购买次数
data.list.wx_union_id string 微信 union_id
data.list.wx_app_open_id string 小程序 open_id
data.list.wx_open_id string 微信 open_id
data.list.user_created_at string 用户创建时间
data.total float 查询结果记录数

返回示例

 {
  "code": 0,
  "data": {
    "list": [
      {
        "user_id": "u_5ff82b0fc7592_AVq2Q3lr8o",
        "user_nickname": "手机尾号5254用户",
        "bind_phone": "14256365254",
        "collect_phone": "",
        "avatar": "https://wechatavator-1252524126.cos.ap-shanghai.myqcloud.com/aaa/default.svg",
        "from": "微信",
        "pay_sum": 1,
        "punch_count": 0,
        "wx_union_id": "",  
        "wx_app_open_id": "",
        "wx_open_id": "",
        "user_created_at": "2021-07-15 17:16:02"
      },
      {
        "user_id": "u_5ff82ef7ef74a_xzgleHz8wH",
        "user_nickname": "手机尾号8383用户",
        "bind_phone": "18283838383",
        "collect_phone": "",
        "avatar": "https://wechatavator-1252524126.cos.ap-shanghai.myqcloud.com/aaa/default.svg",
        "from": "微信",
        "pay_sum": 1,
        "punch_count": 0,
        "wx_union_id": "",  
        "wx_app_open_id": "",
        "wx_open_id": "",
        "user_created_at": "2021-07-15 17:16:02"
      },
      {
        "user_id": "u_5ffbb993770b3_P4IifcJ2sS",
        "user_nickname": "李文文",
        "bind_phone": null,
        "collect_phone": "",
        "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/FrNmoqE8kich6XMjcq60KDn8F3MibgYM2Uxn4iaIlvZ3HYxksl2VzOfFUCch1bJ7DFKow3cnGQoQicXIkv39cjFmGQ/132",
        "from": "微信",
        "pay_sum": 0,
        "punch_count": 0
        "wx_union_id": "",  
        "wx_app_open_id": "",
        "wx_open_id": "",
        "user_created_at": "2021-07-15 17:16:02"
      }
    ],
    "total": 3
  },
  "msg": "success"
}

results matching ""

    No results matching ""