appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
"we_xxxxxxxxxxxxxxx"创建客户群。只需 appid。返回 roomId 与入群邀请链接。
/qingluan/api/room/create创建客户群。只需 appid。返回 roomId 与入群邀请链接。
:::tip 🔗 调用关系
创建客户群 → 保存 roomId → 使用群资料或群管理接口继续配置。 :::
:::check ✅ 成功判定:HTTP 200 且响应体 code = 0。业务失败请查看 message 与 detail。 :::
请求体必填。通过 QL-Key 请求头携带 APIKey。
Content-Type:application/json
请求参数。字段名区分大小写,请按文档原样传递。
appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
"we_xxxxxxxxxxxxxxx"userListinteger[]可选建群时一并拉进来的成员 ID 列表。可选:接口定义里没有登记这个字段,经平台验证传了它能正常建群;不传则建一个只有自己的群。
数组元素 · integer
本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。
仅对查询接口可读的群资料,用获取群资料核对;部分设置开关需要在企业微信客户端确认,具体以本页说明为准。
能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。
application/json
接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。
codeinteger必填业务状态码
业务状态码:0 表示成功,-1 表示失败;失败原因见 message。
0dataobject可选业务数据
业务返回数据;字段结构见下方定义。
inviteUrlstring可选入群邀请链接
titlestring可选标题
标题。用于链接、小程序、朋友圈等卡片展示。
descstring可选描述内容。用于联系人、链接、卡片或朋友圈场景。
avatarUrlstring可选头像 URL
roomIdint64可选群聊 ID
群聊 ID。可从创建群、群列表、群详情或回调事件中获取。
extraobject可选平台返回的群聊扩展信息。未明确的 field* 字段建议原样保留。
roomIdint64可选群聊 ID
群聊 ID。可从创建群、群列表、群详情或回调事件中获取。
field2string可选平台保留字符串字段 2。
operatorVidint64可选执行创建操作的成员 VID。
createTimeint64可选创建时间戳(秒)
field5int64可选平台保留数值字段 5。
field6int64可选平台保留数值字段 6。
field8int64可选平台保留数值字段 8。
roomKeystring可选群聊内部密钥标识;属于敏感透传字段,请勿公开。
field11int64可选平台保留数值字段 11。
typeint64可选类型
设备类型,如 iPad
field22int64可选平台保留数值字段 22。
detailstring可选错误详情
错误详情;无补充信息时通常为空字符串。
messagestring必填响应消息
业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息。
"ok"timestring必填服务端时间
服务端时间,格式为 YYYY-MM-DD HH:mm:ss。
"2026-07-21 07:33:17"受控接口,需通过控制台配置
appid 不存在或无权访问