# 成员管理

# 创建成员

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/create?access_token=ACCESS_TOKEN

请求包体:

{
  "staff_id": "zhangsan", 
  "name": "张三", 
  "english_name": "别名", 
  "country_code": "86", 
  "phone": "135XXXX3456", 
  "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": "工作职位", 
  "work_position_category_id":"abc23....",
  "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"
  }
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
staff_id 员工帐号,对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母。
name 成员名称,长度为1-64个字符,只能由中英文、数字和“_-@.·()()~~空格”字符组成,且只能以中英文数字开头。
english_name 别名,长度为1-64个字符,只能由中英文、数字和“_-@.·()()~~空格”字符组成,且只能以中英文数字开头。
country_code 区号,默认是86,中国大陆地区;
phone 手机号码。企业内必须唯一,不可重复;
email 邮箱。企业内必须唯一,不可重复;
department 成员所属部门id列表,不超过20个。若为空,默认归属到根部门
main_depart 成员所在的主部门,主部门必须为department列表中的一个部门。
is_leader_in_dept 个数必须和参数department的个数一致,表示在所在的部门内是否为部门负责人。1表示为部门负责人,0表示非部门负责人。
direct_leader 直属上级UserID,设置范围为企业内成员,可以设置最多5个上级。
position 职务信息。长度为0~128个字符,字符不能包括:?”<>|
work_position 岗位信息。长度为0~128个字符,字符不能包括:?”<>|
work_position_category_id 岗位分类 Id
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 员工入职日。
tel_phone 联系电话,长度为1-20个字符,只能由数字和“+ - ()()空格”字符组成,且不能以空格开头
id_card 身份证号码
extra_attr 自定义字段,可在获取自定义字段列表接口获取对应自定义id进行创建,确保有对应自定义id,否则会忽略

返回结果:

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

参数说明:

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

错误码说明(请求包体参数错误):

CODE ID 说明
1001 staff_id不能为空或staff_id不能包含特殊字符或长度大于64个字符
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 别名不能包含非法字符或者长度不能超过64
1310 身份证号格式错误或者身份证号已经被他人占用
1311 联系电话格式错误
1312 is_leader_in_dept必须为数组,且数量和department保持一致
1313 direct_leader必须为数组,且不能超过5个
1314 is_leader_in_dept和department数量不一致
1315 不可选自己为直属leader
1317 work_position_category_id错误,岗位分类不存在
1400 该乐享不允许增删成员/部门
500500 自定义字段校验错误:日期

# 更新成员

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/update?access_token=ACCESS_TOKEN

请求包体(如果非必须的字段未指定,则不更新该字段):

{
  "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": "工作职务", 
  "work_position_category_id":"abc23....",
  "gender": "1", 
  "avatar": "https://lexiangla.com/assets/ec584a005e6411e89283f5bb3d7c998b", 
  "birthday_calendar": "solar", 
  "solar_birthday_date": "2000-01-01", 
  "solar_entryday_date": "2000-01-01", 
  "tel_phone": "13339950000", 
  "id_card": "420000000000000000", 
  "extra_attr": {
    "17": "19931001", 
    "18": "无", 
    "19": "广东省深圳南山区xxxxxxxxx"
  }
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
staff_id 员工帐号,对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母,通过企业微信开通的乐享默认继承企业微信帐号,无法修改
name 成员名称,长度为1-64个字符,只能由中英文、数字和“_-@.·()()~~空格”字符组成,且只能以中英文数字开头,通过企业微信开通的乐享默认继承企业微信帐号,无法修改
english_name 别名,长度为1-64个字符,只能由中英文、数字和“_-@.·()()~~空格”字符组成,且只能以中英文数字开头,通过企业微信开通的乐享默认继承企业微信帐号,无法修改
country_code 区号,默认是86,中国大陆地区
phone 手机号码。当成员已经加入企业后不可通过接口变更,需要成员自行更改;对于已加入企业用户,此参数无效
email 邮箱。当成员已经加入企业后不可通过接口变更,需要成员自行更改;对于已加入企业用户,此参数无效
department 成员所属部门id列表,不超过20个。若值为空数组,默认归属到根部门,通过企业微信开通的乐享默认继承企业微信帐号,无法修改
main_depart 成员所在的主部门,主部门必须为department列表中的一个部门。
is_leader_in_dept 个数必须和参数department的个数一致,表示在所在的部门内是否为部门负责人。1表示为部门负责人,0表示非部门负责人。通过企业微信开通的乐享默认继承企业微信帐号,无法修改
direct_leader 直属上级UserID,设置范围为企业内成员,可以设置最多5个上级。通过企业微信开通的乐享默认继承企业微信帐号,无法修改
main_depart 成员所在的主部门,主部门必须为department列表中的一个部门,通过企业微信开通的乐享默认继承企业微信帐号,无法修改
position 职务信息。长度为0~128个字符,字符不能包括:?”<>|
work_position 岗位信息。长度为0~128个字符,字符不能包括:?”<>|
work_position_category_id 岗位分类 Id
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 员工入职日。
tel_phone 联系电话,长度为1-20个字符,只能由数字和“+ - ()()空格”字符组成,且不能以空格开头
id_card 身份证号码。
extra_attr 自定义字段,可在获取自定义字段列表接口获取对应自定义id进行创建,确保有对应自定义id,否则会忽略

返回结果:

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

参数说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 对应数据

错误码说明(请求包体参数错误):

CODE ID 说明
1001 staff_id对应用户不存在
1002 用户编辑失败
1102 birthday_calendar只能为lunar和solar
1103 department必须为数组或部门列表不能超过20
1104 entryday_date日期格式错误
1105 成员名name不能包含非法字符或者长度不能超过64
1106 性别gender只能为0,1,2
1107 职务position信息不能为空或包含特殊字符或大于128个字符
1207 职位work_position信息不能为空或包含特殊字符或大于128个字符
1108 resign_at日期格式错误
1109 该手机号已经被注册或邀请,占用的成员账号:zhangsan
1110 该邮箱已经被注册,占用的成员账号:zhangsan
1111 solar_birthday_date日期格式错误
1112 该邮箱安全域名不存在
1113 该邮箱已绑定,不可通过接口变更
1201 别名不能包含非法字符或者长度不能超过64
1202 员工已经离职
1211 该手机号码已激活,不可通过接口变更,需要成员自行更改
1310 身份证号格式错误或者身份证号已经被他人占用
1311 联系电话格式错误
1312 is_leader_in_dept必须为数组,且数量和department保持一致
1313 direct_leader必须为数组,且不能超过5个
1314 is_leader_in_dept和department数量不一致
1315 不可选自己为直属leader
1316 该乐享不允许修改 is_leader_in_dept 字段
1317 work_position_category_id错误,岗位分类不存在
1401 该乐享不允许修改任何成员字段
500500 自定义字段校验错误:日期

# 删除成员

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/resign?access_token=ACCESS_TOKEN

请求包体:

{
    "staff_id": "zhangsan"
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
staff_id 员工帐号,对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母。

返回结果:

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

删除激活和未激活成员均为成员离职,可调用离职成员重新入职接口重新入职

参数说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 对应数据

错误码说明(请求包体参数错误):

CODE ID 说明
1400 该乐享不允许增删成员/部门
3001 staff_id对应用户不存在
3003 用户已经删除,请勿重复调用

# 离职成员重新入职

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/entry?access_token=ACCESS_TOKEN

请求包体:

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

参数说明:

参数 必须 说明
access_token 调用接口凭证
staff_id 员工帐号,对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母。
department 部门id列表

返回结果:

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

参数说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 对应数据

错误码说明(请求包体参数错误):

CODE ID 说明
3001 staff_id对应用户不存在
3002 用户未离职,请确认用户状态再调用
800401 仅直接开通乐享类型可调用

接口说明:适用激活和未激活成员被删除后调用重新入职

# 禁用成员

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/forbidden?access_token=ACCESS_TOKEN

请求包体:

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

参数说明:

参数 说明
staffs 成员id,staff id数组支持多个,最多100个

返回结果:

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

参数说明:

参数 说明
data.success 成功的数组,为空则没有成功的
data.fail 失败的数组,为空则没有失败的

# 启用成员

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/active?access_token=ACCESS_TOKEN

请求包体:

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

参数说明:

参数 说明
staffs 成员id,staff id数组支持多个,最多100个

返回结果:

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

参数说明:

参数 说明
data.success 成功的数组,为空则没有成功的
data.fail 失败的数组,为空则没有失败的

# 新增超级管理员

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/add-manager?access_token=ACCESS_TOKEN

请求包体:

{
    "staff_id": "zhangsan" 
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
staff_id 员工帐号,对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母。

返回结果:

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

参数说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 对应数据

错误码说明(请求包体参数错误):

CODE ID 说明
3001 staff_id不存在
3002 staff_id对应用户未激活

# 获取单个成员信息

请求方式:GET(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/get?staff_id={staff_id}&access_token=ACCESS_TOKEN

参数说明:

参数 必须 说明
access_token 调用接口凭证
staff_id 员工帐号,对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字符。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母。

返回结果:

{
    "data": {
        "id": "zhangsan",
        "name": "张三",
        "english_name": null,
        "gender": 2,
        "avatar": "https://wework.qpic.cn/bizmail/wicgNShU5sdhFgCdAHANpOkBwJZfUlWacrYVmgWw2Ip8fJygjTL382A/100",
        "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 职务信息

错误码说明(请求入参错误):

CODE ID 说明
3001 staff_id对应用户不存在

# 获取超级管理员列表

请求方式:GET(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/managers

参数说明:

参数 必须 说明
access_token 调用接口凭证

返回结果:

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

参数说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 对应数据

# 获取某部门下的成员列表

请求方式:GET(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/list?access_token=ACCESS_TOKEN&per_page=20&page=1&department_id={department_id}&fetch_child=1 参数说明:

参数 必须 说明
access_token 调用接口凭证
page 页码
per_page 每页数,20到100
department_id 部门id
fetch_child 是否递归拉取

返回结果:

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

参数说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
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对应的自定义字段名字

错误码说明(请求入参错误):

CODE 说明
1002 该部门不存在

# 获取自定义字段列表

请求方式:GET(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/user/extra-attrs?access_token=ACCESS_TOKEN

返回结果:

{
  "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
}

参数说明:

参数 说明
data.id 自定义字段的id
data.type 表示自定义字段的类型
data.name 自定义字段的名字
data.is_required 自定义字段是否为必填,0为非必填,1则为必填

# 创建用户列表导出任务

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/export/user?access_token={access_token}

请求包体:

{
	"encoding_aeskey": "dG9kYXkreWVzdGVyZGF5K3RvbW9ycm93KzEyMzQ1xxx"
}

encoding_aeskey:明文由开发者自定义,Base64编码后的加密密钥。长度固定为43,从a-z, A-Z, 0-9共62个字符中选取,是AESKey的Base64编码。解码后即为32字节长的AESKey。加密方式采用AES-256-CBC方式,数据采用PKCS#7填充至32字节的倍数;IV初始向量大小为16字节,取AESKey前16字节,详见:https://datatracker.ietf.org/doc/html/rfc2315

AzESKey=Base64_Decode(encoding_aeskey + “=”)

参数说明:

参数 是否必须 默认值 说明
access_token 调用接口凭证
encoding_aeskey 密钥

返回结果:

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

参数说明:

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

# 添加映射关系

# 映射规则说明:

1.同一个乐享成员账号可以关联不同平台/不同数据源的账号,但同一个乐享成员账号不能同时映射相同平台&数据源的不同账号

示例:乐享用户“zhangsan”可以同时映射3个不同企微企业和1个飞书企业账号,但不能同时对应同一个企微企业的小a和小b

2:同一平台&数据源的账号不能映射多个不同乐享账号

示例:企微的小a不能同时映射乐享的zhangsan和lisi

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/add_mapping?access_token={access_token}

请求包体:

{
    "mapping_list":[
        {
            "source_id":"xxxx",
            "target_id":"zhangsan",
            "platform":"privatelark",
            "company_corp_id":"lark_cli_a67ba81c68bf500d" 
        },
        {
            "source_id":"xxxx",
            "target_id":"lisi", 
            "platform":"wecom", 
            "company_corp_id":"wp-psUDwAAp7JgmZWKcLsoH1Mvmug45A" 
        }
    ]
}

参数说明:

参数 是否必须 默认值 说明
mapping_list 映射列表对象
source_id 飞书 or 其他平台用户open_id
target_id 乐享staff_id ( 员工账号 )
platform 飞书自建应用:privatelark 企业微信:wecom
company_corp_id 飞书app_id or 企业微信企业id

返回结果:

{
    "data": {
        "added_count": 2,
        "invalid_list": []
    },
    "msg": "success",
    "code": 0
}

参数说明:

参数 说明
added_count 成功添加条数
invalid_list 无效用户列表
msg 对返回码的文本描述内容
code 返回码

错误码说明(请求包体参数错误):

CODE ID 说明
1001 插入条数为空
1002 插入条数超过最大100条限制

# 删除映射关系

请求方式:POST(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/delete_mapping?access_token={access_token}

请求包体:

[
      {
            "source_id":"xxxx",
            "target_id":"zhangsan", 
            "platform":"privatelark", 
            "company_corp_id":"lark_cli_a67ba81c68bf500d"
        },
        {
            "source_id":"xxxx",
            "target_id":"lisi", 
            "platform":"wecom", 
            "company_corp_id":"wp-psUDwAAp7JgmZWKcLsoH1Mvmug45A" 
        }
       
]


参数说明:

参数 是否必须 默认值 说明
source_id 飞书 or 其他平台用户open_id
target_id 乐享staff_id ( 员工账号 )
platform 飞书自建应用:privatelark ; 企业微信:wecom
company_corp_id 飞书app_id or 企业微信企业id

返回结果:

{
    "data": [
        {
            "source_id": "xxxx",
            "target_id": "sandxu3",
            "platform": "privatelark",
            "company_corp_id": "lark_cli_a67ba81c68bf500d",
            "deleted": true
        },
        {
            "source_id": "xxxx",
            "target_id": "sandxu3",
            "platform": "wecom",
            "company_corp_id": "wp-psUDwAAp7JgmZWKcLsoH1Mvmug45A",
            "deleted": true
        }
    ],
    "msg": "success",
    "code": 0
}

参数说明:

参数 说明
deleted 删除成功:true ;删除失败:false
msg 对返回码的文本描述内容
code 返回码

错误码说明(请求包体参数错误):

CODE ID 说明
1001 删除数据参数为空
1002 删除条数超过最大100条限制

# 映射关系列表

请求方式:GET(HTTPS)

请求地址:https://lxapi.lexiangla.com/cgi-bin/v1/contact/mapping_list?access_token={access_token}

参数说明:

参数 是否必须 默认值 说明
source_id 飞书 or 其他平台用户open_id
target_id 乐享staff_id ( 员工账号 )
platform 飞书自建应用:privatelark ; 企业微信:wecom
company_corp_id 飞书app_id or 企业微信企业id
page 1 页码
per_page 10 每页数,10到100

返回结果:

{
    "data": {
        "mapping_list": [
            {
                "source_id": "xxxx",
                "target_id": "zhangsan",
                "platform": "wecom",
                "company_corp_id": "wp-psUDwAAiO3lH0k6BNAIxz4kWd06MQ"
            },
            {
                "source_id": "xxx",
                "target_id": "lsi",
                "platform": "privatelark",
                "company_corp_id": "lark_cli_a67ba81c68bf500d"
            }
        ],
        "has_more": true
    },
    "msg": "success",
    "code": 0
}

参数说明:

参数 说明
mapping_list 映射列表对象
has_more 是否有下一页
code 返回码