拓冰建站拓冰建站
首页 / 资讯中心 / 正文

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

一、简要总结本文档是企业微信 iPad 协议接口 - 群操作模块的技术说明共包含26 项群全生命周期操作接口全部采用POST请求、application/json数据格式uuid 为所有接口唯一必传参数服务域名固定为[172.0.0.18083](172.0.0.18083)接口覆盖群数据查询、内外群创建、进退群管理、群基础配置、欢迎语运营、群权限 / 防骚扰 / 黑名单安全控制全场景支持分页查询、群权限精细化管控且未验证企业创建外部群仅支持 200 位外部成员。思维导图四、详细总结一通用技术规范核心项关键信息请求协议HTTP请求方法POST数据类型application/json核心必传参数uuid实例唯一标识服务地址http://172.0.0.18083/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、入群时间、邀请人 ID1.4.24 获取群详细和头像查询群基础信息 群头像 URL1.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) 添加 / 移除群黑名单按oprType1 添加 / 2 移除管理群黑名单[1.4.26.10](1.4.26.10) 批量权限控制通过newFlag枚举同时控制禁止改群名和禁止群内互加三关键枚举与状态标识外部群创建限制未验证企业→200 人外部成员上限错误码 \\-24001048\\群权限 flagflag270532609允许群邀请flag270565505禁止群邀请new_flag2允许改群名3禁止改群名newFlag 批量权限2097158关闭禁改群名 关闭禁群内互加2097159开启禁改群名 关闭禁群内互加69206022关闭禁改群名 开启禁群内互加69206023开启禁改群名 开启禁群内互加is_out1已退群0在群内四调用约束所有写操作无幂等保证重复调用会重复执行群防骚扰规则需先查 ID 再绑定至群群主专属操作解散、转让仅群主可调用群黑名单操作必须指定oprType区分添加 / 移除五、技术实现要点项目说明协议类型HTTP请求方法POST数据格式JSON内容类型ContentType: application/json身份标识uuid唯一标识一个企业微信登录实例分页机制多数接口使用limitseq序列号实现增量加载错误码规范成功errcode0失败非零值附带errmsg描述六、典型应用场景场景接口组合建议客户管理自动化获取外部联系人 修改备注 添加标签 拉黑管理智能客服系统获取好友申请 自动同意 设置欢迎语结合群接口销售团队协作共享客户 添加共享联系人 内部备注管理数据分析平台批量拉取用户信息 获取组织结构 企业互联数据同步IM 状态优化工具获取会话列表 设置置顶/免打扰/星标七、关键问题问题 1群操作接口的核心必传参数是什么分页查询有哪几种游标答案核心必传参数是uuid企业微信实例唯一标识分页游标有star_index客户群 / 会话列表、offset欢迎语、lastIndexInfo防骚扰规则三种。问题 2创建外部群聊的限制条件是什么触发限制的错误码和提示是什么答案未验证企业创建外部群仅可邀请200 位外部联系人触发限制返回错误码 \\-24001048\\提示未验证企业仅可邀请 200 位外部联系人进群验证后可继续邀请。问题 3newFlag枚举值分别对应哪些群权限组合答案2097158关闭禁止改群名 关闭禁止群内互加2097159开启禁止改群名 关闭禁止群内互加69206022关闭禁止改群名 开启禁止群内互加69206023开启禁止改群名 开启禁止群内互加
分享:

看完干货,该让你的企业上线了

免费需求沟通 · 48 小时内出具建站方案 · 河南本地可上门