目录
兼容性:企业微信 iOS、Android、PC 3.1.8 开始支持
创建企业互联/上下游会话。
ww.createCorpGroupChat({
groupName: '讨论组',
userIds: ['lisi', 'lisi2'],
openUserIds: ['wabc3', 'wbcde'],
externalUserIds: ['exid1', 'exid2'],
corpGroupUserIds: [
{
corpId: 'ww3333',
userId: 'userid123',
openUserId: 'wx1111'
},
{
corpId: 'ww4444',
userId: 'userid123',
openUserId: 'wx1111'
}
]
})
本接口必须使用应用身份进行注册
企业必须开启互联群功能
仅局校互联和上下游企业可调用
当前成员必须在应用的可见范围
群成员人数不能超过 2000 人
如果创建的会话有外部联系人,群成员人数不能超过 40 人
当前成员为下游企业成员时,需要打开上下游空间中的“允许外部单位之间互相查看”配置,群成员中才可以包含其他下游企业成员
属性 | 类型 | 必填 | 说明 | 最低版本 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
groupName | string | 否 | 会话名称 创建单聊时可以忽略 | ||||||||||||||||||||||
userIds | string[] | 否 | 参与会话的企业成员列表 使用限制 仅自建应用使用 | ||||||||||||||||||||||
openUserIds | string[] | 否 | 参与会话的企业成员列表 使用限制 仅第三方应用使用 | ||||||||||||||||||||||
externalUserIds | string[] | 否 | 参与会话的外部联系人列表 使用限制 与发起人需要有好友关系 | 企业微信 3.1.20 | |||||||||||||||||||||
corpGroupUserIds | Object[] | 否 | 参与会话的互联企业成员列表 | 企业微信 3.1.20 | |||||||||||||||||||||
| |||||||||||||||||||||||||
success | Function | 否 | 成功回调 | ||||||||||||||||||||||
fail | Function | 否 | 失败回调 | ||||||||||||||||||||||
cancel | Function | 否 | 取消回调 | ||||||||||||||||||||||
complete | Function | 否 | 完成回调 |
Promise<Object>
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
errMsg | string | 是 | 通用错误信息 | |
errCode | number | 是 | 通用错误码 | |
chatId | string | 是 | 创建的群聊 ID |
errMsg | 说明 |
---|---|
createCorpGroupChat:ok | 执行成功 |
createCorpGroupChat:fail no permission | 应用签名校验失败 |
createCorpGroupChat:fail exceed user id list size | 超过人数上限 |
createCorpGroupChat:fail invalid parameter | 参数不合法 |
createCorpGroupChat:fail need open corp group chat | 企业未开启企业互联群功能 |
createCorpGroupChat:fail exceed external user id list size | 超过包含外部联系人群人数上限 |
wx.invoke("createCorpGroupChat", {
groupName: "讨论组", // 必填,会话名称。单聊时该参数传入空字符串""即可。
userIds: ["lisi","lisi2"], //参与会话的企业成员列表,仅自建应用使用,第三方应用会忽略该字段
openUserIds: ["wabc3","wbcde"],// 参与会话的企业成员列表,仅第三方应用使用,自建应用会忽略该字段
externalUserIds:["exid1", "exid2"], // 外部联系人id
corpGroupUserIds: [ // 非必填, 参与会话的互联企业/上下游成员列表
{
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 == "createCorpGroupChat:ok") {
var chatId = res.chatId;
}
}
);