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

目录

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

    ww.selectPrivilegedContact(params)

    兼容性:企业微信 3.1.8 开始支持

    功能描述

    返回 ticket 的选人接口。

    用于第三方应用唤起选择企业通讯录成员,用户选择的范围区分成两部分回传给第三方应用:

    1. 过滤应用可见范围后的 openUserId 列表

    2. 完整列表的 ticket,ticket 后续可用于创建群聊 或者发送模板消息

    ww.selectPrivilegedContact({
      fromDepartmentId: -1,
      mode: 'multi',
      selectedContextContact: 1
      selectedOpenUserIds: ['xxx', 'yyy'],
      selectedTickets: ['ticket1', 'ticket2']
    })

    使用限制

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

    • 仅第三方应用(非通讯录应用)可调用

    参数说明

    params: Object

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

    从指定的部门开始展示

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

    • 0 表示从最上层开始

    modestring

    选择模式

    合法值说明
    single

    单选

    multi

    多选

    selectedContextContactboolean

    是否勾选当前环境的参与者

    例如在群「+」号打开,默认勾选当前群成员

    selectedOpenUserIdsstring

    已选用户 OpenID 列表

    仅在 mode 为 multi 时支持

    企业微信 3.1.12

    selectedTicketsstring[]

    已选Ticket列表

    仅在 mode 为 multi 时支持

    企业微信 3.1.12

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    resultObject

    当调用成功时返回,对应用户选择的内容

    属性类型必填说明
    selectedTicketstring

    对应用户的选择集合凭证

    expiresInnumber

    ticket 的有效时长

    单位为秒,默认为 7 天

    selectedUserCountstring

    选择的用户数

    userListObject[]

    选择的可见范围内的用户列表

    属性类型必填说明
    openUserIdstring

    旧版jweixin调用

    示例代码

    wx.invoke("selectPrivilegedContact", {
    				"fromDepartmentId": -1,// 必填,表示打开的通讯录从指定的部门开始展示,-1表示自己所在部门开始, 0表示从最上层开始
    				"mode": "multi",// 必填,选择模式,single表示单选,multi表示多选
    				"selectedContextContact": 1	// 是否勾选当前环境的参与者。例如在群+号聊天附件栏打开,默认勾选当前群成员。
    				"selectedOpenUserIds"["xxx","yyy"], // 非必填,已选用户OpenID列表。single模式忽略该参数。
    				"selectedTickets"["ticket1","ticket2"] // 非必填,已选ticket列表。single模式忽略该参数
            },function(res){
                    if (res.err_msg == "selectPrivilegedContact:ok")
                    {
                            var selectedUserList = res.result.userList; // 已选的成员列表
                            for (var i = 0; i < selectedUserList.length; i++)
                            {
                                    var openUserId = selectedUserList[i].openUserId; //成员openUserId
                            }
                            var selectedTicket = res.result.selectedTicket;	// 已选的集合Ticket
                            var expiresIn = res.result.expiresIn;	// ticket有效期
                            var selectedUserCount = res.result.selectedUserCount;	// 用户选中的用户个数
                    }
            }
    );
    上一篇企业互联/上下游选人接口
    下一篇认领老师班级
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们