打开会话 - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

客户端API

JS-SDK

会话

打开会话

最后更新：2025/04/09

ww.openEnterpriseChat([params])

由于企业微信账号ID已全面升级，第三方应用与代开发应用必须使用应用身份进行注册，否则传入的userIds与externalUserIds将无法正确的识别。

ww.openEnterpriseChat([params])

兼容性：企业微信 2.0.0 开始支持

功能描述

打开会话。

ww.openEnterpriseChat({
  groupName: '讨论组',
  userIds: [
    'zhangsan',
    'lisi'
  ],
  externalUserIds: [
    'wmEAlECwAAHrbWYDOK5u3Bf13xlYDAAA',
    'wmEAlECwAAHibWYDOK5u3Af13xlYDAAA'
  ]
})

使用限制

内部群最多 2000 人，外部群最多 500 人
若创建的会话包含微信联系人，群成员人数不能超过 40 人
第三方应用与代开发应用必须使用应用身份进行注册

参数说明

params: Object

属性	类型	必填	说明	最低版本
groupName	string	否	会话名称，创建单聊时可以忽略
userIds	string \| string[]	否	参与会话的企业成员列表
externalUserIds	string \| string[]	否	参与会话的外部联系人列表通过 selectExternalContact 接口获得	企业微信 2.4.20
chatId	string	否	打开已有会话的 chatId 目前仅支持打开客户群，若传入则忽略其他参数使用该参数必须使用应用身份注册	企业微信 3.0.36
success	Function	否	成功回调
fail	Function	否	失败回调
cancel	Function	否	取消回调
complete	Function	否	完成回调

返回说明

Promise<Object>

属性	类型	必填	说明	最低版本
errMsg	string	是	通用错误信息
errCode	number	是	通用错误码
chatId	string	是	当前群聊 ID 使用应用身份注册的场景下返回	企业微信 3.0.36

属性

类型

必填

说明

最低版本

errMsg

string

是

通用错误信息

errCode

number

是

通用错误码

chatId

string

是

当前群聊 ID

使用应用身份注册的场景下返回

企业微信 3.0.36

旧版jweixin调用

示例代码

wx.openEnterpriseChat({
        // 注意：userIds和externalUserIds至少选填一个。内部群最多2000人；外部群最多500人；如果有微信联系人，最多40人
    userIds: 'zhangsan;lisi;wangwu',    //参与会话的企业成员列表，格式为userid1;userid2;...，用分号隔开。
    externalUserIds: 'wmEAlECwAAHrbWYDOK5u3Bf13xlYDAAA;wmEAlECwAAHibWYDOK5u3Af13xlYDAAA', // 参与会话的外部联系人列表，格式为userId1;userId2;…，用分号隔开。
    groupName: '讨论组',  // 会话名称。单聊时该参数传入空字符串""即可。
	chatId: "CHATID", // 若要打开已有会话，需指定此参数。如果是新建会话，chatId必须为空串
    success: function(res) {
		 var chatId = res.chatId; //返回当前群聊ID，仅当使用agentConfig注入该接口权限时才返回chatId
        // 回调
    },
    fail: function(res) {
        if(res.errMsg.indexOf('function not exist') > -1){
            alert('版本过低请升级')
        }
    }
});