第三方应用开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
第三方应用开发
客户端API
JS-SDK
企业通讯录
选择通讯录成员
选择通讯录成员
最后更新:2025/03/27

目录

  • ww.selectEnterpriseContact(params)
  • 功能描述
  • 参数说明
  • params: Object
  • 返回说明
  • 旧版jweixin调用
  • 示例代码
  • ww.selectEnterpriseContact(params)

    兼容性:企业微信 1.3.11 开始支持,微信 iOS、Android 6.5.10 开始支持

    功能描述

    选择通讯录成员。

    ww.selectEnterpriseContact({
      fromDepartmentId: -1,
      mode: 'multi',
      type: ['department', 'user'],
      selectedDepartmentIds: ['2', '3'],
      selectedUserIds: ['lisi', 'lisi2']
    })

    参数说明

    params: Object

    属性类型必填说明
    fromDepartmentIdnumber

    从指定的部门开始展示

    • -1 表示从自己所在部门开始

    • 0 表示从最上层开始

    modestring

    选择模式

    合法值说明
    single

    单选

    multi

    多选

    typestring[]

    选择限制类型

    指定 department、user 中的一个或者多个

    合法值说明
    department

    选择部门

    user

    选择成员

    selectedDepartmentIdsstring[]

    已选部门 ID 列表

    selectedUserIdsstring[]

    已选用户 ID 列表

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    resultObject
    属性类型必填说明
    departmentListObject[]

    已选的部门列表

    属性类型必填说明
    idstring

    部门 ID

    namestring

    部门名称,从2019年12月30日起,对新创建第三方应用不再返回,2020年6月30日起,对所有历史第三方应用不再返回,第三方页面需要通过通讯录展示组件来展示名字。

    userListObject[]

    已选的成员列表

    属性类型必填说明
    idstring

    成员 ID

    namestring

    成员名称,从2019年12月30日起,对新创建第三方应用不再返回,2020年6月30日起,对所有历史第三方应用不再返回,第三方页面需要通过通讯录展示组件来展示名字。

    avatarstring

    成员头像,从2019年12月30日起,对新创建第三方应用不再返回,2020年6月30日起,对所有历史第三方应用不再返回,第三方页面需要通过通讯录展示组件来展示名字。

    旧版jweixin调用

    示例代码

    wx.invoke("selectEnterpriseContact", {
                    "fromDepartmentId": -1,// 必填,表示打开的通讯录从指定的部门开始展示,-1表示自己所在部门开始, 0表示从最上层开始
                    "mode": "multi",// 必填,选择模式,single表示单选,multi表示多选
                    "type": ["department", "user"],// 必填,选择限制类型,指定department、user中的一个或者多个
                    "selectedDepartmentIds": ["2","3"],// 非必填,已选部门ID列表。用于多次选人时可重入,single模式下请勿填入多个id
                    "selectedUserIds": ["lisi","lisi2"]// 非必填,已选用户ID列表。用于多次选人时可重入,single模式下请勿填入多个id
            },function(res){
                    if (res.err_msg == "selectEnterpriseContact:ok")
                    {
                            if(typeof res.result == 'string')
                            {
                                    res.result = JSON.parse(res.result) //由于目前各个终端尚未完全兼容,需要开发者额外判断result类型以保证在各个终端的兼容性
                            }
                            
                            var selectedDepartmentList = res.result.departmentList;// 已选的部门列表
                            for (var i = 0; i < selectedDepartmentList.length; i++)
                            {
                                    var department = selectedDepartmentList[i];
                                    var departmentId = department.id;// 已选的单个部门ID
                                    var departemntName = department.name;// 已选的单个部门名称
                            }
                            var selectedUserList = res.result.userList; // 已选的成员列表
                            for (var i = 0; i < selectedUserList.length; i++)
                            {
                                    var user = selectedUserList[i];
                                    var userId = user.id; // 已选的单个成员ID
                                    var userName = user.name;// 已选的单个成员名称
                                    var userAvatar= user.avatar;// 已选的单个成员头像
                            }
                    }
            }
    );
    
    上一篇创建企业微信登录面板
    下一篇打开个人信息页接口
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们