腾讯微卡Wiki

# 获取单个组织架构成员

# 字段申请：

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

# 请求方法：

POST(application/json)

# 请求地址：

https://uni.weixiao.qq.com/open/cgi-bin/user/get-org-users

注：若私有化部署，接口地址域名变更私有化域名

# 参数说明：

{
    "access_token": "ACCESS_TOEKN",
    "org_id": 232,
    "fetch_child": 0,
    "page": 1,         
    "page_size": 5000
}
参数 是否必填 类型 实例 说明
access_token 是 String 应用有效凭证
org_id 是 Integer 232 组织架构唯一id
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
            ], 
            "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,
            "start_at": "2019-10-14 00:00:00",
            "expire_at": "2019-10-18 00:00:00",
            "updated_at": "2019-10-16 00:00:00",
        }
    ]
}
参数 必填 类型 实例 说明
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列表（需申请）
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 有效起始时间（需申请）
expire_at 否 Datatime 2019-10-18 00:00:00 有效结束时间（需申请）
updated_at 否 Datatime 2019-10-16 00:00:00 用户信息变更时间（需申请）

# 注意事项

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

# 更新日志

日期 变更说明
2019-10-18 新文档上线，替换获取单个组织架构成员旧文档和获取多个组织架构成员旧文档