第三方应用开发 客户端API JS-SDK 会话 创建企业互联/上下游会话
创建企业互联/上下游会话

创建企业互联/上下游会话接口

 

示例代码:


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;
		}
	}
);
调用前提:
此接口仅在企业微信3.1.8及以后版本支持
必须先成功调用agentConfig,否则调用时会报“no permission”错误
企业必须开启互联群功能
仅限局校互联和上下游企业可调用
当前成员必须在应用的可见范围。
如果创建的会话有外部联系人,群成员人数不能超过40人
上下游及外部联系人仅企业微信3.1.20及以后版本支持
群人数不能超过2000人

 

参数

Object object
参数名类型必填说明
groupNameString会话名称。单聊时该参数传入空字符串""即可
userIdsArray否(userIds和corpGroupUserIds.userid至少填一个)参与会话的企业成员列表,仅自建应用使用,第三方应用会忽略该字段
openUserIdsArray否(openUserIds和corpGroupUserIds.openUserIds至少填一个)参与会话的企业成员列表,仅第三方应用使用,自建应用会忽略该字段
externalUserIdsArray参与会话的外部联系人列表,与发起人需要有好友关系,没有好友关系的成员会被忽略
corpGroupUserIdsArray否(userIds和corpGroupUserIds至少填一个)参与会话的互联企业成员列表
corpGroupUserIds.corpIdString企业互联/上下游企业corpId
corpGroupUserIds.userIdString否(corpGroupUserIds.userId和corpGroupUserIds.openUserId至少填一个)企业互联/上下游企业成员userId, 仅自建应用使用
corpGroupUserIds.openUserIdString否(corpGroupUserIds.userId和corpGroupUserIds.openUserId至少填一个)企业互联/上下游企业成员openUserId,仅第三方应用使用
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数

 

返回结果

Object object
参数名类型说明
res.chatIdString创建的群聊id

错误列表

res.err_msg说明
createCorpGroupChat:ok执行成功
createCorpGroupChat:fail no permission必须先成功调用agentConfig
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超过包含外部联系人群人数上限
上一篇
私密消息
下一篇
变更企业互联群成员