server/htsy-skill
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: correct htsy API field types, names, and CLI examples

Browse Source
This commit is contained in:
dcsunny
2026-07-02 09:29:31 +08:00
parent 1f4a00a0b0
commit 7d9f09c0bf
8 changed files with 92 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
htsy/references/api-group.md
+23 -19
View File
@@ -17,11 +17,11 @@
| 手动同步某个群的成员 | `POST /api/wx/group/member/sync` | `groupId`(int64, 必填，群id)；`botId`(int64, 可选，如果有botid则为指定机器人同步)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
| 同步群列表 | `POST /api/wx/group/manualSync` | `botIds`(repeated int64, 必填，机器人id列表)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
| 同步群信息 | `POST /api/wx/group/syncGroupInfo` | `groupIds`(repeated int64, 必填，群id列表)；`botType`(int32, 必填，类型 1 个微 2企微)；`botId`(int64, 可选，微号id) | 空对象或无业务数据 |
| 获取某个微号的微信群 | `POST /api/wx/group/list/byBot` | `botId`(int64, 必填，群id)；`page`(int64, 必填，分页page)；`pageSize`(int64, 必填，分页pagesize)；`groupName`(string, 可选，群名字)；`groupType`(string, 可选，群类型)；`botType`(int32, 必填，类型 1 个微 2企微)；`corpId`(string, 可选，主体id)；`isManager`(bool, 可选，是否是管理员) | `list`(repeated HttpGroupInfoReply)；`page`(int64)；`pageSize`(int64)；`total`(int64)；`last`(bool) |
| 获取某个微号的微信群 | `POST /api/wx/group/list/byBot` | `botId`(int64, 必填，微号id)；`page`(int64, 必填，分页page)；`pageSize`(int64, 必填，分页pagesize)；`groupName`(string, 可选，群名字)；`groupType`(string, 可选，群类型)；`botType`(int32, 必填，类型 1 个微 2企微)；`corpId`(string, 可选，主体id)；`isManager`(bool, 可选，是否是管理员) | `list`(repeated HttpGroupInfoReply)；`page`(int64)；`pageSize`(int64)；`total`(int64)；`last`(bool) |
| 群详情 | `POST /api/wx/group/info` | `groupId`(int64, 必填，群id)；`botType`(int32, 必填，类型 1 个微 2企微) | `id`(int64，群id)；`nickname`(string，群昵称)；`avatar`(string，头像)；`totalMember`(int64，成员数)；`manager`(GroupManager，管理员)；`categoryInfo`(CategoryItem，分组信息)；`wxid`(string，群微信id)；`groupType`(string，群类型 qw 企微群 wx个微群)；`status`(int32，群状态 0正常 1 封禁)；`corpIds`(repeated string，属于的主体) |
| 根据群ids获取部分列表 | `POST /api/wx/group/list/byIds` | `ids`(repeated int64, 必填，群id列表)；`groupName`(string, 可选，群名字)；`groupType`(string, 可选，群类型)；`botType`(int32, 必填，类型 1 个微 2企微) | `list`(repeated HttpGroupInfoReply) |
| 分组-添加 | `POST /api/wx/group/category/add` | `name`(string, 必填，分组的名字)；`botType`(int32, 必填，类型 1 个微 2企微)；`corpId`(string, 必填，主体id) | `id`(int64，id) |
| 分组-列表 | `POST /api/wx/group/category/list` | `page`(int64, 可选，page)；`pageSize`(int64, 可选，pageSize)；`name`(string, 可选，分组名字)；`ids`(repeated int64, 可选，分子ids)；`botType`(int32, 必填，类型 1 个微 2企微)；`corpId`(string, 必填，主体id) | `list`(repeated CategoryItem，分组列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last) |
| 分组-列表 | `POST /api/wx/group/category/list` | `page`(int64, 可选，page)；`pageSize`(int64, 可选，pageSize)；`name`(string, 可选，分组名字)；`ids`(repeated int64, 可选，分组ids)；`botType`(int32, 必填，类型 1 个微 2企微)；`corpId`(string, 必填，主体id) | `list`(repeated CategoryItem，分组列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last) |
| 分组-删除 | `POST /api/wx/group/category/del` | `id`(int64, 必填，分组id)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
| 分组-更新 | `POST /api/wx/group/category/update` | `id`(int64, 必填，分组id)；`name`(string, 必填，分组名字)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
| 分组-新增分组内的群 | `POST /api/wx/group/category/addGroup` | `id`(int64, 必填，分组id)；`groupIds`(repeated int64, 必填，组内-群id列表)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
@@ -87,11 +87,11 @@
| 批量群邀请-预估人数 | `POST /api/wx/group/batchInviteJoinPlan/predictPeople` | `botType`(int32, 必填，微号类型)；`filters`(repeated TargetFilter, 必填，客户的筛选类型)；`botList`(repeated SenderBot, 必填，机器人ids)；`useBlacklist`(bool, 可选，是否使用黑名单)；`targetType`(string, 可选，推送对象 friend 客户 qwMember 企微成员)；`targetRequireType`(string, 可选，specify 指定某些用户 filter 筛选 all 全部)；`targetIds`(repeated int64, 可选，指定成员Ids) | `predictPeople`(int64，预估人数) |
| 批量群邀请-失败计划的客户重发 | `POST /api/wx/group/batchInviteJoinPlan/copyFailPlan` | `planId`(int64, 必填，失败计划) | 空对象或无业务数据 |
| 批量群邀请-固定成员进群记录 | `POST /api/wx/group/batchInviteJoinPlan/fixedRecord/list` | `planId`(int64, 必填，计划id)；`page`(int64, 必填，分页page)；`pageSize`(int64, 必填，分页pagesize)；`status`(string, 可选，状态)；`memberId`(int64, 可选，企微成员id)；`inviterId`(int64, 可选，邀请人botId) | `list`(repeated FixedMemberRecord，记录)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 接受群邀请-受邀记录 | `POST /api/wx/group/inviteJoin/list` | `cfgId`(int64, 可选，方案id)；`page`(int64, 必填，page)；`pageSize`(int64, 必填，pageSize)；`botId`(int64, 可选，机器人id)；`statusList`(repeated int64, 可选，状态筛选)；`fromName`(string, 可选，邀请者名字)；`botType`(int64, 可选，所属类型:1个微 2 企微) | `list`(repeated GroupInviteItem，组内群列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last) |
| 接受群邀请-受邀记录 | `POST /api/wx/group/inviteJoin/list` | `cfgId`(int64, 可选，方案id)；`page`(int64, 必填，page)；`pageSize`(int64, 必填，pageSize)；`botId`(int64, 可选，机器人id)；`statusList`(repeated int64, 可选，状态筛选)；`fromName`(string, 可选，邀请者名字)；`botType`(int32, 可选，所属类型:1个微 2 企微) | `list`(repeated GroupInviteItem，受邀记录列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last) |
| 接受群邀请-操作 | `POST /api/wx/group/inviteJoin/operate` | `id`(int64, 必填，邀请加入群聊的id)；`agree`(bool, 必填，是否同意 true同意， false拒绝) | 空对象或无业务数据 |
| 接受群邀请-获取方案配置 | `POST /api/wx/group/inviteJoin/conf` | `id`(int64, 可选) | `timeInterval`(int64，通过的时间间隔)；`disturb`(bool，是否打扰 false 免打扰 true 打扰)；`fold`(bool，是否折叠 true 折叠 false 不折叠)；`auto`(bool，是否自动通过 true 自动 false 不自动)；`joinGroupInvitePassCondition`(JoinGroupInviteCondition，通过条件)；`id`(int64，id)；`name`(string，方案名字)；`botIds`(repeated int64，使用的机器人ids)；`default`(bool，是否是默认方案)；`botType`(int32，类型 1 个微 2企微)；... |
| 接受群邀请-获取方案配置列表 | `POST /api/wx/group/inviteJoin/conf/list` | `botType`(int32, 可选，微号类型)；`botId`(int64, 可选，微号id) | `list`(repeated JoinGroupInviteConf，方案配置) |
| 接受群邀请-修改方案配置 | `POST /api/wx/group/inviteJoin/conf/modify` | `timeInterval`(int64, 必填，通过的时间间隔)；`disturb`(bool, 必填，是否打扰 false 免打扰 true 打扰)；`fold`(bool, 必填，是否折叠 true 折叠 false 不折叠)；`auto`(bool, 必填，是否自动通过 true 自动 false 不自动)；`joinGroupInvitePassCondition`(JoinGroupInviteCondition, 必填，通过条件)；`name`(string, 必填，方案名字)；`botIds`(repeated int64, 必填，使用的机器人ids)；`id`(int64, 必填，id)；`botType`(int64, 必填，botType) | 空对象或无业务数据 |
| 接受群邀请-修改方案配置 | `POST /api/wx/group/inviteJoin/conf/modify` | `timeInterval`(int64, 必填，通过的时间间隔)；`disturb`(bool, 必填，是否打扰 false 免打扰 true 打扰)；`fold`(bool, 必填，是否折叠 true 折叠 false 不折叠)；`auto`(bool, 必填，是否自动通过 true 自动 false 不自动)；`joinGroupInvitePassCondition`(JoinGroupInviteCondition, 必填，通过条件)；`name`(string, 必填，方案名字)；`botIds`(repeated int64, 必填，使用的机器人ids)；`id`(int64, 必填，id)；`botType`(int32, 必填，botType) | 空对象或无业务数据 |
| 接受群邀请-创建方案配置 | `POST /api/wx/group/inviteJoin/conf/create` | `timeInterval`(int64, 必填，通过的时间间隔)；`disturb`(bool, 必填，是否打扰 false 打扰 true 免打扰)；`fold`(bool, 必填，是否折叠 true 折叠 false 不折叠)；`auto`(bool, 必填，是否自动通过 true 自动 false 不自动)；`joinGroupInvitePassCondition`(JoinGroupInviteCondition, 必填，通过条件)；`name`(string, 必填，方案名字)；`botIds`(repeated int64, 必填，使用的机器人ids) | `id`(int64，创建id) |
| 接受群邀请-删除方案配置(默认的无法删除) | `POST /api/wx/group/inviteJoin/conf/del` | `id`(int64, 必填，方案id) | 空对象或无业务数据 |
| 接受群邀请-手动排序 | `POST /api/wx/group/inviteJoin/conf/updatePosition` | `sourceId`(int64, 必填，移动方案id)；`targetId`(int64, 必填，目标方案id) | 空对象或无业务数据 |
@@ -104,18 +104,18 @@
| 群公告计划-删除 | `POST /api/wx/group/announcement/plan/del` | `id`(int64, 必填，id) | 空对象或无业务数据 |
| 群公告计划-方案记录列表 | `POST /api/wx/group/announcement/plan/record/list` | `pid`(int64, 必填，方案id) | `list`(repeated GroupAnnouncementPlanRecordItem) |
| 群公告计划-方案记录 | `POST /api/wx/group/announcement/plan/record/item/list` | `pid`(int64, 必填，方案id)；`recordId`(int64, 必填，方案记录id)；`page`(int64, 必填，page)；`pageSize`(int64, 必填，分页pagesize)；`status`(string, 必填，状态)；`botWxid`(string, 必填，机器人wxid)；`groupWxid`(string, 必填，群wxid) | `list`(repeated HttpGroupAnnouncementPlanRecordItemListItem，list)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 群查重-计划创建 | `POST /api/wx/group/duplicate/plan/create` | `id`(int64, 可选，id)；`name`(string, 必填，计划昵称)；`groupIds`(repeated int64, 必填，群ids)；`friendIds`(repeated int64, 可选，不参与查重的客户)；`isAddBlacklist`(bool, 可选，是否拉黑)；`isKickingMember`(bool, 可选，是否踢人)；`kickInterval`(int64, 可选，踢人间隔 单位秒)；`botId`(int64, 可选，踢人拉黑的执行微号)；`Schedule`(Schedule, 可选，定时)；`scheduleType`(string, 必填，delay quick)；`targetType`(string, 必填，groupMember 群成员 bot 微号 inGroupSystemBot 在群微号查重)；`specifyWxids`(repeated string, 可选，指定查重的对象)；`botType`(int32, 必填，类型 1 个微 2企微) | `id`(int64，id)；`name`(string，计划昵称)；`groupIds`(repeated int64，群ids)；`friendIds`(repeated int64，不参与查重的客户)；`isAddBlacklist`(bool，是否拉黑)；`isKickingMember`(bool，是否踢人)；`kickInterval`(int64，踢人间隔)；`botId`(int64，踢人拉黑的执行微号)；`Schedule`(Schedule，定时)；`scheduleType`(string，delay quick)；... |
| 群查重-计划创建 | `POST /api/wx/group/duplicate/plan/create` | `id`(int64, 可选，id)；`name`(string, 必填，计划昵称)；`groupIds`(repeated int64, 必填，群ids)；`friendIds`(repeated int64, 可选，不参与查重的客户)；`isAddBlacklist`(bool, 可选，是否拉黑)；`isKickingMember`(bool, 可选，是否踢人)；`kickInterval`(int64, 可选，踢人间隔 单位秒)；`botId`(int64, 可选，踢人拉黑的执行微号)；`schedule`(Schedule, 可选，定时)；`scheduleType`(string, 必填，delay quick)；`targetType`(string, 必填，groupMember 群成员 bot 微号 inGroupSystemBot 在群微号查重)；`specifyWxids`(repeated string, 可选，指定查重的对象)；`botType`(int32, 必填，类型 1 个微 2企微) | `id`(int64，id)；`name`(string，计划昵称)；`groupIds`(repeated int64，群ids)；`friendIds`(repeated int64，不参与查重的客户)；`isAddBlacklist`(bool，是否拉黑)；`isKickingMember`(bool，是否踢人)；`kickInterval`(int64，踢人间隔)；`botId`(int64，踢人拉黑的执行微号)；`schedule`(Schedule，定时)；`scheduleType`(string，delay quick)；... |
| 群查重-计划列表 | `POST /api/wx/group/duplicate/plan/list` | `name`(string, 可选，名字)；`page`(int64, 可选，page)；`pageSize`(int64, 可选，pageSize)；`id`(string, 可选，从指定的id开始获取offset条计划，为空从头开始)；`offset`(string, 可选，分页大小，id offset都为空则查全部)；`botType`(int32, 可选，类型 1 个微 2企微) | `list`(repeated DuplicatePlanInfo，列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last)；`nextId`(string，查询下一页时的起始id) |
| 群查重-计划更新 | `POST /api/wx/group/duplicate/plan/update` | `id`(int64, 可选，id)；`name`(string, 必填，计划昵称)；`groupIds`(repeated int64, 必填，群ids)；`friendIds`(repeated int64, 可选，不参与查重的客户)；`isAddBlacklist`(bool, 可选，是否拉黑)；`isKickingMember`(bool, 可选，是否踢人)；`kickInterval`(int64, 可选，踢人间隔 单位秒)；`botId`(int64, 可选，踢人拉黑的执行微号)；`Schedule`(Schedule, 可选，定时)；`scheduleType`(string, 必填，delay quick)；`targetType`(string, 必填，groupMember 群成员 bot 微号 inGroupSystemBot 在群微号查重)；`specifyWxids`(repeated string, 可选，指定查重的对象)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
| 群查重-计划更新 | `POST /api/wx/group/duplicate/plan/update` | `id`(int64, 可选，id)；`name`(string, 必填，计划昵称)；`groupIds`(repeated int64, 必填，群ids)；`friendIds`(repeated int64, 可选，不参与查重的客户)；`isAddBlacklist`(bool, 可选，是否拉黑)；`isKickingMember`(bool, 可选，是否踢人)；`kickInterval`(int64, 可选，踢人间隔 单位秒)；`botId`(int64, 可选，踢人拉黑的执行微号)；`schedule`(Schedule, 可选，定时)；`scheduleType`(string, 必填，delay quick)；`targetType`(string, 必填，groupMember 群成员 bot 微号 inGroupSystemBot 在群微号查重)；`specifyWxids`(repeated string, 可选，指定查重的对象)；`botType`(int32, 必填，类型 1 个微 2企微) | 空对象或无业务数据 |
| 群查重-计划删除 | `POST /api/wx/group/duplicate/plan/del` | `id`(int64, 可选，id) | 空对象或无业务数据 |
| 群查重-计划详情 | `POST /api/wx/group/duplicate/plan/info` | `id`(int64, 可选，id) | `id`(int64，id)；`name`(string，计划昵称)；`groupIds`(repeated int64，群ids)；`friendIds`(repeated int64，不参与查重的客户)；`isAddBlacklist`(bool，是否拉黑)；`isKickingMember`(bool，是否踢人)；`kickInterval`(int64，踢人间隔)；`botId`(int64，踢人拉黑的执行微号)；`Schedule`(Schedule，定时)；`scheduleType`(string，delay quick)；... |
| 群查重-计划详情 | `POST /api/wx/group/duplicate/plan/info` | `id`(int64, 可选，id) | `id`(int64，id)；`name`(string，计划昵称)；`groupIds`(repeated int64，群ids)；`friendIds`(repeated int64，不参与查重的客户)；`isAddBlacklist`(bool，是否拉黑)；`isKickingMember`(bool，是否踢人)；`kickInterval`(int64，踢人间隔)；`botId`(int64，踢人拉黑的执行微号)；`schedule`(Schedule，定时)；`scheduleType`(string，delay quick)；... |
| 群查重-计划记录 | `POST /api/wx/group/duplicate/plan/record` | `pid`(int64, 可选，id)；`page`(int64, 可选，page)；`pageSize`(int64, 可选，pageSize) | `list`(repeated DuplicatePlanRecordItem)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last)；`status`(string，状态)；`failReason`(string，失败原因)；`listByGroup`(repeated DuplicatePlanRecordItemByGroup，targetType:inGroupSystemBot 有值)；`targetType`(string，groupMember 群成员 bot 微号 inGroupSystemBot 在群微号查重) |
| 群查重-踢人或者拉黑 | `POST /api/wx/group/duplicate/plan/record/kickOrBlacklist` | `recordId`(repeated int64, 必填，记录id)；`type`(string, 必填，kick 踢 blacklist 拉黑)；`botId`(int64, 必填，指定微号，不然就到各各群里拿管理员，拉黑只会拿一个)；`isKeepOn`(bool, 可选，踢出时是否保留一个群不踢) | 空对象或无业务数据 |
| 群查重-退出或者踢出单个群 | `POST /api/wx/group/duplicate/plan/record/kickOrQuit` | `recordItemId`(repeated int64, 必填，记录id)；`type`(string, 必填，kick 踢 quit 退出)；`botId`(int64, 必填，指定微号，不然就到各各群里拿管理员) | 空对象或无业务数据 |
| 入群欢迎语-添加 | `POST /api/wx/group/welcome/add` | `id`(int64, 可选，id)；`name`(string, 必填，名称)；`botType`(int64, 必填，1个微 2企微)；`botIds`(repeated int64, 必填，应用微号)；`groupIds`(repeated int64, 必填，应用客户群)；`ruleList`(repeated Rule, 可选，触发规则)；`replyList`(repeated Message, 必填，回复内容)；`replyMode`(string, 必填，回复模式 fixed 固定 random 随机)；`newReplyList`(repeated ReplyItem, 必填，新的回复内容结构) | `id`(int64，id) |
| 群查重-踢人或者拉黑 | `POST /api/wx/group/duplicate/plan/record/kickOrBlacklist` | `recordId`(repeated int64, 必填，记录id)；`type`(string, 必填，kick 踢 blacklist 拉黑)；`botId`(int64, 必填，指定微号，不然就到各个群里拿管理员，拉黑只会拿一个)；`isKeepOn`(bool, 可选，踢出时是否保留一个群不踢) | 空对象或无业务数据 |
| 群查重-退出或者踢出单个群 | `POST /api/wx/group/duplicate/plan/record/kickOrQuit` | `recordItemId`(repeated int64, 必填，记录id)；`type`(string, 必填，kick 踢 quit 退出)；`botId`(int64, 必填，指定微号，不然就到各个群里拿管理员) | 空对象或无业务数据 |
| 入群欢迎语-添加 | `POST /api/wx/group/welcome/add` | `id`(int64, 可选，id)；`name`(string, 必填，名称)；`botType`(int32, 必填，1个微 2企微)；`botIds`(repeated int64, 必填，应用微号)；`groupIds`(repeated int64, 必填，应用客户群)；`ruleList`(repeated Rule, 可选，触发规则)；`replyList`(repeated Message, 必填，回复内容)；`replyMode`(string, 必填，回复模式 fixed 固定 random 随机)；`newReplyList`(repeated ReplyItem, 必填，新的回复内容结构) | `id`(int64，id) |
| 入群欢迎语-列表 | `POST /api/wx/group/welcome/list` | `page`(int64, 必填，page)；`pageSize`(int64, 必填，分页pagesize)；`userId`(int64, 可选，userid)；`name`(string, 可选，名称搜索)；`botType`(int32, 可选，类型 1 个微 2企微) | `list`(repeated GroupWelcomeItem，方案列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 入群欢迎语-详情 | `POST /api/wx/group/welcome/info` | `id`(int64, 必填，id) | `id`(int64，id)；`name`(string，名称)；`botType`(int64，1个微 2企微)；`botIds`(repeated int64，应用微号)；`groupIds`(repeated int64，应用客户群)；`ruleList`(repeated Rule，触发规则)；`replyList`(repeated Message，回复内容)；`replyMode`(string，回复模式 fixed 固定 random 随机)；`newReplyList`(repeated ReplyItem，新的回复内容结构) |
| 入群欢迎语-更新 | `POST /api/wx/group/welcome/update` | `id`(int64, 可选，id)；`name`(string, 必填，名称)；`botType`(int64, 必填，1个微 2企微)；`botIds`(repeated int64, 必填，应用微号)；`groupIds`(repeated int64, 必填，应用客户群)；`ruleList`(repeated Rule, 可选，触发规则)；`replyList`(repeated Message, 必填，回复内容)；`replyMode`(string, 必填，回复模式 fixed 固定 random 随机)；`newReplyList`(repeated ReplyItem, 必填，新的回复内容结构) | 空对象或无业务数据 |
| 入群欢迎语-详情 | `POST /api/wx/group/welcome/info` | `id`(int64, 必填，id) | `id`(int64，id)；`name`(string，名称)；`botType`(int32，1个微 2企微)；`botIds`(repeated int64，应用微号)；`groupIds`(repeated int64，应用客户群)；`ruleList`(repeated Rule，触发规则)；`replyList`(repeated Message，回复内容)；`replyMode`(string，回复模式 fixed 固定 random 随机)；`newReplyList`(repeated ReplyItem，新的回复内容结构) |
| 入群欢迎语-更新 | `POST /api/wx/group/welcome/update` | `id`(int64, 可选，id)；`name`(string, 必填，名称)；`botType`(int32, 必填，1个微 2企微)；`botIds`(repeated int64, 必填，应用微号)；`groupIds`(repeated int64, 必填，应用客户群)；`ruleList`(repeated Rule, 可选，触发规则)；`replyList`(repeated Message, 必填，回复内容)；`replyMode`(string, 必填，回复模式 fixed 固定 random 随机)；`newReplyList`(repeated ReplyItem, 必填，新的回复内容结构) | 空对象或无业务数据 |
| 入群欢迎语-删除 | `POST /api/wx/group/welcome/del` | `id`(int64, 必填，id) | 空对象或无业务数据 |
| 群守卫-添加 | `POST /api/wx/group/guard/plan/add` | `botType`(int32, 必填，类型 1 个微 2企微)；`name`(string, 必填，名称)；`botId`(int64, 必填，应用微号:单个)；`groupIds`(repeated int64, 必填，应用客户群:多个)；`timeFrame`(TimeFrame, 必填，生效时间段)；`rule`(GuardRule, 必填，触发规则)；`action`(GuardAction, 必填，动作)；`status`(repeated string, 必填，规则状态)；`applyGroup`(string, 必填，应用群范围, all / specify)；`execBotId`(int64, 可选，执行微号(个微计划)) | `id`(int64) |
| 群守卫-修改 | `POST /api/wx/group/guard/plan/update` | `botType`(int32, 必填，类型 1 个微 2企微)；`id`(int64, 必填，id)；`name`(string, 必填，名称)；`botId`(int64, 必填，应用微号:单个)；`groupIds`(repeated int64, 必填，应用客户群:多个)；`timeFrame`(TimeFrame, 必填，生效时间段)；`rule`(GuardRule, 必填，触发规则)；`action`(GuardAction, 必填，动作)；`status`(repeated string, 必填，规则状态)；`applyGroup`(string, 必填，应用群范围, all / specify)；`execBotId`(int64, 可选，执行动作的微号) | 空对象或无业务数据 |
@@ -125,15 +125,15 @@
| 群守卫-白名单更新 | `POST /api/wx/group/guard/whitelist/update` | `isSystem`(bool, 必填，系统内微号自动加入白名单)；`whitelist`(repeated int64, 必填，手动设置的白名单客户)；`link`(repeated string, 必填，链接白名单)；`miniProgram`(repeated WhitelistItem, 必填，小程序白名单)；`freeVideo`(repeated string, 必填，视频号白名单)；`corpIds`(repeated string, 必填，过滤企微主体)；`globalWhitelist`(bool, 可选，全局白名单开关)；`corpType`(string, 可选，主体过滤类型)；`wxBatchWhite`(repeated string, 可选，个微计划批量导入白名单)；`qwBatchWhite`(repeated string, 可选，企微计划批量导入白名单) | 空对象或无业务数据 |
| 群守卫-白名单信息 | `POST /api/wx/group/guard/whitelist/info` | `{}` | `isSystem`(bool，系统内微号自动加入白名单)；`whitelist`(repeated int64，手动设置的白名单客户)；`link`(repeated string，链接白名单)；`miniProgram`(repeated WhitelistItem，小程序白名单)；`freeVideo`(repeated string，视频号白名单)；`corpIds`(repeated string，过滤企微主体)；`globalWhitelist`(bool，全局白名单开关)；`corpType`(string，主体过滤类型)；`wxBatchWhite`(repeated string，个微计划批量导入白名单)；`qwBatchWhite`(repeated string，企微计划批量导入白名单) |
| 群守卫-执行记录 | `POST /api/wx/group/guard/record/list` | `page`(int64, 可选，page)；`pageSize`(int64, 可选，pagesize)；`guardId`(int64, 可选，群守卫计划id)；`action`(string, 可选，执行的动作) | `list`(repeated GroupGuardRecordItem，群守卫执行记录列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 退群监听-列表 | `POST /api/wx/group/quit/plan/list` | `page`(int64, 可选，page)；`pageSize`(int64, 可选，pagesize) | `list`(repeated ListItem，群守卫列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 退群监听-列表 | `POST /api/wx/group/quit/plan/list` | `page`(int64, 可选，page)；`pageSize`(int64, 可选，pagesize) | `list`(repeated ListItem，退群监听列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 退群监听-创建 | `POST /api/wx/group/quit/plan/create` | `name`(string, 必填，方案名称)；`botId`(int64, 必填，机器人id)；`botType`(int32, 必填，机器人类型)；`groupIds`(repeated int64, 必填，群id列表)；`targetGroupId`(int64, 必填，目标群id)；`status`(bool, 必填，状态 默认 关闭 false， true是开)；`guideMessageList`(repeated Message, 必填，引导语)；`maxInviteCount`(int32, 必填，最大拉入次数，0表示不限制) | `id`(int64，id) |
| 退群监听-更新 | `POST /api/wx/group/quit/plan/update` | `id`(int64, 必填，id)；`name`(string, 必填，方案名称)；`botId`(int64, 必填，机器人id)；`botType`(int32, 必填，机器人类型)；`groupIds`(repeated int64, 必填，群id列表)；`targetGroupId`(int64, 必填，目标群id)；`status`(bool, 必填，状态 默认 关闭 false， true是开)；`guideMessageList`(repeated Message, 必填，引导语)；`maxInviteCount`(int32, 必填，最大拉入次数，0表示不限制) | 空对象或无业务数据 |
| 退群监听-删除 | `POST /api/wx/group/quit/plan/delete` | `id`(int64, 必填，id) | 空对象或无业务数据 |
| 退群监听-详情 | `POST /api/wx/group/quit/plan/info` | `id`(int64, 必填，id) | `id`(int64，id)；`name`(string，名称)；`botId`(int64，机器人id)；`botType`(int32，机器人类型)；`groupIds`(repeated int64，群id列表)；`targetGroupId`(int64，目标群id)；`status`(bool，状态 默认 关闭 false， true是开)；`guideMessageList`(repeated Message，引导语)；`maxInviteCount`(int32，最大拉入次数，0表示不限制) |
| 退群监听-更新状态 | `POST /api/wx/group/quit/plan/update/status` | `id`(int64, 必填，id)；`status`(bool, 必填，状态 默认 关闭 false， true是开) | 空对象或无业务数据 |
| 退群监听-记录 | `POST /api/wx/group/quit/plan/records` | `page`(int64, 可选，page)；`pageSize`(int64, 可选，pagesize)；`pid`(int64, 必填，计划id) | `list`(repeated RecordItem，记录)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| 群转播-添加 | `POST /api/wx/group/relay/add` | `botType`(int32, 必填，类型 1 个微 2企微)；`sources`(repeated Source, 必填，转发的来源)；`relayTypes`(repeated string, 必填，要转发的消息类型)；`targetType`(string, 必填，对象类型:normal,role,qwMember)；`targetGroupIds`(repeated int64, 必填，转发的目标群)；`targetQwMemberIds`(repeated int64, 必填，转发的目标企微成员)；`targetQwMemberCorpId`(string, 必填，企微corpId)；`rolePlanId`(int64, 必填，角色方案)；`relayExecutorIds`(repeated int64, 必填，转发的人)；`name`(string, 必填，计划名称)；`filterContent`(repeated string, 必填，过滤内容)；`replaceList`(repeated Replace, 必填，替换内容)；`autoImageToSticker`(bool, 必填，图片发送超限转成表情发送)；`status`(bool, 必填，开关状态)；`imageToStickerEnable`(bool, 必填，主动图片转表情发送)；`LinkConvConf`(repeated LinkConvConf, 必填，转链配置)；`timeFrame`(repeated int64, 必填，生效时间段)；`linkConvFailSkip`(bool, 必填，转链失败就跳过转链直接发)；`textLinkWhitelist`(repeated string, 必填，文本链接白名单)；`textLinkConvSkipList`(repeated string, 必填，跳过转链的文本链接名单)；... 另有 3 个字段 | `id`(int64，id) |
| 群转播-修改 | `POST /api/wx/group/relay/update` | `id`(int64, 必填，id)；`botType`(int32, 必填，类型 1 个微 2企微)；`sources`(repeated Source, 必填，转发的来源)；`relayTypes`(repeated string, 必填，要转发的消息类型)；`targetType`(string, 必填，对象类型:normal,role,qwMember)；`targetGroupIds`(repeated int64, 必填，转发的目标群)；`targetQwMemberIds`(repeated int64, 必填，转发的目标企微成员)；`targetQwMemberCorpId`(string, 必填，企微corpId)；`rolePlanId`(int64, 必填，角色方案)；`relayExecutorIds`(repeated int64, 必填，转发的人)；`name`(string, 必填，计划名称)；`filterContent`(repeated string, 必填，过滤内容)；`replaceList`(repeated Replace, 必填，替换内容)；`autoImageToSticker`(bool, 必填，图片发送超限转成表情发送)；`status`(bool, 必填，开关状态)；`imageToStickerEnable`(bool, 必填，主动图片转表情发送)；`LinkConvConf`(repeated LinkConvConf, 必填，转链配置)；`timeFrame`(repeated int64, 必填，生效时间段)；`linkConvFailSkip`(bool, 必填，转链失败就跳过转链直接发)；`textLinkWhitelist`(repeated string, 必填，文本链接白名单)；... 另有 4 个字段 | 空对象或无业务数据 |
| 群转播-添加 | `POST /api/wx/group/relay/add` | `botType`(int32, 必填，类型 1 个微 2企微)；`sources`(repeated Source, 必填，转发的来源)；`relayTypes`(repeated string, 必填，要转发的消息类型)；`targetType`(string, 必填，对象类型:normal,role,qwMember)；`targetGroupIds`(repeated int64, 必填，转发的目标群)；`targetQwMemberIds`(repeated int64, 必填，转发的目标企微成员)；`targetQwMemberCorpId`(string, 必填，企微corpId)；`rolePlanId`(int64, 必填，角色方案)；`relayExecutorIds`(repeated int64, 必填，转发的人)；`name`(string, 必填，计划名称)；`filterContent`(repeated string, 必填，过滤内容)；`replaceList`(repeated Replace, 必填，替换内容)；`autoImageToSticker`(bool, 必填，图片发送超限转成表情发送)；`status`(bool, 必填，开关状态)；`imageToStickerEnable`(bool, 必填，主动图片转表情发送)；`linkConvConf`(repeated LinkConvConf, 必填，转链配置)；`timeFrame`(repeated int64, 必填，生效时间段)；`linkConvFailSkip`(bool, 必填，转链失败就跳过转链直接发)；`textLinkWhitelist`(repeated string, 必填，文本链接白名单)；`textLinkConvSkipList`(repeated string, 必填，跳过转链的文本链接名单)；... 另有 3 个字段 | `id`(int64，id) |
| 群转播-修改 | `POST /api/wx/group/relay/update` | `id`(int64, 必填，id)；`botType`(int32, 必填，类型 1 个微 2企微)；`sources`(repeated Source, 必填，转发的来源)；`relayTypes`(repeated string, 必填，要转发的消息类型)；`targetType`(string, 必填，对象类型:normal,role,qwMember)；`targetGroupIds`(repeated int64, 必填，转发的目标群)；`targetQwMemberIds`(repeated int64, 必填，转发的目标企微成员)；`targetQwMemberCorpId`(string, 必填，企微corpId)；`rolePlanId`(int64, 必填，角色方案)；`relayExecutorIds`(repeated int64, 必填，转发的人)；`name`(string, 必填，计划名称)；`filterContent`(repeated string, 必填，过滤内容)；`replaceList`(repeated Replace, 必填，替换内容)；`autoImageToSticker`(bool, 必填，图片发送超限转成表情发送)；`status`(bool, 必填，开关状态)；`imageToStickerEnable`(bool, 必填，主动图片转表情发送)；`linkConvConf`(repeated LinkConvConf, 必填，转链配置)；`timeFrame`(repeated int64, 必填，生效时间段)；`linkConvFailSkip`(bool, 必填，转链失败就跳过转链直接发)；`textLinkWhitelist`(repeated string, 必填，文本链接白名单)；... 另有 4 个字段 | 空对象或无业务数据 |
| 群转播-列表 | `POST /api/wx/group/relay/list` | `page`(int64, 必填，page)；`pageSize`(int64, 必填，pageSize)；`userId`(int64, 可选，筛选计划的创建者)；`name`(string, 必填，搜索计划名字) | `list`(repeated HttpInfoReply，列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last) |
| 群转播-详情 | `POST /api/wx/group/relay/info` | `id`(int64, 必填，id) | `id`(int64，id)；`botType`(int32，类型 1 个微 2企微)；`sources`(repeated Source，转发的来源)；`relayTypes`(repeated string，要转发的消息类型)；`targetType`(string，对象类型:normal,role,qwMember)；`targetGroupIds`(repeated int64，转发的目标群)；`targetQwMemberIds`(repeated int64，转发的目标企微成员)；`targetQwMemberCorpId`(string，企微corpId)；`rolePlanId`(int64，角色方案)；`relayExecutorIds`(repeated int64，转发的人)；... |
| 群转播-删除 | `POST /api/wx/group/relay/del` | `id`(int64, 必填，id) | 空对象或无业务数据 |
@@ -153,8 +153,12 @@
## 常用示例
```bash
htsy-cli call /api/wx/group/list -d '{"page":1,"pageSize":20,"botType":1,"botId":1001}'
htsy-cli call /api/wx/group/member/list -d '{"page":1,"pageSize":50,"groupId":3001,"botType":1}'
htsy-cli call /api/wx/group/getCode -d '{"groupId":3001,"botType":1}'
htsy-cli call /api/wx/group/category/add -d '{"name":"活动群","botType":1}'
# 群列表（企微无 botId 时必传 corpId；CORP_ID 可从 /api/bot/wx/corp/list 返回项的 id 获取）
htsy-cli call /api/wx/group/list -d '{"page":1,"pageSize":20,"botType":2,"corpId":"CORP_ID"}'
# 群成员列表（corpId 必填）
htsy-cli call /api/wx/group/member/list -d '{"groupId":3001,"botType":2,"corpId":"CORP_ID"}'
# 群二维码（botId 必填）
htsy-cli call /api/wx/group/getCode -d '{"botId":1001,"groupId":3001,"botType":2}'
# 创建群分组（corpId 必填）
htsy-cli call /api/wx/group/category/add -d '{"name":"活动群","botType":2,"corpId":"CORP_ID"}'
```