通讯录管理

获取部门列表

• 请求说明

  GET https://qy.bangongyi.com/address/api/department/list?ticket=<ticket>&page=<page>

• 请求参数

  参数	类型	必须	说明
  ticket	string	是	调用接口凭证
  page	int	否	页码，分页获取数据，每页1000条数据

• 权限说明

  无

• 返回结果示例

    {
        "errno": 0,
        "errmsg": "ok",
        "data": {
            "count": "260",
            "department_list": [{
                "department_id": "244",
                "we_id": "1",
                "we_name": "办公逸",
                "we_parentid": "0",
                "rank": "0"
            }, {
                "department_id": "251",
                "we_id": "2",
                "we_name": "研发部",
                "we_parentid": "1",
                "rank": "200"
            }]
        }
    }

• 返回字段说明

  参数	类型	必须	说明
  department_id	int	是	办公逸部门id
  we_id	int	是	微信部门id
  we_name	string	是	部门名称
  we_parentid	int	是	父部门， 0表示根部门
  rank	int	是	排序字段

新增部门

• 请求说明

  POST https://qy.bangongyi.com/address/api/department/createdepartment?ticket=<ticket>

• 请求参数

  参数	类型	必须	说明
  we_name	string	是	部门名称
  we_parentid	int	是	父级部门we_id

• 权限说明

  无

• 返回结果示例

    {
        "errno": 0,
        "errmsg": "success"
    }

• 返回错误状态码说明

  状态码	说明
  1205	部门不存在
  1206	非法操作部门
  1210	部门操作失败

编辑部门

• 请求说明

  POST https://qy.bangongyi.com/address/api/department/editdepartment?ticket=<ticket>

• 请求参数

  参数	类型	必须	说明
  we_name	string	是	部门名称
  we_id	int	是	当前部门的we_id

• 权限说明

  无

• 返回结果示例

    {
        "errno": 0,
        "errmsg": "success"
    }

• 返回错误状态码说明

  状态码	说明
  1205	部门不存在
  1206	非法操作部门
  1210	部门操作失败

获取成员列表

• 请求说明

  GET https://qy.bangongyi.com/address/api/staff/list?ticket=<ticket>&we_id=<we_id>&fetch_child=<fetch_child>&page=<page>

• 请求参数

  参数	类型	必须	说明
  ticket	string	是	调用接口凭证
  we_id	int	否	部门id，默认为0，获取所有成员，指定此参数则返回该部门下的成员
  fetch_child	int	否	是否递归获取，默认为0：不递归，1递归获取子部门的成员
  page	int	否	页码，分页获取，每页1000条

• 权限说明

  无

• 返回结果示例

    {
        "errno": 0,
        "errmsg": "ok",
        "data": {
            "count": "22",
            "staff_list": [{
                "staff_id": "11038",
                "we_email": "bin.wang-js@pcstars.com",
                "we_userid": "wangbin",
                "we_avatar": "https:\/\/shp.qpic.cn\/bizmp\/HmtU0JT3A9j57V95OBD2xLDWQDF5wkpWmH814ibgibVotr52s92aHrvg\/",
                "we_mobile": "",
                "we_tel": "",
                "we_department": "2",
                "we_gender": "1",
                "we_name": "王",
                "we_position": "",
                "we_status": "1",
                "we_weixinid": "t29879598"
            }, {
                "staff_id": "11039",
                "we_email": "jinyu.he@pcstars.com",
                "we_userid": "jinyu",
                "we_avatar": "https:\/\/shp.qpic.cn\/bizmp\/HmtU0JT3A9hXjCJV2b9o4gKECtGnb8seQ6w6iaVSOFBSvXGVNDd6pXw\/",
                "we_mobile": "18801442437",
                "we_tel": "",
                "we_department": "2,37",
                "we_gender": "1",
                "we_name": "何",
                "we_position": "123",
                "we_status": "1",
                "we_weixinid": "hjy930226173"
            }, {
                "staff_id": "11429",
                "we_email": "wenting.zhang@pcstars.com",
                "we_userid": "A1332",
                "we_avatar": "https:\/\/shp.qpic.cn\/bizmp\/HmtU0JT3A9gv2svKzzNZlKWzA4PepHcCxA4iaVMXFmCTIFW9nsLGPbg\/",
                "we_mobile": "15837829355",
                "we_tel": "",
                "we_department": "1,8,2",
                "we_gender": "2",
                "we_name": "张",
                "we_position": "研发工程师",
                "we_status": "1",
                "we_weixinid": "z15810449952"
            }]
        }
    }

• 返回字段说明

  参数	必须	说明
  staff_id	是	办公逸员工id
  we_email	否	email
  we_userid	否	用户账号
  we_avatar	否	用户头像
  we_mobile	否	用户手机
  we_tel	否	用户座机
  we_department	否	所在部门
  we_gender	否	性别 0：未知，1：男，2：女
  we_name	否	用户姓名
  we_position	否	职位
  we_status	否	微信状态关注状态: 1=已关注，2=已冻结，4=未关注，-1不在微信，0：未知
  we_weixinid	否	用户微信号
  entry_time	否	入职时间
  positive_time	否	转正时间
  work_time	否	开始工作日期
  quite_time	否	离职时间
  birthday_g	否	阳历生日
  birthday_l	否	阴历生日

新增&编辑成员

• 请求说明

  POST https://qy.bangongyi.com/address/api/staff/add?ticket=<ticket>

• 请求参数

  参数	类型	必须	说明
  cover	int	否	是否覆盖 （0-跳过 1-覆盖）
  we_userid	string	是	帐号（唯一）
  we_name	string	是	姓名
  toQy	int	否	是否同步到企业号默认同步，值 -1为不同步
  english_name	string	否	英文名
  we_gender	int	否	性别 (男/女)
  we_weixinid	string	否(微信号/手机号/邮箱不能同时为空)	微信号
  we_mobile	string	否(微信号/手机号/邮箱不能同时为空)	手机号
  we_email	string	否(微信号/手机号/邮箱不能同时为空)	邮箱
  we_id	string	否(we_id/we_department不能同时为空)	所在部门的微信id(多个用逗号分隔) 例：'2,4,8'
  we_department	string	否(we_id/we_department不能同时为空)	所在部门层级(有父子层级显示时、需从根目录开始，父子级用“/”连接、平级用“;”连接 例：办公逸/研发部;办公逸/客服部;)
  we_position	string	否	职位
  position_level_id	string	否	职级（管理类P1）
  lead_id	string	否	直接上级（上级的帐号）
  subordinate	string	否	直接下属（上属的帐号，用/分隔）
  we_tag	string	否	标签（标签名称 多个用/分隔）
  we_tel	string	否	工作电话
  address	string	否	工作地址
  status	int	否	人事状态（0:已转正, 1:试用期, 2:兼职, 3:已离职）
  entry_time	int	否	入职时间 (2016-01-01)
  positive_time	int	否	转正时间 (2016-01-01)
  quite_time	int	否	离职时间 (2016-01-01)
  quite_reason	string	否	离职理由
  back_time	int	否	复职时间 (2016-01-01)
  work_time	int	否	参加工作时间 (2016-01-01)
  bank_card	string	否	银行卡账户
  bank_name	string	否	开户行
  birthday_g	int	否	公历生日 (2016-01-01)
  birthday_l	int	否	农历生日 (2016-01-01)
  check_id	int	否	考勤机员工编号（唯一、纯数字、不能以0开头、不能大于2147483647）

• 权限说明

  无

• 返回结果示例

    {
        "errno": 0,
        "errmsg": "保存成功",
        "data": {
            "id": 535365 
        }
    }

• 返回错误状态码说明

  状态码	说明
  1202	接口调用失败，可能未授权通讯录权限，或者可写部门
  1203	帐号不能为空
  1204	帐号已存在
  1205	手机号&微信号&邮箱三者不能同时为空
  1206	考勤机员工编号已存在
  1208	考勤机员工编号不能以0开头
  1215	考勤机员工编号不能大于2147483647
  1216	考勤机员工编号必须为数字
  1207	部门不能为空
  1209	添加或者更新员工失败
  1210	保存失败

删除成员

• 请求说明

  POST https://qy.bangongyi.com/address/api/staff/delete?ticket=<ticket>

• 请求参数

  参数	类型	必须	说明
  we_userids	array/string	是	需删除员工的帐号组成的数组 或者逗号分隔的字符串 例：we_userids = ['zhangsan','lisi'] 或者 we_userids = 'zhangsan,lisi'

• 权限说明

  无

• 返回结果示例

    {
        "errno": 0,
        "errmsg": "ok"
    }

• 返回错误状态码说明

  状态码	说明
  1211	参数错误（we_userids不存在）
  1212	删除失败，删除数量超过200人
  1213	删除失败，员工不存在
  1214	删除失败（个别员工删除失败）

批量更新员工数据

• 功能描述

  批量更更新员工入职、参加工作、转正、离职时间、员工姓名。

• 请求说明

post https://qy.bangongyi.com/address/api/staff/entry-time?ticket=<ticket>

参数	类型	是否必须	说明
ticket	string	是	接口凭证
time	int	是	发送时间
data	array	是	巡店数据 最多50条记录
we_userid	string	是	员工帐号
we_name	string	否	员工姓名
entry_time	string	否	入职的日期
work_time	string	否	参加工作的日期
positive_time	string	否	转正的日期
quite_time	string	否	离职的日期

• 请求示例

    {
        "time": 1555307348, 
        "data": [
           {
              "we_userid":"B252019000153", 
              "we_name":"员工姓名", 
              "entry_time": "2020-4-22",
              "work_time":"2020-4-22",
              "positive_time":"2020-4-22",
              "quite_time":"2020-4-22"
           },
           {
              "we_userid":"B252019000153", 
              "we_name":"员工姓名", 
              "entry_time": "2020-4-22",
              "work_time":"2020-4-22",
              "positive_time":"2020-4-22",
              "quite_time":"2020-4-22"
          }
        ]
    }

• 返回结果

    {
        "errno": 0, 
        "errmsg" : ""
    }

    {
        "errno": 0, 
        "errmsg" : "",
        "data": [
          {
              "we_userid":"B252019000153", 
              "msg" : "员工帐不存在"
          }
        ]
    }

参数	类型	说明
errno	string	0
errmsg	string
data	array	同步失败的数据