青鸾QINGLUAN
控制台

开启/关闭入群确认

开启/关闭入群确认。⚠️ 该开关的当前状态无法通过任何只读接口读回,需要在企业微信客户端「群设置」里确认。top / saveToContact / forbidMutualAdd / forbidRename / setAdmin 同此。

POST/qingluan/api/room/inviteConfirm

接口说明

开启/关闭入群确认。⚠️ 该开关的当前状态无法通过任何只读接口读回,需要在企业微信客户端「群设置」里确认。top / saveToContact / forbidMutualAdd / forbidRename / setAdmin 同此。

请求参数

请求体必填。通过 QL-Key 请求头携带 APIKey。

Content-Type:application/json

请求参数。字段名区分大小写,请按文档原样传递。

appidstring必填

青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。

字段示例:"we_xxxxxxxxxxxxxxx"
roomIdint64必填

群聊 ID

群 ID。取自「创建群聊」「查询我的客户群」。注意查询接口返回的是字符串,回传时需转整数。

字段示例:1970000000000001
enableboolean必填

true = 开启,false = 关闭。

字段示例:false

响应与结果确认

本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。

仅对查询接口可读的群资料,用获取群资料核对;部分设置开关需要在企业微信客户端确认,具体以本页说明为准。

响应字段与 HTTP 状态

HTTP 200

能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。

application/json

查看响应字段定义

接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。

codeinteger必填

业务状态码

业务状态码:0 表示成功,-1 表示失败;失败原因见 message

字段示例:0
dataobject可选

业务数据

接口无固定结构化返回数据;成功时通常为空对象或省略 data

注意:恒为 null。无回调、无回读,code=0 是唯一信号且可信度存疑(。段)。

detailstring可选

错误详情

错误详情;无补充信息时通常为空字符串。

messagestring必填

响应消息

业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息

字段示例:"ok"
timestring必填

服务端时间

服务端时间,格式为 YYYY-MM-DD HH:mm:ss

字段示例:"2026-07-21 07:33:17"

HTTP 403

受控接口,需通过控制台配置

HTTP 404

appid 不存在或无权访问

搜索接口

输入关键词查找接口。最多显示 20 项。