创建群聊 - API接口文档

功能说明：

本接口可以指定托管账号创建群聊，并将企业微信员工和客户拉群群聊中

📌

使用userId进行建群时，无法保证当前企业下该userId仅在一个微信组内托管了一次，如果以当前userId查到了不止一个托管账号，则会报错。

创建群聊时 unionIds 和 externalUserId 联系人组合的总人数应位于2～40之间，两个参数可以共存。

请求参数

Query 参数

token

string

调用接口凭证

必需

示例值:

Body 参数application/json

botUserId

string

建群托管账号的企业微信userId

必需

userIds

array[string]

拉入成员的企业微信员工userId

必需

unionIds

array[string]

拉入客户的开放平台unionId

可选

name

string

建群后新的群的名字

必需

greeting

string

建群后的欢迎语

必需

externalUserIds

array[string]

拉入客户的企业微信外部联系人externalUserId

必需

banChangeName

boolean

是否禁止修改群名

可选

可选项，当传入且为true的时候，会将创建出来的群设置成不可修改群名（仅对企微生效）

onlyBot

boolean

是否仅使用bot自身创建群聊

必需

示例

{
  "botUserId": "string",
  "userIds": [
    "string"
  ],
  "unionIds": [
    "string"
  ],
  "name": "string",
  "greeting": "string",
  "externalUserIds": [
    "string"
  ],
  "banChangeName": true,
  "onlyBot": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer

返回码

必需

1 无效token 2 无效参数 -1 未找到对应的群聊 -2 未找到对应的bot -3 找到的bot数量多于1 -4 bot非企微类型 -5 bot不在线或未同步完数据 500 创建群聊异常

errmsg

string

必需

data

object

必需

chatId

string

企微群id

必需

roomWxid

string

系统群聊id

必需

示例

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "chatId": "66027d08bd25acec2fb62d4b",
    "roomWxid": "R:10737747932809007"
  }
}