运营后台 API - 用户模块

优质

小牛编辑

119浏览

2023-12-01

获取用户列表

接口

GET https://cloud.minapp.com/userve/v1/miniapp/user-profile/

参数说明

参数	类型	必填	说明
created_at	String	N	用户创建的时间，值为时间戳。查询创建时间大于等于 2017-01-01 的用户 `created_at__gte=1483228800`，查询创建时间小于等于 2017-01-01 的用户：`created_at__lte=1483228800`
gender	Number	N	户的性别，其中 `1` 表示男，`2` 表示女
group	String	N	给定用户组 ID 查询在用户组下的用户列表。只支持 `in` 查询：`group__in=258,360`
limit	Number	N	限制返回资源的个数，默认为 20 条，最大可设置为 1000
nickname	String	N	用户的微信昵称，支持等值查询 `nickname=Tom`, 模糊查询 `nickname__contains=Tom`
offset	Number	N	设置返回资源的起始偏移值，默认为 0
openid	String	N	用户的 OpenID
order_by	String	N	排序（支持 `created_at` 进行排序）
unionid	String	N	用户的 UnionID
user_id	String	N	用户 ID

代码示例

var axios = require('axios').create({
  withCredentials: true
})
axios.get('https://cloud.minapp.com/userve/v1/miniapp/user-profile/', {
  params: {
    nickname__contains: 'Tom',
    gender: 1,
    created_at__gt: 1483228800,
    order_by: '-created_at',
  }
}).then(res => {
  console.log(res.data)
})

返回示例

{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "avatar": "https://media.ifanrusercontent.com/media/tavatar/55/c3/55c3dbebcc61891be10d29ded808c84a01dcf864.jpg",
      "city": "Guangzhou",
      "country": "China",
      "created_at": 1504504504,
      "gender": 1,
      "nickname": "PCG",
      "openid": "onzns0KsLKFyg3-VcW0GwTE652_k",
      "unionid": "onzns0KsLKFyg3-VcW0GwTE652_k",
      "province": "Guangdong",
      "user_group": [
          137
      ],
      "user_id": 36619758
    }
  ]
}

获取用户详情

接口

GET https://cloud.minapp.com/userve/v1/miniapp/user-profile/?user_id={{user_id}}

其中 user_id 即用户 ID

代码示例

var axios = require('axios').create({
  withCredentials: true
})
axios.get('https://cloud.minapp.com/userve/v1/miniapp/user-profile/', {
  params: {user_id: 36619758},
}).then(res => {
  console.log(res.data)
})

返回示例

{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "avatar": "https://media.ifanrusercontent.com/media/tavatar/55/c3/55c3dbebcc61891be10d29ded808c84a01dcf864.jpg",
      "city": "Guangzhou",
      "country": "China",
      "created_at": 1504504504,
      "gender": 1,
      "nickname": "PCG",
      "openid": "onzns0KsLKFyg3-VcW0GwTE652_k",
      "unionid": "onzns0KsLKFyg3-VcW0GwTE652_k",
      "province": "Guangdong",
      "user_group": [
          137
      ],
      "user_id": 36619758
    }
  ]
}