当前位置：首页 > news >正文

【企业微信】iPad协议开发客户群操作API设计：支持群生命周期全流程管理与精细化权限控制

news 2026/8/14 17:31:12

一、简要总结

本文档是企业微信 iPad 协议接口 - 群操作模块的技术说明，共包含26 项群全生命周期操作接口，全部采用POST请求、application/json数据格式，uuid 为所有接口唯一必传参数，服务域名固定为[172.0.0.1：8083](172.0.0.1：8083)，接口覆盖群数据查询、内外群创建、进退群管理、群基础配置、欢迎语运营、群权限 / 防骚扰 / 黑名单安全控制全场景，支持分页查询、群权限精细化管控，且未验证企业创建外部群仅支持 200 位外部成员。

思维导图

四、详细总结

（一）通用技术规范

核心项	关键信息
请求协议	HTTP
请求方法	POST
数据类型	application/json
核心必传参数	uuid（实例唯一标识）
服务地址	http://172.0.0.1：8083/wxwork/
统一返回结构	{"errcode":int,"errmsg":"ok","data":{}/[]/null}
分页参数	star_index、offset、lastIndexInfo

（二）接口功能分类（共 26 项）

1. 群数据查询接口（7 项）

1.4.1 获取客户群列表：分页拉取客户群，返回room_id、群名、成员总数、群头像

1.4.2 获取群成员列表：按roomid查询全量成员，返回群公告、防骚扰规则 ID、群权限标识

1.4.3 获取会话列表中的群聊：筛选会话列表内的群聊数据

1.4.23 获取群成员列表简洁版：精简成员信息，仅保留uin、入群时间、邀请人 ID

1.4.24 获取群详细和头像：查询群基础信息 + 群头像 URL

1.4.25 获取群头像：单独获取群头像链接

1.4.16 获取群二维码：返回群二维码图片存储地址

2. 群创建接口（2 项）

1.4.6 创建内部群聊：传入内部成员vids+ 群名，快速创建内部群

1.4.7 创建外部群聊：支持内外成员混合建群；未验证企业仅可邀请 200 位外部联系人，触发限制返回错误码 \\-24001048\\

3. 进群 / 邀请 / 退群接口（8 项）

1.4.4 同意进群：通过邀请链接url加入群聊

1.4.5 二维码进群：通过二维码解析code入群

1.4.10 链接邀请成员：生成邀请链接，拉指定vids进群

1.4.11 直接邀请进群：直接拉指定vids入群

1.4.12 移除群成员：按roomid + 批量 vids移除成员

1.4.22 退出群聊：主动退出指定群

1.4.15 解散群：群主权限解散指定群

1.4.21 添加群成员好友：在群内直接添加成员为好友

4. 群基础管理接口（6 项）

1.4.9 修改群名：按roomid更新群名称

[1.4.26.1](1.4.26.1) 设置群备注：修改群本地备注

1.4.8 发送群公告：推送群公告至指定群

1.4.13 设置群内昵称：修改自身群内显示名称

1.4.14 转让群主：将群主权限转移给指定vid

[1.4.26.4/5](1.4.26.4/5) 设置 / 移除群管理：批量配置 / 撤销群管理员

5. 群运营配置接口（4 项）

1.4.17 获取欢迎语列表：分页查询群欢迎语模板

1.4.18 添加欢迎语：创建文字 + 链接型欢迎语模板

1.4.19 设置欢迎语：为指定群绑定欢迎语模板

1.4.20 取消欢迎语：解除指定群的欢迎语配置

6. 群权限与安全接口（10 项）

[1.4.26.2](1.4.26.2) 禁止修改群名：控制群名编辑权限

[1.4.26.3](1.4.26.3) 群邀请确认：开启 / 关闭群邀请需人工确认

[1.4.26.6](1.4.26.6) 获取群防骚扰规则：查询企业级防骚扰规则列表

[1.4.26.7](1.4.26.7) 设置 / 移除群防骚扰规则：为群绑定 / 解绑防骚扰规则

[1.4.26.8](1.4.26.8) 获取群聊黑名单：分页查询群内拉黑成员

[1.4.26.9](1.4.26.9) 添加 / 移除群黑名单：按oprType=1 添加 / 2 移除管理群黑名单

[1.4.26.10](1.4.26.10) 批量权限控制：通过newFlag枚举，同时控制禁止改群名和禁止群内互加

（三）关键枚举与状态标识

外部群创建限制：未验证企业→200 人外部成员上限，错误码 \\-24001048\\

群权限 flag：

flag=270532609：允许群邀请

flag=270565505：禁止群邀请

new_flag=2：允许改群名；3：禁止改群名

newFlag 批量权限：

2097158：关闭禁改群名 + 关闭禁群内互加

2097159：开启禁改群名 + 关闭禁群内互加

69206022：关闭禁改群名 + 开启禁群内互加

69206023：开启禁改群名 + 开启禁群内互加

is_out：1已退群，0在群内

（四）调用约束

所有写操作无幂等保证，重复调用会重复执行

群防骚扰规则需先查 ID 再绑定至群

群主专属操作（解散、转让）仅群主可调用

群黑名单操作必须指定oprType区分添加 / 移除

五、技术实现要点

项目	说明
协议类型	HTTP
请求方法	POST
数据格式	JSON
内容类型	ContentType: application/json
身份标识	uuid唯一标识一个企业微信登录实例
分页机制	多数接口使用limit+seq（序列号）实现增量加载
错误码规范	成功：errcode=0；失败：非零值，附带errmsg描述

六、典型应用场景

场景	接口组合建议
客户管理自动化	获取外部联系人 + 修改备注 + 添加标签 + 拉黑管理
智能客服系统	获取好友申请 + 自动同意 + 设置欢迎语（结合群接口）
销售团队协作	共享客户 + 添加共享联系人 + 内部备注管理
数据分析平台	批量拉取用户信息 + 获取组织结构 + 企业互联数据同步
IM 状态优化工具	获取会话列表 + 设置置顶/免打扰/星标