第三方应用开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
第三方应用开发
客户端API
JS-SDK
企业通讯录
企业互联/上下游选人接口
企业互联/上下游选人接口
最后更新:2025/04/09

目录

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

    兼容性:企业微信 iOS、Android、PC 3.1.6 开始支持

    功能描述

    企业互联/上下游选人

    ww.selectCorpGroupContact({
      fromDepartmentId: -1,
      mode: 'single',
      type: ['department', 'user'],
      selectedDepartmentIds: ['2','3'],
      selectedUserIds: ['lisi','lisi2'],
      selectedOpenUserIds: ['wabc3','wbcde'],
      selectedChainDepartmentIds: [
        {
          corpId: 'ww3333',
          departmentId: '2'
        },
        {
          corpId: 'ww4444',
          departmentId: '3'
        }
      ],
      selectedChainUserIds: [
        {
          corpId: 'ww3333',
          userId: 'userid123',
          openUserId: 'wx1111'
        },
        {
          corpId: 'ww4444',
          userId: 'userid123',
          openUserId: 'wx1111'
        }
      ],
      selectedCorpGroupDepartmentIds: [
        {
          corpId: 'ww3333',
          departmentId: '2'
        },
        {
          corpId: 'ww4444',
          departmentId: '3'
        }
      ],
      selectedCorpGroupUserIds: [
        {
          corpId: 'ww3333',
          userId: 'userid123',
          openUserId: 'wx1111'
        },
        {
          corpId: 'ww4444',
          userId: 'userid123',
          openUserId: 'wx1111'
        }
      ]
    })

    使用限制

    • 本接口必须使用应用身份进行注册

    • 该接口仅可选择应用可见范围内的成员和部门

    参数说明

    params: Object

    属性类型必填说明最低版本
    fromDepartmentIdnumber

    从指定的部门开始展示

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

    • 0 表示从最上层开始

    移动端,当需要展开的部门不在应用可见范围内,则从应用的可见范围开始展开

    modestring

    选择模式

    合法值说明
    single

    单选

    multi

    多选

    typestring[]

    选择限制类型,指定一个或者多个

    合法值说明
    department

    选择部门

    user

    选择成员

    selectedDepartmentIdsstring[]

    已选部门 ID 列表,用于多次选人时可重入

    selectedUserIdsstring[]

    已选用户 ID 列表,用于多次选人时可重入 仅自建应用使用,第三方应用会忽略该字段

    selectedOpenUserIdsstring[]

    已选用户 OpenUserID 列表,用于多次选人时可重入 仅第三方应用使用,自建应用会忽略该字段

    selectedChainDepartmentIdsObject[]

    已选上下游部门列表,用于多次选人时可重入

    企业微信 3.1.20

    属性类型必填说明
    corpIdstring

    Corp ID

    departmentIdstring

    部门 ID

    selectedChainUserIdsObject[]

    已选上下游用户列表,用于多次选人时可重入

    企业微信 3.1.20

    属性类型必填说明
    corpIdstring

    Corp ID

    userIdstring

    成员 ID

    openUserIdstring

    成员 OpenUserID

    selectedCorpGroupDepartmentIdsObject[]

    已选企业互联部门列表,用于多次选人时可重入

    属性类型必填说明
    corpIdstring

    Corp ID

    departmentIdstring

    部门 ID

    selectedCorpGroupUserIdsObject[]

    已选企业互联用户列表

    属性类型必填说明
    corpIdstring

    Corp ID

    userIdstring

    成员 ID

    openUserIdstring

    成员 OpenUserID

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    resultObject
    属性类型必填说明最低版本
    departmentListObject[]

    已选的部门列表

    属性类型必填说明
    idstring

    部门 ID

    userListObject[]

    已选的成员列表

    属性类型必填说明
    idstring

    成员 ID,仅自建应用返回

    openUserIdstring

    成员 OpenUserID,仅第三方应用返回

    corpGroupDepartmentListObject[]

    已选企业互联部门列表

    属性类型必填说明
    corpIdstring

    Corp ID

    idstring

    部门 ID

    corpGroupUserListObject[]

    已选企业互联用户列表

    属性类型必填说明
    corpIdstring

    Corp ID

    idstring

    成员 ID,仅自建应用返回

    openUserIdstring

    成员 OpenUserID,仅第三方应用返回

    chainDepartmentListObject[]

    已选上下游部门列表

    企业微信 3.1.20

    属性类型必填说明
    corpIdstring

    Corp ID

    idstring

    部门 ID

    chainUserListObject[]

    已选上下游用户列表

    企业微信 3.1.20

    属性类型必填说明
    corpIdstring

    Corp ID

    idstring

    成员 ID,仅自建应用返回

    openUserIdstring

    成员 OpenUserID,仅第三方应用返回

    使用说明

    自建应用调用该接口时userid返回的是企业内部的userid,对于服务商该字段返回的是open_userid,同一个服务商,不同应用获取到企业内同一个成员的open_userid是相同的,最多64个字节

    错误信息

    errMsg说明
    selectCorpGroupContact:ok执行成功
    selectCorpGroupContact:fail no permission应用身份鉴权失败

    旧版jweixin调用

    代码示例

    wx.invoke("selectCorpGroupContact", {
          fromDepartmentId: -1,// 必填,表示打开的通讯录从指定的部门开始展示,-1表示打开的通讯录从自己所在部门开始展示, 0表示从最上层开始。移动端,当需要展开的部门不在应用可见范围内,则从应用的可见范围开始展开。
          mode: "single",// 必填,选择模式,single表示单选,multi表示多选
          type: ["department", "user"],// 必填,选择限制类型,指定department、user中的一个或者多个
          selectedDepartmentIds: ["2","3"],// 非必填,已选部门ID列表。用于多次选人时可重入
          selectedUserIds: ["lisi","lisi2"],// 非必填,仅自建应用使用,第三方应用会忽略该字段,已选用户ID列表。用于多次选人时可重入
    	  selectedOpenUserIds: ["wabc3","wbcde"],// 非必填,仅第三方应用使用,自建应用会忽略该字段,已选用户ID列表。用于多次选人时可重入
          selectedChainDepartmentIds: [		// 非必填,已选上下游部门ID列表。用于多次选人时可重入
              {
                  corpId:"ww3333",				 // 企业CORPID
                  departmentId:"2"				 // 部门ID
              },
    		  {
                  corpId:"ww4444",				// 企业CORPID
                  departmentId:"3"				// 部门ID
              }
          ],
          selectedChainUserIds: [ // 非必填,已选上下游用户ID列表。用于多次选人时可重入
              {
                  corpId:"ww3333",				 // 企业CORPID
    			  userId:"userid123",				 // 成员ID,仅自建应用返回
    			  openUserId:"wx1111"				 // 成员OPEN_USERID,仅第三方应用返回
              },
    		  {
                  corpId:"ww4444",				// 企业CORPID
    			  userId:"userid123",				 // 成员ID,仅自建应用返回
    			  openUserId:"wx1111"				 // 成员OPEN_USERID,仅第三方应用返回
              }
          ],
          selectedCorpGroupDepartmentIds: [		// 非必填,已选企业互联部门ID列表。用于多次选人时可重入
              {
                  corpId:"ww3333",				 // 企业CORPID
               	  departmentId:"2"				 // 部门ID
              },
    		  {
                  corpId:"ww4444",				// 企业CORPID
               	  departmentId:"3"				// 部门ID
              }
          ],
          selectedCorpGroupUserIds: [ // 非必填,已选企业互联用户ID列表。用于多次选人时可重入
              {
                  corpId:"ww3333",				 // 企业CORPID
    			  userId:"userid123",				 // 成员ID,仅自建应用返回
    			  openUserId:"wx1111"				 // 成员OPEN_USERID,仅第三方应用返回
              },
    		  {
                  corpId:"ww4444",				// 企业CORPID
    			  userId:"userid123",				 // 成员ID,仅自建应用返回
    			  openUserId:"wx1111"				 // 成员OPEN_USERID,仅第三方应用返回
              }
          ]
          },function(res){
                    if (res.err_msg == "selectCorpGroupContact: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 selectedUserList = res.result.userList; // 已选的成员列表
                    for (var i = 0; i < selectedUserList.length; i++)
                    {
    						var user = selectedUserList[i];
                            var userid = user.id; // 已选的单个成员ID,仅自建应用返回
    						var openUserId = user.openUserId; // 已选的单个成员ID,仅第三方应用返回
                    }
                   var selectedCorpGroupDepartmentList = res.result.corpGroupDepartmentList;// 已选的部门列表
                   for (var i = 0; i < selectedCorpGroupDepartmentList.length; i++)
                   {
                             var corpGroupDepartment = selectedCorpGroupDepartmentList[i];
                        	var corpId = corpGroupDepartment.corpId; // 企业CORPID
                            var departmentId = corpGroupDepartment.id;// 已选的单个部门ID
                   }
               		var selectedCorpGroupUserList = res.result.corpGroupUserList; // 已选的已选企业互联成员列表
                    for (var i = 0; i < selectedGroupUserList.length; i++)
                    {
                           var corpGroupUser = selectedCorpGroupUserList[i];
                        	var corpId = corpGroupUser.corpId; // 企业CORPID
                            var userId = corpGroupUser.id; // 已选的单个成员ID,仅自建应用返回
    						var openUserId = corpGroupUser.openUserId; // 已选的单个成员ID,仅第三方应用返回
                    }
    			   var selectedChainDepartmentList = res.result.chainDepartmentList;// 已选的部门列表
                   for (var i = 0; i < selectedChainDepartmentList.length; i++)
                   {
                            var chainDepartment = selectedChainDepartmentList[i];
                        	var corpId = chainDepartment.corpId; // 企业CORPID
                            var departmentId = chainDepartment.id;// 已选的单个部门ID
                   }
    			   var selectedChainUserList = res.result.chainUserList; // 已选的已选企业互联成员列表
                    for (var i = 0; i < selectedCorpGroupUserList.length; i++)
                    {
                            var chainUser = selectedCorpGroupUserList[i];
                        	var corpId = chainUser.corpId; // 企业CORPID
                            var userId = chainUser.id; // 已选的单个成员ID,仅自建应用返回
    						var openUserId = chainUser.openUserId; // 已选的单个成员ID,仅第三方应用返回
                    }
            }
    		}
    );
    
    上一篇打开个人信息页接口
    下一篇返回ticket的选人接口
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们