腾讯微卡Wiki

# 获取单个组织架构成员

# 字段申请：

发送需要申请的字段到 seasonyuan@tencent.com进行申请(邮件同时也抄送至lydiaxyang@tencent.com ， lindayyang@tencent.com ， ronniewan@tencent.com)，申请时需要注明申请内容、应用 APPKEY、应用名称、及应用使用场景

# 请求方法：

POST(application/json)

# 请求地址：

https://open.wecard.qq.com/cgi-bin/user/get-org-users?access_token=access_token

# 参数说明：

{
  "org_id": 232,
  "fetch_child": 0,
  "page": 1,
  "page_size": 5000
}
参数 是否必填 类型 实例 说明
access_token 是 String 应用有效凭证
org_id 是 Integer 232 组织架构唯一id(或者传0代表整个主体)
fetch_child 是 Integer 0 是否递归获取子组织架构下面的成员：1-是；0-否，默认为否
page 是 Integer 1 分页下标
page_size 是 Integer 5000 分页大小，每页最大数据是5000

# 响应说明（分行业用户字段说明）：

{
  "errcode": 0,
  "errmsg": "success",
  "page": 1,
  "page_size": 5000,
  "total": 9800,
  "userlist": [
    {
      "card_number": "07302590",
      "name": "陈小明",
      "identity_type": "1",
      "grade": "2016",
      "college": "人居环境工程学院",
      "profession": " 工程造价",
      "class": "1班",
      "identity_title": "经理/总监/部长/本科生...",
      "gender": 1,
      "organization": [2, 222, 496],
      "main_org_node": 2,
      "role": [1, 2],
      "campus": "东校区",
      "dorm_number": "至善园",
      "physical_chip_number": "xaqwecf",
      "physical_card_number": "fqweasd",
      "nation": "汉族",
      "birthday": "20020319",
      "origin_place": "深圳市",
      "graduated_school": "小碧中学",
      "address": "广东省深圳市",
      "contact_person": "陈大明",
      "contact_phone": "(+86)13800138000",
      "email": "605135612@qq.com",
      "id_card": "440305200203194013",
      "telephone": "(+86)13800138000",
      "bind_status": 0,
      "frozen_status": 0,
      "active_status": 0,
      "entrust_status": 0,
      "start_at": "2019-10-14 00:00:00",
      "expire_at": "2019-10-18 00:00:00",
      "updated_at": "2019-10-16 00:00:00",
      "head_image": "https://xxxxxxxxxxxxxx/a.png",
      "serial_number": "19527123",
      "job_title": "经理",
      "school_period": "幼儿园",
      "register_year": "2022"
    }
  ]
}
参数 必填 类型 实例 说明
errcode 是 Integer 0 响应状态码，0为成功
errmsg 是 String success 响应状态信息
page 是 Integer 1 当前获取数据为第几页
page_size 是 Integer 5000 当前获取数据的页大小
total 是 Integer 98000 该组织架构下所有的用户总数
userlist card_number 是 String(32) 07302590 用户电子卡号/学工号
name 是 Integer 陈小明 用户姓名(需申请)
identity_type 是 Integer 1 成员身份类型(需申请)，参考文档成员身份类型列表
grade 否 String 2016 年级(仅限自建应用)
college 否 String 人居环境工程学院 学院(仅限自建应用)
profession 否 String 工程造价 专业(仅限自建应用)
class 否 String 1班 班级(仅限自建应用)
identity_title 否 String 经理/总监/部长/本科生... 身份职称(仅限自建应用)
gender 否 Integer 1 性别，0为未知，1为男，2为女(仅限自建应用)
organization 否 Array [2,222,496] 用户所属组织架构id列表(需申请)
main_org_node 否 Integer 2 用户主部门 id，若无主部门则为 0
role 否 Array [1,2] 用户所属角色id列表(仅限自建应用)
campus 否 String 东校区 校区(仅限自建应用)
dorm_number 否 String 至善园6号 宿舍号(仅限自建应用)
physical_chip_number 否 String xaqwecf 物理芯片号(需申请)
physical_card_number 否 String fqweasd 物理卡号(需申请)
nation 否 String 汉族 民族(仅限自建应用)
birthday 否 String 20020319 生日(仅限自建应用)
origin_place 否 String 深圳市 生源地(仅限自建应用)
graduated_school 否 String 小碧中学 毕业学校(仅限自建应用)
address 否 String 广东省深圳市 地址(仅限自建应用)
contact_person 否 String 陈大明 联系人姓名(仅限自建应用)
contact_phone 否 String (+86)13800138000 联系人手机号码（带区号）(仅限自建应用)
email 否 String 605135612@qq.com 用户邮箱(仅限自建应用)
id_card 否 String 440305200203194013 身份证(仅限自建应用)
telephone 否 String (+86)13800138000 手机号码（带区号）(仅限自建应用)
bind_status 否 Integer 0 绑定状态(需申请)
frozen_status 否 Integer 0 冻结状态(需申请)
active_status 否 Integer 0 激活状态(需申请)
start_at 否 Datatime 2019-10-14 00:00:00 有效起始时间(仅限自建应用)
entrust_status 是 Integer 0 签约状态(需申请)0-未签约，1-已签约
expire_at 否 Datatime 2019-10-18 00:00:00 有效结束时间(仅限自建应用)
updated_at 否 Datatime 2019-10-16 00:00:00 用户信息变更时间(仅限自建应用)
head_image 否 String https://xxxxxxxxxxxxx/a.png 用户头像(仅限自建应用)
serial_number 否 String 19527123 编号(仅限自建应用)
job_title 否 String 经理 职务(仅限自建应用)
school_period 否 String 幼儿园 学段
register_year 否 int 2022 入学年份

# 注意事项

  1. 私有化部署的主体不能使用上面接口地址，需要根据主体私有化部署域名拼上对应的路径，主体私有化网关域名（私有化部署域名+/kong)
  2. access_token 的获取参考获取应用有效凭证。
  3. 主体组织架构成员需定时更新，推荐每日进行一次全量更新。
  4. 应用方可接受组织架构成员变更事件（增、删、改），参考文档成员变更事件推送。
  5. 每个主体都可以自定义成员身份类型，获取成员身份类型列表，参考文档获取成员身份类型

# 更新日志

日期 变更说明
2019-10-18 新文档上线，替换获取单个组织架构成员旧文档和获取多个组织架构成员旧文档
2020-05-08 新增角色字段

← 批量获取成员 →