【企业通信】基于IPAD协议的企业微信群聊管理API:群操作功能接口设计与实现
本文档详细梳理了企业微信iPad协议的26类群操作接口含群设置下10个子接口所有接口均采用POST请求方式、ContentType为application/jsonuuid为各接口必传的实例唯一标识接口涵盖群聊的查询、创建、成员管理、群设置、欢迎语管理、防骚扰及黑名单操作等全流程能力请求地址均为http://172.0.0.1:8083/wxwork/后接接口名部分接口存在分页查询、状态码标识权限如flag270532609放开群邀请、270565505禁止、企业验证限制未验证企业外部群仅可邀200人等关键规则返回结果均以errcode和errmsg标识请求状态0为成功。思维导图功能文档https://wechatapi.apifox.cn/https://wechatapi.apifox.cn/四、详细总结本文档为企业微信iPad协议接口的群操作功能说明共包含26个核心接口其中群设置模块下分10个子接口所有接口遵循统一的基础请求规则按功能可分为6大类各接口均有专属请求参数、返回格式及业务规则以下为详细梳理一接口基础通用规则所有群操作接口均满足以下通用要求为核心基础配置请求方式统一为POST请求头ContentType固定为application/json必传参数uuidString类型每个实例的唯一标识用于指定操作的企业微信实例请求地址根地址为http://47.94.7.218:9952/wxwork/后拼接各接口专属名称返回结果统一包含errcode错误码0表示请求成功和errmsg错误信息成功为ok业务数据封装在data字段中。二群查询类接口共6个接口用于获取群聊、群成员、群信息等各类数据部分接口支持分页查询关键标识字段用于区分群状态/权限具体信息如下表接口名称接口地址后缀核心功能关键参数/规则关键返回字段/标识获取客户群列表GetChatroomMembers分页查询客户群列表limit每次查询数量、star_index分页起始值首次为0total总数量、next_start下一页起始值、room_id群ID获取群成员列表GetRoomUserList查询指定群的完整成员信息roomid群ID必传flag270532609放开群邀请、270565505禁止new_flag3禁止改群名、2放开is_out1已退群、0未退群获取会话列表中的群聊GetSessionRoomList分页查询会话列表中的群聊limit、star_index分页参数room_list群聊列表、seq序列值获取群成员列表简洁版GetRoomDesUserList查询指定群的精简成员信息roomid群ID必传仅返回成员核心标识uin、jointime等无详细资料获取群详细和头像GetRoomInfo查询指定群的完整信息头像roomid群ID必传image_url群头像地址、is_out1退群/0未退群获取群头像WxRoomHeader单独查询指定群的头像roomid群ID必传image_url群头像地址三群创建类接口共2个接口分内部/外部群聊创建外部群存在企业验证人数限制具体信息创建内部群聊CreateRoomNei核心参数vids成员ID数组、roomName群名关键返回roomid新建群ID、createTime创建时间戳。创建外部群聊CreateRoomWx核心参数vids成员ID数组、roomName群名关键限制未验证企业仅可邀请200位外部联系人进群验证后无此限制超出返回错误码-24001048关键返回roomid新建群ID部分返回为字符串类型。五群成员操作类接口共8个接口覆盖成员进群、邀请、移除、加好友、退群等全流程操作部分接口需传入邀请链接/二维码解析码具体同意进群AgreeAddRoom传入邀请进群的url返回状态如InviteTicketExpired邀请码过期二维码进群AgreeCardAddRoom传入群二维码解析后的code链接结尾部分成功返回status:Success邀请进群分链接邀请InvitationToRoomLink和直接邀请InvitationToRoom均传入roomid和vids被邀请人ID数组移除群成员DelRoomUsers传入roomid和vids被移除人ID数组添加群成员好友AddRoomFriends传入roomid、vid目标成员ID、content加好友备注退出群聊OutRoomReq传入roomid返回msg_id消息ID。五群基础设置接口共6个接口用于群聊基础运营操作涵盖公告、群名、昵称、群主、解散、二维码等均需传入roomid指定群聊发送群公告SendNotice额外传入msg公告内容修改群名UpdateRoomName额外传入roomname新群名返回修改后的群名和群ID设置群内昵称SetMyRoomName额外传入content群内新昵称转让群主TransferChatroomOwner额外传入vid新群主ID解散群DissolutionRoom仅传入roomid即可执行解散获取群二维码WxRoomInvite返回QrCodePath二维码图片地址服务器地址拼接。六欢迎语管理接口共4个接口实现群欢迎语的查询、添加、设置、取消支持纯文字/文字链接形式的欢迎语获取欢迎语列表GetWelcomeMsgList分页参数offset首次为空、limit返回WelocomeMsgList欢迎语列表含id欢迎语ID、type类型默认2、content欢迎语内容支持#客户昵称#变量添加欢迎语AddWelcomeMsg传入list文字片段数组、url链接可选、title/content/headImg链接配套信息支持纯文字/文字链接形式返回id新添加欢迎语ID设置欢迎语SetWelcomeMsg传入roomid、indexid欢迎语ID、type默认2为指定群绑定欢迎语取消欢迎语DelWelcomeMsg传入roomid取消指定群的欢迎语绑定。七高级群设置接口共10个子接口为群聊精细化管理功能涵盖群备注、权限控制、群管理、防骚扰、黑名单等部分接口有专属状态码/操作类型核心信息如下表接口名称接口地址后缀核心功能关键参数/规则关键数字/标识设置群备注RoomnameRemarkReq为指定群设置备注roomid、content备注内容无禁止修改群名DisableRenameChatroom开关群名修改权限roomid、status布尔值控制开关无群邀请确认SetChatroomInvite开关群邀请确认权限roomid、status布尔值控制开关无移除群管理DelRoomAdmins移除群管理员roomid、vids管理员ID数组无设置群管理AddRoomAdmins添加群管理员roomid、vids管理员ID数组无获取群防骚扰规则列表queryCRMAntiSpamRule分页查询防骚扰规则lastIndexInfo首次为空is_endtrue表示查询完成、id防骚扰规则ID设置/移除群防骚扰规则setRoomAnti为群绑定/移除防骚扰规则roomid、antiIds规则ID数组追加需带原有ID规则ID从获取群成员接口的anti_spam_rules获取获取群聊黑名单列表getRoomBlackList分页查询群黑名单pageBuf首次为空、limit、keywordis_endtrue表示查询完成、blacklist_vid黑名单ID添加/移除群聊黑名单addOrSubRoomBlackList操作群黑名单oprType1添加/2移除、blacklist_vidID数组oprType为核心操作标识禁改群名禁群内添加setRoomManagement批量设置群名修改群内添加权限roomid、newFlag状态码控制双权限2097159禁改群名放开添加69206022放开改群名禁添加69206023双禁2097158双放开四、关键问题问题1企业微信iPad协议群操作接口的通用请求规则有哪些核心点答案所有群操作接口均为POST请求ContentType固定为application/jsonuuid是所有接口的必传参数为企业微信实例的唯一标识请求根地址为http://127.0.0.1:8083/wxwork/返回结果以errcode0标识成功对应errmsgok业务数据在data字段中。问题2创建企业微信外部群聊时有哪些关键限制超出限制会有什么反馈答案未验证的企业创建外部群聊时仅可邀请200位外部联系人进群完成企业验证后该限制解除若超出200人限制接口会返回错误码-24001048错误信息为“未验证企业仅可邀请200位外部联系人进群验证后可继续邀请”。问题3通过setRoomManagement接口批量设置群名修改和群内成员添加权限时不同权限组合对应的newFlag状态码分别是什么答案该接口通过newFlag整型状态码控制双权限4种组合对应码值为1.开启禁止修改群名关闭禁止群内添加20971592.开启禁止群内添加关闭禁止修改群名692060223.同时开启禁止修改群名和禁止群内添加692060234.同时关闭禁止修改群名和禁止群内添加2097158。