查询单个用户信息

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

请求方式及url

请求方式：POST
请求头：Content-Type:application/json
接口地址：https://api.xiaoe-tech.com/xe.user.info.get/1.0.0
频率限制：10秒3000次

在线调试工具

请求

响应

请求参数说明

参数名	必选	类型	说明	备注（示例）
access_token	是	string	专属token	`xe_xxxxx`
user_id	否	string	用户id
data.wx_union_id	否	string	微信 union_id
data.phone	否	string	手机号码	`可能会带区号，如+86-139xxxx`
data.field_list	是	object	所要查询的字段集合
data.wx_open_id	否	object	微信open_id

字段集合field_list

参数名	必选	类型	说明	备注（示例）
field_list.wx_union_id	否	string	微信 union_id
field_list.wx_open_id	否	string	微信 open_id
field_list.wx_app_open_id	否	string	微信小程序 open_id
field_list.wx_email	否	string	微信邮箱
field_list.nickname	否	string	昵称
field_list.name	否	string	真实姓名
field_list.avatar	否	string	压缩后的头像
field_list.gender	否	int	性别	`0-无 1-男 2-女`
field_list.city	否	string	城市
field_list.province	否	string	省份
field_list.country	否	string	国家
field_list.phone	否	string	手机号码	`可能会带区号，如+86-139xxxx`
field_list.birth	否	string	生日	`1996-09-09`
field_list.address	否	string	地址
field_list.company	否	string	公司
field_list.is_seal	否	string	用户状态:`-1`-已注销，`0`-正常，`1`-已封号， `-2`-待注销状态（用户主动注销，30天内进入店铺将会变成正常状态，`3`-待激活（用户未正常登录的账号）
field_list.job	否	string	职位
field_list.wx_account	否	string	微信号	`该字段授权登录无法获取到，商家可以到管理台的用户详情进行完善`
field_list.phone_collect	否	string	信息采集手机号	`此字段返回数据的2个必要条件 1. 后台配置的信息采集必须开启【同步用户信息】开关 2. 用户必须主动填写采集的手机号`
field_list.sdk_user_id	否	string	sdk用户id
field_list.created_at	否	string	创建时间

备注

请求时，业务数据必须包含在data下
请求时，user_id、wx_union_id、wx_open_id和phone，四者中必须有一个需要传值
请求响应时，返回的手机号phone字段，如果是国外手机号会返回 +区号-手机号 格式

请求示例

通过user_id获取用户信息

{
    "access_token" : "xxxxxxxx",
    "user_id" : "5bc0369b304b5_nPpfWN6fGKBee3Ls",
    "data" : {
        "field_list" : [
            "name","nickname"
        ]
    }
}

通过wx_union_id获取用户信息

{
    "access_token" : "xxxxxxxxxx",
    "data" : {
        "wx_union_id" : "XXXXXXXXXXXX",
        "field_list" : [
            "name","nickname"
        ]
    }
}

通过wx_open_id获取用户信息

{
    "access_token" : "xxxxxxxxxx",
    "data" : {
        "wx_open_id" : "XXXXXXXXXXXX",
        "field_list" : [
            "name","nickname"
        ]
    }
}

通过phone获取用户信息

{
    "access_token" : "xxxxxxxxxx",
    "data" : {
        "phone" : "130xxxxxxxxx",
        "field_list" : [
            "name","nickname"
        ]
    }
}

响应参数说明

参数名	类型	说明	备注
app_id	string	店铺id	`appxxx`
sdk_user_id	string	sdk用户id
created_at	string	用户创建时间
user_id	string	用户id	`u_wework_5bc0369b304b5_nPpfWN6fGKBee3Ls`
wx_union_id	string	微信 union_id
wx_email	string	微信邮箱
name	string	真实姓名
nickname	string	昵称
avatar	string	压缩后的头像
wx_avatar	string	微信原始头像
gender	int	性别	`0-无 1-男 2-女`
city	string	城市
province	string	省份
country	string	国家
age	int	年龄
birth	string	生日
phone	string	电话	用户手机号。若该字段为空，且`phone_collect`不为空，则该手机号将会以`phone_collect`的手机号返回。
address	string	地址
job	string	工作
company	string	公司
industry	string	行业
tags	string	兴趣标签
wx_account	string	用户微信号
phone_collect	string	信息采集手机号
phone_resource	string	phone来源标识	`phone-来源手机号` `collect-来源信息采集`

响应示例

{
    "code": 0,
    "msg": "ok",
    "data": {
        "is_seal": 0,
        "app_id": "appxxx",
        "user_id": "u_xxx",
        "nickname": "nickname",
        "name": "name"
    }
}

返回码说明

code=0 时，表示正常
code=2501 时，表示必选字段缺失
code=2502 时，表示字段格式无效
code=2506 时，表示当前用户不存在

查询单个用户信息

查询单个用户信息

请求

响应

results matching ""

No results matching ""