api:user_info

获取员工基本资料列表

请求地址

https://openapi.b.qq.com/api/user/info

请求方式

get

请求样例

请求频率

100次/分钟(详见频率限制)

请求参数

所有向企业QQ发起的请求均包含该公共参数

此请求还需要如下参数

字段名称 字段类型 字段说明
open_ids string 员工open_id的列表,使用英文逗号分隔

返回结果

{
  "ret": 0,
  "msg": "调用成功",
  "data": {
    "0f09375d4e73599bcfa665d195fa7697": {
      "open_id": "0f09375d4e73599bcfa665d195fa7697",
      "gender": 1,
      "dept_id": 1754170384,
      "dept_ids": [
        1754170384,
        1
      ],
      "role_id": 16777216,
      "account": "test",
      "name": "test",
      "titles": [
        "",
        ""
      ],
      "title": "",
      "email": 0,
      "mobile": 0,
      "hidden": 0,
      "bind_mobile": 0,
      "disabled": 0
    }
  }
}

返回JSON格式数据:

字段名称 字段类型 字段说明
ret int 返回码:0 正常, >0 异常
msg string 如果ret不为0,会有相应的错误信息提示,UTF-8编码。
data object JS对象格式数据,以open_id为键,员工资料的对象为值

员工资料的对象的键值格式:

字段名称 字段类型 字段说明
open_id string 员工的open_id
gender int 性别(1男2女)
dept_ids array 父组织id的数组(一人可以属于多个组织,所以是数组)
dept_id int 员工属于的默认组织的id,是上面dept_ids数组中的一个值
role_id int 0: 企业管理员
1: 系统管理员
2: 信息管理员
4: 普通员工
其他: 自定义角色
account string 帐号(英文字母的id)
name string 姓名(汉字姓名)
titles array 该员工的职务,与dept_ids的数组相对应,表示员工在某个组织里相应的职务
title string 员工号在默认组织(上面的dept_id)的职务,是上面titles数组中的一个值
email bool 员工是否有设置email地址
0:没有设置
1:设置了
mobile int 员工是否有设置手机号码
0:无手机号
1:有手机号
hidden int 0:不隐藏
1:隐藏
(需要第三方应用根据该状态来显示还是隐藏该成员),
如果一个成员处于隐藏状态,他可以看到所有的成员,
否则只能看到非隐藏的成员
bind_mobile int 员工是否有绑定手机号码
0:未绑定
1:绑定
disabled int 员工号是否被停用
0:未被停用
1:被停用

注意:

企业QQ的组织架构业务,支持一个人属于多个组织,为了企业在管理中能够灵活地处理身兼数职或多岗位的问题。

所以,一个员工号通过API可能可以拉取到多个dept_id,使用字段dept_ids来返回,同理,员工在每个组织中, 兼任职务可能不同,使用titles数组来返回。

举个例子:

员工“卡尔”,在“后台组(id: 1565199740)”担任“员工”,在“总经理办公室(id: 1291619508)”担任“秘书”,在“运营部(id: 140325039)”担任“组长”,则返回数据为:

{
  "ret": 0,
  "msg": "调用成功",
  "data": {
      "2c0c7cdf67fd7d442db2390dce393bce": {
          "open_id": "2c0c7cdf67fd7d442db2390dce393bce",
          "gender": 1,
          "dept_id": 1565199740,
          "dept_ids": [
              1565199740,
              1291619508,
              140325039
          ],
          "role_id": 16777216,
          "account": "Karl",
          "name": "卡尔",
          "titles": [
              "员工",
              "秘书",
              "组长"
          ],
          "title": "员工",
          "email": 0,
          "mobile": 1,
          "hidden": 0
      }
  }
}

返回

api/user_info.txt · 最后更改: 2016/04/22 16:55 (外部编辑)