成员管理

创建成员

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/create

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

{
  "staff_id": "zhangsan",
  "name": "张三",
  "phone": "13500000000",
  "english_name": "别名",
  "country_code": "86",
  "email": "xxxx@tencent.com",
  "department": [1,2,3],
  "is_leader_in_dept": [1,0,0],
  "direct_leader": ["zhangsan", "lisi"],
  "main_depart": 2,
  "position": "产品经理",
  "work_position": "工作职位",
  "gender": 1,
  "avatar": "https://lexiangla.com/assets/ec584a005e6411e89283f5bb3dxxxxxx",
  "birthday_calendar": "solar",
  "solar_birthday_date": "2000-01-01",
  "solar_entryday_date": "2000-01-01",
  "extra_attr": {
    "17": "19931125",
    "18": "0755-2548xxxx",
    "19": "广东省深圳龙岗区xxxxxxxxx"
  }
}

请求参数说明

参数	必须	说明
staff_id	是	员工帐号，对应管理端的帐号，企业内必须唯一。不区分大小写，长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。
name	是	成员名称，长度为1~150个字符
phone	是	手机号码。企业内必须唯一，不可重复
english_name	否	别名，长度为1~150个字符
country_code	否	区号，默认是86，中国大陆地区
email	否	邮箱。企业内必须唯一，不可重复
department	否	成员所属部门id列表,不超过20个。若为空，默认归属到根部门
main_depart	否	成员所在的主部门，主部门必须为department列表中的一个部门。
is_leader_in_dept	否	个数必须和参数department的个数一致，表示在所在的部门内是否为部门负责人。1表示为部门负责人，0表示非部门负责人。
direct_leader	否	直属上级staff_id，设置范围为企业内成员，可以设置最多5个上级。
position	否	职务信息。长度为0~128个字符，字符不能包括:?”<>｜
work_position	否	岗位信息。长度为0~128个字符，字符不能包括:?”<>｜
gender	否	性别。1表示男性，2表示女性。默认0表示未定义。
avatar	否	头像地址。可通过素材上传上传图片后获取资源地址
birthday_calendar	否	员工生日日历。按阳历过生日，选solar；按阴历过生日，选lunar，默认solar。需要组合solar_birthday_date使用
solar_birthday_date	否	阳历生日。过阴历生日的，也要使用出生日当天的阳历日期。 日期格式支持"yyyy-mm-dd", "yyyy/mm/dd", "yyyy年mm月dd日"，需要组合birthday_calendar使用
solar_entryday_date	否	员工入职日。日期格式支持"yyyy-mm-dd", "yyyy/mm/dd", "yyyy年mm月dd日"
extra_attr	否	自定义字段，可在获取自定义字段接口获取对应自定义id进行创建，确保有对应自定义id，否则会忽略

响应

200 Ok 状态码

{
  "data": {
    "id": "zhangsan"
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对错误码的文本描述内容
data	返回数据
data.id	创建的成员帐号

错误码说明

错误码	说明
1001	staff_id对应用户不存在
1002	name不能为空
1003	手机号不能为空
1004	该staff_id已经存在
1005	用户创建错误, 内部错误
1102	birthday_calendar只能为lunar和solar
1103	department必须为数组或部门列表不能超过20
1104	entryday_date日期格式错误
1105	成员名不能包含非法字符或者长度不能超过64
1106	性别只能为0,1,2
1107	职务信息不能为空或包含特殊字符或大于128个字符
1207	职位work_position信息不能为空或包含特殊字符或大于128个字符
1008	成员数已达到上限，如需扩容请拨打400-780-0088
1109	该手机号已经被注册或邀请，占用的成员账号：zhangsan
1110	该邮箱已经被注册，占用的成员账号：zhangsan
1111	solar_birthday_date日期格式错误
1112	该邮箱安全域名不存在
1113	该邮箱已绑定，不可通过接口变更
1201	别名长度不能超过150
1312	is_leader_in_dept必须为数组，且数量和department保持一致
1313	direct_leader必须为数组，且不能超过5个
1314	is_leader_in_dept和department数量不一致
1315	不可选自己为直属leader
1400	该乐享不允许增删成员/部门
500500	自定义字段校验错误：日期

更新成员

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/update

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

如果非必须的字段未指定，则不更新该字段

{
  "staff_id": "zhangsan", 
  "name": "张三", 
  "english_name": "别名", 
  "country_code": "86", 
  "phone": "13423805478", 
  "email":"xxxx@tencent.com",
  "department": [1,2,5], 
  "is_leader_in_dept": [1,0,0], 
  "direct_leader": ["zhangsan","lisi"], 
  "main_depart": 2, 
  "position": "产品经理", 
  "work_position": "工作职务", 
  "gender": 1, 
  "avatar": "https://lexiangla.com/assets/ec584a005e6411e89283f5bb3d7c998b", 
  "birthday_calendar": "solar", 
  "solar_birthday_date": "2000-01-01", 
  "solar_entryday_date": "2000-01-01",
  "extra_attr": {
    "17": "19931001", 
    "18": "无", 
    "19": "广东省深圳南山区xxxxxxxxx"
  }
}

请求参数说明

参数	必须	说明
staff_id	是	员工帐号
name	是	成员名称，长度为1~150个字符
english_name	否	别名，长度为1~150个字符
country_code	否	区号，
phone	否	手机号码。当成员状态变更为已激活后不可通过接口变更，需要成员自行更改
email	否	邮箱。当成员状态变更为已激活后不可通过接口变更，需要成员自行更改
department	否	成员所属部门id列表,不超过20个。若值为空数组，默认归属到根部门，通过企业微信开通的乐享默认继承企业微信帐号，无法修改
main_depart	否	成员所在的主部门，主部门必须为department列表中的一个部门。通过企业微信开通的乐享默认继承企业微信帐号，无法修改
is_leader_in_dept	否	个数必须和参数department的个数一致，表示在所在的部门内是否为部门负责人。1表示为部门负责人，0表示非部门负责人。通过企业微信开通的乐享默认继承企业微信帐号，无法修改
direct_leader	否	直属上级staff_id，设置范围为企业内成员，可以设置最多5个上级。通过企业微信开通的乐享默认继承企业微信帐号，无法修改
position	否	职务信息。长度为0~128个字符，字符不能包括:?”<>｜
work_position	否	岗位信息。长度为0~128个字符，字符不能包括:?”<>｜
gender	否	性别。1表示男性，2表示女性。默认0表示未定义
avatar	否	头像地址。可通过素材上传上传图片后获取资源地址
birthday_calendar	否	员工生日日历。按阳历过生日，选solar；按阴历过生日，选lunar。默认solar。该字段需和solar_birthday_date一起使用
solar_birthday_date	否	阳历生日。过阴历生日的，也要使用出生日当天的阳历日期。 日期格式支持"yyyy-mm-dd", "yyyy/mm/dd", "yyyy年mm月dd日"，需要组合birthday_calendar使用
solar_entryday_date	否	员工入职日。日期格式支持"yyyy-mm-dd", "yyyy/mm/dd", "yyyy年mm月dd日"
extra_attr	否	自定义字段,可在获取自定义字段接口获取对应自定义id进行创建，确保有对应自定义id，否则会忽略

响应

200 Ok 状态码

{
  "data": {
    "id": "zhangsan"
  },
  "msg": "修改成功",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对错误码的文本描述内容
data	返回数据
data.id	创建的成员帐号

错误码说明

错误码	说明
1001	staff_id对应用户不存在
1102	birthday_calendar只能为lunar和solar
1103	department必须为数组或部门列表不能超过20
1104	entryday_date日期格式错误
1105	成员名长度不能超过150
1106	性别gender只能为0,1,2
1107	职务position信息不能为空或包含特殊字符或大于128个字符
1207	职位work_position信息不能为空或包含特殊字符或大于128个字符
1109	该手机号已经被注册或邀请，占用的成员账号：zhangsan
1110	该邮箱已经被注册，占用的成员账号：zhangsan
1111	solar_birthday_date日期格式错误
1112	该邮箱安全域名不存在
1113	该邮箱已绑定，不可通过接口变更
1201	别名长度不能超过150
1202	员工已经离职
1312	is_leader_in_dept必须为数组，且数量和department保持一致
1313	direct_leader必须为数组，且不能超过5个
1314	is_leader_in_dept和department数量不一致
1315	不可选自己为直属leader
1316	该乐享不允许修改 is_leader_in_dept 字段
500500	自定义字段校验错误：日期

删除成员

此接口对应企业成员离职。成员被删除后，无法再使用乐享或接收消息推送。部分功能可能无法展示或搜索到该成员。

若需要恢复成员状态，可使用重新入职接口

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/resign

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

{
    "staff_id": "zhangsan"
}

请求参数说明

参数	必须	说明
staff_id	是	员工帐号

响应

200 Ok 状态码

{
  "data": null,
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对错误码的文本描述内容

错误码说明

错误码	说明
3001	staff_id对应用户不存在
3003	用户已经删除，请勿重复调用

重新入职

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/entry

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

{
    "staff_id": "zhangsan",
    "department": [1, 2, 3]
}

请求参数说明

参数	必须	说明
staff_id	是	离职员工帐号
department	否	指定成员重新入职后加入到哪个部门，不指定时会加入到根部门下

响应

200 Ok 状态码

{
  "data": null,
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对错误码的文本描述内容

错误码说明

错误码	说明
3001	staff_id对应用户不存在
3002	用户未离职，请确认用户状态再调用

禁用成员

成员被禁用后，无法再使用乐享或接收消息推送。站内其他成员仍能无差别看到该用户数据

若需要恢复成员状态，可使用重新启用接口

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/forbidden

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

{
  "staffs": [
    "zhangsan",
    "zz",
    "lisi"
  ]
}

请求参数说明

参数	说明
staffs	成员帐号数组，一次最多传入100个帐号

响应

200 Ok 状态码

{
  "data": {
    "success": [
      "lisi",
      "zhangsan",
      "zz"
    ],
    "fail": []
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
data.success	禁用成功的成员帐号数组
data.fail	禁用失败的成员帐号数组

重新启用

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/active

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

{
  "staffs": [
    "zhangsan",
    "zz",
    "lisi"
  ]
}

请求参数说明

参数	说明
staffs	成员帐号数组，一次最多传入100个帐号

响应

200 Ok 状态码

{
  "data": {
    "success": [
      "lisi",
      "zhangsan",
      "zz"
    ],
    "fail": []
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
data.success	启用成功的成员帐号数组
data.fail	启用失败的成员帐号数组

添加管理员

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/add-manager

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数

{
  "staff_id": "zhangsan"
}

请求参数说明

参数	必须	说明
staff_id	是	员工帐号

响应

200 Ok 状态码

{
  "data": null,
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对错误码的文本描述内容

错误码说明

错误码	说明
3001	staff_id不存在

获取成员信息

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/get

请求头

参数	是否必须	说明
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数说明

参数	必须	说明
staff_id	是	员工帐号

响应

200 Ok 状态码

{
    "data": {
        "id": "zhangsan",
        "name": "张三",
        "english_name": null,
        "gender": 2,
        "avatar": "",
        "position": "项目经理",
        "main_depart": 1,
        "is_activated": true,
        "is_resigned": false,
        "is_disabled": false,
        "department": [
            1
        ],
        "extra_attr": {
            "17": "19931125", 
    		"18": "0755-2548xxxx", 
    		"19": "广东省深圳龙岗区xxxxxxxxx"
        }
    },
    "msg": "success",
    "code": 0
}

响应参数说明

参数	说明
id	员工帐号
name	成员名称
gender	性别。
avatar	头像地址
main_depart	成员所在的主部门
is_activated	表示是否激活，用户首次登录乐享就会从未激活变成已激活，状态没法回退
is_resigned	表示是否被删除
is_disabled	表示是否禁用
department	成员所属部门id列表,不超过20个。若值为空数组，默认归属到根部门
extra_attr	自定义字段,可在获取自定义字段接口获取id对应的自定义字段名字
position	职务信息

错误码说明

错误码	说明
3001	staff_id对应用户不存在

获取部门下成员

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/list

请求头

参数	是否必须	说明
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

请求参数说明

参数	必须	说明
department_id	是	部门id
page	否	页码
per_page	否	每页返回条数，最大1000
fetch_child	否	是否返回包含子部门下的成员，1表示包含；0表示不包含

响应

200 Ok 状态码

{
  "has_more": true,
  "user_list": [
    {
      "name": "张三",
      "gender": 0,
      "avatar": "",
      "staff_id": "zhangsan",
      "extra_attr": {
        "17": "19931125",
        "18": "0755-2548xxxx",
        "19": "广东省深圳龙岗区xxxxxxxxx"
      },
      "departments": [
        {
          "id": 100,
          "name": "开发组"
        }
      ]
    },
    {
      "name": "李四",
      "gender": 1,
      "avatar": "",
      "staff_id": "LX008",
      "extra_attr": {
        "17": "19931125",
        "18": "0755-2548xxxx",
        "19": "广东省深圳龙岗区xxxxxxxxx"
      },
      "departments": [
        {
          "id": 1,
          "name": "深圳有限公司"
        }
      ]
    }
  ],
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对返回码的文本描述内容
has_more	为true表示返回数据不全，可继续拉取下一页
user_list	成员列表
user_list[].staff_id	员工帐号
user_list[].name	成员名称。
user_list[].gender	性别。1表示男性，2表示女性。默认0表示未定义。
user_list[].avatar	头像地址。可通过多媒体上传接口上传图片后获取资源地址
user_list[].departments	用户所在部门列表
user_list[].extra_attr	自定义字段,可在获取自定义字段接口获取id对应的自定义字段名字

错误码说明

错误码	说明
1002	该部门不存在

获取管理员列表

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/managers

请求头

参数	是否必须	说明
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

响应

200 Ok 状态码

{
  "data": [
    {
      "staff_id": "LX001",
      "name": "zhangsan"
    },
    {
      "staff_id": "LX007",
      "name": "lisi"
    }
  ],
  "msg": "success",
  "code": 0
}

响应参数说明

参数	说明
code	返回码
msg	对返回码的文本描述内容
data	管理员列表数据
data[].staff_id	成员帐号
data[].name	成员姓名

获取自定义字段

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/extra-attrs

请求头

参数	是否必须	说明
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	3000次/分钟

响应

200 Ok 状态码

{
  "data": [
    {
      "id": 17,
      "name": "工号",
      "is_required": 1,
      "type": "text"
    },
    {
      "id": 18,
      "name": "座机",
      "is_required": 0,
      "type": "text"
    },
    {
      "id": 19,
      "name": "住址",
      "is_required": 0,
      "type": "text"
    }
  ],
  "msg": "success",
  "message": "success",
  "code": 0
}

响应参数说明

参数	说明
code	错误码
msg	对返回码的文本描述内容
data	自定义字段列表
data[].id	自定义字段的id
data[].type	表示自定义字段的类型
data[].name	自定义字段的名字
data[].is_required	自定义字段是否为必填，0为非必填，1则为必填

获取所有成员信息

此接口仅创建异步导出任务，开发者需轮询任务状态直到任务完成后，可下载得到 json 文件，解密后可得到当前租户所有非删除成员信息

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/export/user

请求头

参数	是否必须	说明
Content-Type	是	固定值："application/json; charset=utf-8"
Authorization	是	接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项	说明
权限要求	通讯录管理
频率限制	10次/分钟

请求参数

{
	"aeskey": "123456789012345678901234567890ab"
}

请求参数说明

参数	是否必须	默认值	说明
aeskey	是	无	加密密钥。生成的文件内容会使用此密钥经过AES-256-CBC加密，企业需使用此密钥解密内容 密钥必须32位长度，字符从a-z, A-Z, 0-9共62个字符中选取 参考文件解密

响应

200 Ok 状态码

{
    "data": {
        "job_id": "b8e809fe933c11ee997a56b4feeefxxx"
    },
    "msg": "success",
    "code": 0
}

响应参数说明

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载json文件

文件解密内容示例

[
    {
        "staff_id": "LX001",
        "name": "张三",
        "gender": 1,
        "avatar": "https://lexiangla.com/assets/xxx",
        "departments": [
            1,
            2
        ]
    },
    {
        "staff_id": "livlin",
        "name": "林淋",
        "gender": 2,
        "avatar": "https://lexiangla.com/assets/xxx",
        "departments": [
            1
        ]
    }
]

参数说明

参数	说明
staff_id	成员帐号
name	姓名
gender	性别。1表示男性，2表示女性。默认0表示未定义。
avatar	头像地址。若地址是乐享域名的资源，可通过素材下载下载图片
departments	成员所属部门ID