Files
htsy-skill/references/api-group.md
T

161 lines
52 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 群、群成员与群运营
阅读本文件处理群列表、成员、群分组、群管理、群二维码、群成员操作、群公告、群欢迎语、群守卫、群查重、群转播、批量入群和批量邀请等操作。
## 目录
- [群基础与群管理](#群基础与群管理)
- [群运营计划](#群运营计划)
- [常用示例](#常用示例)
## 群基础与群管理
| 目标 | 接口 | 请求字段 | 常用返回字段 |
| --- | --- | --- | --- |
| 群列表 | `POST /api/wx/group/list` | `page`(int64, 可选,page)`pageSize`(int64, 可选,pagesize)`groupId`(int64, 可选,分组的id,不是群id,不要搞错了);`groupName`(string, 可选,群名字)`groupType`(string, 可选,群类型 wx 个微群 qw 企微外部群 qwIn 企微内部群);`botType`(int32, 必填,类型 1 个微 2企微);`botId`(int64, 可选,微号的id)`corpId`(string, 可选,企微主体id,没有传botId的情况,该字段必须传);`isManager`(bool, 可选,是否是管理员)`threePartyService`(string, 可选,三方服务过滤部分字段使用) | `list`(repeated HttpGroupInfoReply)`page`(int64)`pageSize`(int64)`total`(int64)`last`(bool) |
| 某个群的成员列表 | `POST /api/wx/group/member/list` | `groupId`(int64, 可选)`botType`(int32, 必填,类型 1 个微 2企微);`corpId`(string, 必填,主体id)`name`(string, 可选,成员昵称) | `list`(repeated MemberInfo) |
| 手动同步某个群的成员 | `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/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`(int64id) |
| 分组-列表 | `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`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast) |
| 分组-删除 | `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企微) | 空对象或无业务数据 |
| 分组-减少分组内的群 | `POST /api/wx/group/category/delGroup` | `id`(int64, 必填,分组id)`groupIds`(repeated int64, 必填,组内-群id列表)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 分组-排序 | `POST /api/wx/group/category/sort` | `list`(repeated HttpCategorySortItem, 必填,列表)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 查询多群共同的机器人列表 | `POST /api/wx/group/commonBotList` | `groupIds`(repeated int64, 必填,群ids)`part`(bool, 必填,是否是部分共有的机器人,true 不用所有群都有,false 全部群都要有);`categoryIds`(repeated int64, 可选,群组ids)`botType`(int32, 必填,类型 1 个微 2企微);`isCreator`(bool, 可选,是否是创建者 true 是创建者, false 全部)`moduleName`(string, 可选,1 全功能 2 发单) | `list`(repeated CommonBotInfo,共同群列表)`groupTotal`(int64,群总数) |
| 查询多群共同的客户列表 | `POST /api/wx/group/commonFriendList` | `groupIds`(repeated int64, 必填,群ids)`botType`(int32, 必填,类型 1 个微 2企微) | `list`(repeated MemberInfo,共有的群成员列表) |
| 设置群消息免打扰和折叠 | `POST /api/wx/group/setDisturbAndFold` | `ids`(repeated int64, 必填,群id列表)`disturb`(bool, 必填,是否打扰 false 打扰 true 免打扰)`fold`(bool, 必填,是否折叠 true 折叠 false 不折叠)`botType`(int32, 必填,类型 1 个微 2企微);`botId`(int64, 必填,botId) | 空对象或无业务数据 |
| 群管理-创建群 | `POST /api/wx/group/manager/create` | `botType`(int32, 必填,类型 1 个微 2企微);`botId`(int64, 必填,机器人id)`name`(string, 必填,名字) | `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,属于的主体) |
| 群管理-修改群名 | `POST /api/wx/group/manager/modifyName` | `botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,群id)`botId`(int64, 必填,机器人id)`name`(string, 必填,名字)`atAll`(bool, 可选,是否@所有人) | 空对象或无业务数据 |
| 群管理-修改群公告 | `POST /api/wx/group/manager/modifyNotice` | `botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,群id)`botId`(int64, 必填,机器人id)`notice`(string, 必填,通知)`atAll`(bool, 可选,是否@所有人) | 空对象或无业务数据 |
| 群管理-转让群主 | `POST /api/wx/group/manager/transferGroupOwner` | `botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,群id)`botId`(int64, 必填,机器人id)`memberId`(int64, 必填,转让的目标成员id);`wxid`(string, 必填,转让对象的wxid) | 空对象或无业务数据 |
| 群管理-批量转让群主 | `POST /api/wx/group/manager/batch/transferGroupOwner` | `groupIds`(repeated int64, 必填,群id)`botId`(int64, 可选,转让对象的微号id);`botType`(int32, 必填,类型 1 个微 2企微);`wxid`(string, 可选,转让对象的wxid)`managerBotId`(int64, 可选,群主的微号id) | `items`(repeated HttpBatchTransferGroupOwnerReplyItemlist) |
| 群管理-解散群 | `POST /api/wx/group/manager/disbandGroup` | `botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,群id)`botId`(int64, 必填,机器人id) | 空对象或无业务数据 |
| 群管理-保存或移出通讯录 | `POST /api/wx/group/manager/saveOrDelAddressBook` | `botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,群id)`botId`(int64, 必填,机器人id)`save`(bool, 必填,是否保存 true保存 false 移出) | 空对象或无业务数据 |
| 群管理-批量修改群名 | `POST /api/wx/group/manager/batchModifyName` | `list`(repeated HttpModifyGroupName, 必填,群列表)`botId`(int64, 必填,机器人id)`atAll`(bool, 可选,是否@所有人)`botType`(int32, 必填,类型 1 个微 2企微) | `list`(repeated HttpModifyGroupNameResult,结果) |
| 群管理-修改微号本群昵称 | `POST /api/wx/group/modifyGroupBotNickname` | `botId`(int64, 必填,微号id)`groupId`(int64, 必填,群id)`nickname`(string, 必填,昵称)`botType`(int32, 必填,微号类型) | 空对象或无业务数据 |
| 群成员-批量给一批群添加一批群成员 | `POST /api/wx/group/addMember` | `botId`(int64, 必填,机器人id)`groupIds`(repeated int64, 必填,群ids)`friendIds`(repeated int64, 必填,客户ids)`corpMemberIds`(repeated int64, 必填,主体成员id)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 群成员-批量给一批群移除一批群成员 | `POST /api/wx/group/delMember` | `botId`(int64, 必填,机器人id)`groupIds`(repeated int64, 必填,群ids)`friendIds`(repeated int64, 必填,客户ids)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 群成员-批量添加群管理员 | `POST /api/wx/group/addAdmin` | `botId`(int64, 必填,机器人id)`groupIds`(repeated int64, 必填,群ids)`friendIds`(repeated int64, 可选,客户ids)`memberIds`(repeated int64, 可选,群成员ids)`wxids`(repeated string, 可选,群成员ids)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 群成员-批量移除群管理员 | `POST /api/wx/group/delAdmin` | `botId`(int64, 必填,机器人id)`groupIds`(repeated int64, 必填,群ids)`friendIds`(repeated int64, 可选,客户ids)`memberIds`(repeated int64, 可选,群成员ids)`wxids`(repeated string, 可选,群成员ids)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 批量拉入黑名单 | `POST /api/wx/group/addBlack` | `botId`(int64, 必填,机器人id)`status`(int64, 必填,1:加入黑名单 0:移除黑名单);`friendIds`(repeated int64, 必填,客户ids)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 批量拉入黑名单(通过wxid操作) | `POST /api/wx/group/addBlack/bywxid` | `botWxid`(string, 必填,机器人wxid)`status`(int64, 必填,1:加入黑名单 0:移除黑名单);`friendWxids`(repeated string, 必填,客户wxids)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 获取群二维码 | `POST /api/wx/group/getCode` | `botId`(int64, 必填,机器人id)`groupId`(int64, 必填,群id)`botType`(int32, 必填,类型 1 个微 2企微) | `link`(string,链接) |
| 退出群聊 | `POST /api/wx/group/exit` | `botId`(int64, 必填,机器人id)`groupId`(int64, 必填,群id)`botType`(int32, 必填,类型 1 个微 2企微) | `ok`(bool,是否成功 true成功)`failReason`(string,失败原因) |
| 设置群头像 | `POST /api/wx/group/setAvatar` | `groupId`(int64, 必填,群id)`link`(string, 必填,头像地址)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 批量同步群 | `POST /api/wx/group/batch/sync` | `groupIds`(repeated int64, 必填,需要同步群的id列表) | 空对象或无业务数据 |
| 通过wxid批量获取成员信息 | `POST /api/wx/group/list/ByWxid` | `wxids`(repeated string, 可选)`botType`(int32, 必填,微号类型) | `list`(repeated MemberInfo,群成员信息) |
| 禁止修改群名 | `POST /api/wx/group/prohibit/groupName` | `list`(repeated ProhibitModifyGroupNameItem, 可选)`status`(bool, 必填,true 开启 false 关闭) | `list`(repeated HttpModifyGroupNameResult,结果) |
| 开启/关闭禁止相互添加为联系人、禁止修改群名 | `POST /api/wx/group/modify/roomAdminFlag` | `list`(repeated ModifyRoomAdminFlagItem, 可选)`forbidAddContact`(bool, 必填,相互添加为联系人 true 开启 false 关闭)`forbidModName`(bool, 必填,修改群名 true 开启 false 关闭) | `list`(repeated HttpModifyRoomAdminFlagResult,结果) |
| 群成员-通过memberIds获取群成员信息 | `POST /api/wx/group/member/byIds` | `memberIds`(repeated int64, 必填,群成员ids)`botType`(int32, 必填,类型 1 个微 2企微) | `list`(repeated MemberInfo,群成员信息) |
| 通过群Id和wxid获取成员id | `POST /api/wx/group/member/bywxid` | `groupId`(int64, 必填,群id)`wxid`(string, 必填,群ids) | `memberId`(int64) |
| 置顶消息-设置置顶 | `POST /api/wx/group/topMsg/top` | `botId`(int64, 必填,微号id)`groupIds`(repeated int64, 必填,群ids)`messageList`(repeated Message, 必填,需要置顶的消息 暂时支持文本、图片、视频、链接、文件);`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 置顶消息-移除置顶消息 | `POST /api/wx/group/topMsg/remove` | `botId`(int64, 可选,微号id 空 随机一个管理员);`groupId`(int64, 必填,群id)`topMsgId`(string, 必填,置顶消息id)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 置顶消息-消息列表 | `POST /api/wx/group/topMsg/list` | `groupId`(int64, 必填,群id)`botType`(int32, 必填,类型 1 个微 2企微) | `topMsgList`(repeated TopMsgItemlist)`total`(int64,总数) |
| 开启或者关闭在群邀请验证状态 | `POST /api/wx/group/inviteStatus/modify` | `botId`(int64, 可选,微号id 空 随机一个管理员);`groupIds`(repeated int64, 必填,群ids)`status`(bool, 必填,true 开 false 关)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 置顶消息-同步置顶消息列表 | `POST /api/wx/group/topMsg/sync` | `botId`(int64, 必填,微号id)`groupId`(int64, 必填,群id)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 置顶消息-获取链接 | `POST /api/wx/group/topMsg/record/dl` | `id`(int64, 必填,置顶消息的id) | `link`(string,链接) |
| 群成员-添加为好友 | `POST /api/wx/group/member/addContact` | `botId`(int64, 必填,微号id)`memberId`(repeated int64, 必填,群成员id)`content`(string, 必填,验证消息)`botType`(int32, 必填,类型 1 个微 2企微) | 空对象或无业务数据 |
| 获取群名称头像信息 | `POST /api/wx/group/baseInfo/byWxids` | `botType`(int32, 必填,微号类型)`wxids`(repeated string, 必填,wxids) | `list`(repeated GroupBaseInfo,群列表) |
| 群列表(bywxids,主要api使用) | `POST /api/wx/group/list/byWxids` | `wxids`(repeated string, 必填,wxids) | `list`(repeated HttpFindListByWxidsItem,群列表) |
## 群运营计划
| 目标 | 接口 | 请求字段 | 常用返回字段 |
| --- | --- | --- | --- |
| 批量入群-创建计划 | `POST /api/wx/group/batchAddGroup/create` | `botType`(int32, 必填,微号类型)`name`(string, 必填,计划名称)`groupCategoryId`(int64, 必填,群分组)`rolePlanId`(int64, 必填,角色方案)`bots`(repeated AddGroupBot, 必填,微号)`links`(repeated string, 必填,加群链接)`addGroupInterval`(int64, 必填,加群间隔 单位ms);`schedule`(Schedule, 必填,执行的时间段);`minMemberNum`(int64, 必填,最低成员数,小于该值不入群);`setFoldAndNotDisturb`(bool, 必填,设置折叠和免打扰) | `id`(int64,计划id) |
| 批量入群-计划详情 | `POST /api/wx/group/batchAddGroup/info` | `id`(int64, 必填,计划id) | `id`(int64,计划id)`botType`(int32,微号类型)`name`(string,计划名称)`groupCategoryId`(int64,群分组)`rolePlanId`(int64,角色方案)`bots`(repeated AddGroupBotInfo,微号)`links`(repeated string,加群链接)`addGroupInterval`(int64,加群间隔 单位ms)`schedule`(Schedule,执行的时间段)`status`(string,状态)... |
| 批量入群-计划列表 | `POST /api/wx/group/batchAddGroup/list` | `page`(int64, 必填,分页page)`pageSize`(int64, 必填,分页pagesize)`status`(string, 可选,状态) | `list`(repeated HttpBatchAddGroupPlanInfoReply,计划列表)`page`(int64,分页page)`pageSize`(int64,分页pagesize)`total`(int64,总数)`last`(bool,是否最后) |
| 批量入群-更新计划 | `POST /api/wx/group/batchAddGroup/update` | `id`(int64, 必填,计划id)`name`(string, 必填,计划名称)`bots`(repeated AddGroupBot, 必填,微号)`addGroupInterval`(int64, 必填,加群间隔 单位ms);`schedule`(Schedule, 必填,执行的时间段);`minMemberNum`(int64, 必填,最低成员数,小于该值不入群);`setFoldAndNotDisturb`(bool, 必填,设置折叠和免打扰) | 空对象或无业务数据 |
| 批量入群-删除计划 | `POST /api/wx/group/batchAddGroup/del` | `id`(int64, 必填,计划id) | 空对象或无业务数据 |
| 批量入群-切换开关 | `POST /api/wx/group/batchAddGroup/toggle` | `id`(int64, 必填,计划id)`status`(string, 必填,状态: executing 开始执行, stop 暂停) | 空对象或无业务数据 |
| 批量入群-记录 | `POST /api/wx/group/batchAddGroup/itemList` | `page`(int64, 必填,分页page)`pageSize`(int64, 必填,分页pagesize)`status`(string, 可选,状态)`pid`(int64, 必填,计划id)`botId`(int64, 必填,微号id) | `list`(repeated BatchAddGroupPlanItemitem列表)`page`(int64,分页page)`pageSize`(int64,分页pagesize)`total`(int64,总数)`last`(bool,是否最后) |
| 批量群邀请-创建 | `POST /api/wx/group/batchInviteJoinPlan/create` | `name`(string, 必填,名字)`botType`(int32, 必填,微号类型)`filters`(repeated TargetFilter, 必填,客户的筛选类型);`useBlacklist`(bool, 必填,是否使用黑名单)`messageList`(repeated Message, 必填,回复内容)`botList`(repeated SenderBot, 必填,机器人ids)`targetRequireType`(string, 可选,specify 指定某些用户 filter 筛选);`targetIds`(repeated int64, 可选,指定成员Ids)`targetType`(string, 可选,推送对象 friend 客户 qwMember 企微成员)`intervalTime`(int64, 必填,拉托入群要用 时间间隔 单位s);`groupPlanId`(int64, 必填,派群计划(废弃));`schedule`(Schedule, 必填,推送的时间段);`isSupplement`(bool, 必填,是否补群)`corpId`(string, 可选,主体id)`inviteWithGroup`(bool, 必填,聚合邀请)`scene`(int64, 必填,场景 0:默认 1:40人拉群 2:40人补群 3:40人建群 10:企微成员补群);`fullTransferAdmin`(bool, 必填,接粉号群满转移群主给发单号);`fullAutoQuit`(bool, 必填,接粉号群满自动退群);`sendMsgBots`(repeated SendMsgBot, 必填,发单号)`disableMutexAssign`(bool, 可选,关闭互斥分配,客户会分配给每一个微号) | `id`(int64id) |
| 批量群邀请-暂停 | `POST /api/wx/group/batchInviteJoinPlan/stop` | `id`(int64, 可选) | 空对象或无业务数据 |
| 批量群邀请-开始 | `POST /api/wx/group/batchInviteJoinPlan/start` | `id`(int64, 可选) | 空对象或无业务数据 |
| 批量群邀请-更新 | `POST /api/wx/group/batchInviteJoinPlan/update` | `name`(string, 必填,名字)`botType`(int32, 必填,微号类型)`filters`(repeated TargetFilter, 必填,客户的筛选类型);`useBlacklist`(bool, 必填,是否使用黑名单)`messageList`(repeated Message, 必填,回复内容)`botList`(repeated SenderBot, 必填,机器人ids)`targetRequireType`(string, 可选,specify 指定某些用户 filter 筛选);`targetIds`(repeated int64, 可选,指定成员Ids)`targetType`(string, 可选,推送对象 friend 客户 qwMember 企微成员)`intervalTime`(int64, 必填,拉托入群要用 时间间隔 单位s);`groupPlanId`(int64, 必填,派群计划)`schedule`(Schedule, 必填,推送的时间段);`id`(int64, 必填,id)`isSupplement`(bool, 必填,是否补群)`corpId`(string, 可选,主体id)`inviteWithGroup`(bool, 必填,分配至同一群的一起拉);`scene`(int64, 必填,场景 0:默认 1:40人拉群 2:40人补群 3:40人建群 10:企微成员补群);`fullTransferAdmin`(bool, 必填,接粉号群满转移群主给发单号);`fullAutoQuit`(bool, 必填,接粉号群满自动退群);`sendMsgBots`(repeated SendMsgBot, 必填,发单号)... 另有 1 个字段 | 空对象或无业务数据 |
| 批量群邀请-删除 | `POST /api/wx/group/batchInviteJoinPlan/del` | `id`(int64, 必填,id) | 空对象或无业务数据 |
| 批量群邀请-列表 | `POST /api/wx/group/batchInviteJoinPlan/list` | `page`(int64, 必填,分页page)`pageSize`(int64, 必填,分页pagesize)`name`(string, 可选,名称搜索)`botType`(int32, 必填,微号类型) | `list`(repeated HttpGroupBatchJoinPlanDetailReply,方案列表)`page`(int64page)`pageSize`(int64pageSize)`total`(int64,总数)`last`(bool,是否最后) |
| 批量群邀请-详情 | `POST /api/wx/group/batchInviteJoinPlan/detail` | `id`(int64, 必填,id) | `name`(string,名字)`botType`(int32,微号类型)`filters`(repeated TargetFilter,客户的筛选类型)`useBlacklist`(bool,是否使用黑名单)`messageList`(repeated Message,回复内容)`botList`(repeated SenderBot,机器人ids)`targetRequireType`(stringspecify 指定某些用户 filter 筛选 all 全部)`targetIds`(repeated int64,指定成员Ids)`targetType`(string,推送对象 friend 客户 qwMember 企微成员)`intervalTime`(int64,拉托入群要用 时间间隔 单位s);... |
| 批量群邀请-推送记录列表 | `POST /api/wx/group/batchInviteJoinPlan/itemList` | `planId`(int64, 必填,计划id)`page`(int64, 必填,分页page)`pageSize`(int64, 必填,分页pagesize)`status`(string, 可选,状态)`botId`(int64, 可选,微号id) | `list`(repeated HttpGroupBatchPlanItem,方案列表)`page`(int64page)`pageSize`(int64pageSize)`total`(int64,总数)`last`(bool,是否最后) |
| 批量群邀请-预估人数 | `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`(int64page)`pageSize`(int64pageSize)`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`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast) |
| 接受群邀请-操作 | `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`(int64id)`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/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) | 空对象或无业务数据 |
| 群公告计划-列表 | `POST /api/wx/group/announcement/plan/list` | `page`(int64, 必填,page)`pageSize`(int64, 必填,分页pagesize)`userId`(int64, 可选,userid)`name`(string, 可选,名称搜索)`botType`(int32, 可选,类型 1 个微 2企微) | `list`(repeated GroupAnnouncementItemlist)`page`(int64page)`pageSize`(int64pageSize)`total`(int64,总数)`last`(bool,是否最后) |
| 群公告计划-创建 | `POST /api/wx/group/announcement/plan/create` | `id`(int64, 可选,id)`name`(string, 必填,计划昵称)`bots`(Bots, 可选,微号)`groupAnnouncementContent`(string, 必填,群公告内容)`type`(string, 必填,计划类型 common 普通计划);`messageList`(repeated Message, 可选,发布公告后发送的消息);`schedule`(Schedule, 必填,推送时间设置);`scheduleType`(string, 可选,推送类型 立即quick 延迟delay 每天 everyday 每周 week)`isAtAll`(bool, 可选,是否@所有人)`groupIds`(repeated int64, 必填,群ids)`targetRequireType`(string, 必填,推送筛选 all 所有 specify 指定某些群)`botRequireType`(string, 必填,微号范围 admin 管理员或者群主 specify 指定管理员);`botType`(int32, 可选,类型 1 个微 2企微) | `id`(int64id) |
| 群公告计划-更新 | `POST /api/wx/group/announcement/plan/update` | `id`(int64, 可选,id)`name`(string, 必填,计划昵称)`bots`(Bots, 可选,微号)`groupAnnouncementContent`(string, 必填,群公告内容)`type`(string, 必填,计划类型 common 普通计划);`messageList`(repeated Message, 可选,发布公告后发送的消息);`schedule`(Schedule, 必填,推送时间设置);`scheduleType`(string, 可选,推送类型 立即quick 延迟delay 每天 everyday 每周 week)`isAtAll`(bool, 可选,是否@所有人)`groupIds`(repeated int64, 必填,群ids)`targetRequireType`(string, 必填,推送筛选 all 所有 specify 指定某些群)`botRequireType`(string, 必填,微号范围 admin 管理员或者群主 specify 指定管理员);`botType`(int32, 可选,类型 1 个微 2企微) | 空对象或无业务数据 |
| 群公告计划-详情 | `POST /api/wx/group/announcement/plan/info` | `id`(int64, 必填,id) | `id`(int64id)`name`(string,计划昵称)`bots`(Bots,微号)`groupAnnouncementContent`(string,群公告内容)`type`(string,计划类型 common 普通计划);`messageList`(repeated Message,发布公告后发送的消息);`schedule`(Schedule,推送时间设置)`scheduleType`(string,推送类型 立即quick 延迟delay 每天 everyday 每周 week)`isAtAll`(bool,是否@所有人)`groupIds`(repeated int64,群ids)... |
| 计划暂停 | `POST /api/wx/group/announcement/plan/stop` | `id`(int64, 必填,要取消的id)`idType`(int32, 必填,id的类型,1 计划id 2 record id 3 客户群id 4 消息记录id 5 消息id)`recordId`(int64, 可选,记录id, 开始和暂停可以不传) | 空对象或无业务数据 |
| 计划开始 | `POST /api/wx/group/announcement/plan/start` | `id`(int64, 必填,要取消的id)`idType`(int32, 必填,id的类型,1 计划id 2 record id 3 客户群id 4 消息记录id 5 消息id)`recordId`(int64, 可选,记录id, 开始和暂停可以不传) | 空对象或无业务数据 |
| 群公告计划-删除 | `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 HttpGroupAnnouncementPlanRecordItemListItemlist)`page`(int64page)`pageSize`(int64pageSize)`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`(int64id)`name`(string,计划昵称)`groupIds`(repeated int64,群ids)`friendIds`(repeated int64,不参与查重的客户);`isAddBlacklist`(bool,是否拉黑)`isKickingMember`(bool,是否踢人)`kickInterval`(int64,踢人间隔)`botId`(int64,踢人拉黑的执行微号)`Schedule`(Schedule,定时)`scheduleType`(stringdelay 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`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast)`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/del` | `id`(int64, 可选,id) | 空对象或无业务数据 |
| 群查重-计划详情 | `POST /api/wx/group/duplicate/plan/info` | `id`(int64, 可选,id) | `id`(int64id)`name`(string,计划昵称)`groupIds`(repeated int64,群ids)`friendIds`(repeated int64,不参与查重的客户);`isAddBlacklist`(bool,是否拉黑)`isKickingMember`(bool,是否踢人)`kickInterval`(int64,踢人间隔)`botId`(int64,踢人拉黑的执行微号)`Schedule`(Schedule,定时)`scheduleType`(stringdelay quick)... |
| 群查重-计划记录 | `POST /api/wx/group/duplicate/plan/record` | `pid`(int64, 可选,id)`page`(int64, 可选,page)`pageSize`(int64, 可选,pageSize) | `list`(repeated DuplicatePlanRecordItem)`page`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast)`status`(string,状态)`failReason`(string,失败原因)`listByGroup`(repeated DuplicatePlanRecordItemByGrouptargetType:inGroupSystemBot 有值)`targetType`(stringgroupMember 群成员 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`(int64id) |
| 入群欢迎语-列表 | `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`(int64page)`pageSize`(int64pageSize)`total`(int64,总数)`last`(bool,是否最后) |
| 入群欢迎语-详情 | `POST /api/wx/group/welcome/info` | `id`(int64, 必填,id) | `id`(int64id)`name`(string,名称)`botType`(int641个微 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/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, 可选,执行动作的微号) | 空对象或无业务数据 |
| 群守卫-删除 | `POST /api/wx/group/guard/plan/del` | `id`(int64, 必填,id) | 空对象或无业务数据 |
| 群守卫-列表 | `POST /api/wx/group/guard/plan/list` | `page`(int64, 可选,page)`pageSize`(int64, 可选,pagesize) | `list`(repeated HttpGroupGuardInfoReply,群守卫列表)`page`(int64page)`pageSize`(int64pageSize)`total`(int64,总数)`last`(bool,是否最后) |
| 群守卫-详情 | `POST /api/wx/group/guard/plan/info` | `id`(int64, 必填,群守卫计划id) | `botType`(int32,类型 1 个微 2企微)`id`(int64id)`name`(string,名称)`botId`(int64,应用微号:单个)`groupIds`(repeated int64,应用客户群:多个)`timeFrame`(TimeFrame,生效时间段)`rule`(GuardRule,触发规则)`action`(GuardAction,动作)`status`(repeated string,规则状态)`applyGroup`(string,应用群范围, all / specify)... |
| 群守卫-白名单更新 | `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`(int64page)`pageSize`(int64pageSize)`total`(int64,总数)`last`(bool,是否最后) |
| 退群监听-列表 | `POST /api/wx/group/quit/plan/list` | `page`(int64, 可选,page)`pageSize`(int64, 可选,pagesize) | `list`(repeated ListItem,群守卫列表)`page`(int64page)`pageSize`(int64pageSize)`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`(int64id) |
| 退群监听-更新 | `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`(int64id)`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`(int64page)`pageSize`(int64pageSize)`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`(int64id) |
| 群转播-修改 | `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`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast) |
| 群转播-详情 | `POST /api/wx/group/relay/info` | `id`(int64, 必填,id) | `id`(int64id)`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) | 空对象或无业务数据 |
| 群转播-记录 | `POST /api/wx/group/relay/record/list` | `page`(int64, 必填,page)`pageSize`(int64, 必填,pageSize)`pid`(int64, 必填,转播计划id)`groupId`(int64, 可选,主讲群id)`status`(string, 可选,状态筛选)`botId`(int64, 可选,发送微号筛选) | `list`(repeated RecordItem,记录列表)`page`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast) |
| 群转播-手动重发 | `POST /api/wx/group/relay/resend` | `id`(int64, 必填,recordId 或者 targetId)`idType`(int64, 必填,重发类型,1:重发record的所有群,2:重发target指定的群) | 空对象或无业务数据 |
| 记录的cdn内容下载 | `POST /api/wx/group/relay/record/cdn_dl` | `recordId`(int64, 可选) | `link`(string) |
| 群转播-数据源-添加 | `POST /api/wx/group/relay/source/add` | `botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,主讲群id)`listenBotId`(int64, 必填,消息监听botId)`speakerIds`(repeated int64, 必填,主讲人ids)`shareAccount`(repeated int64, 必填,自定义分享范围);`sourceInfo`(SourceInfo, 必填,数据源详情)`name`(string, 必填,名称)`type`(string, 必填,数据源类型 group:群 meituan:美团 webhook:自定义数据源 dataoke:大淘客) | 空对象或无业务数据 |
| 群转播-数据源-修改 | `POST /api/wx/group/relay/source/update` | `id`(int64, 必填,id)`botType`(int32, 必填,类型 1 个微 2企微);`groupId`(int64, 必填,主讲群id)`listenBotId`(int64, 必填,消息监听botId)`speakerIds`(repeated int64, 必填,主讲人ids)`shareAccount`(repeated int64, 必填,自定义分享范围);`sourceInfo`(SourceInfo, 必填,数据源详情)`name`(string, 必填,名称)`type`(string, 必填,数据源类型 group:群 meituan:美团 webhook:自定义数据源 dataoke:大淘客) | 空对象或无业务数据 |
| 群转播-数据源-列表 | `POST /api/wx/group/relay/source/list` | `page`(int64, 必填,page)`pageSize`(int64, 必填,pageSize)`ids`(repeated int64, 可选,数据源ids)`botType`(int32, 必填,类型 1 个微 2企微);`category`(string, 必填,数据源类别 self:自己的 official:官方 share:分享的)`type`(string, 必填,数据源类型 group:群 meituan:美团 webhook:自定义数据源 dataoke:大淘客) | `list`(repeated HttpSourceInfoReply,列表)`page`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast) |
| 群转播-数据源-详情 | `POST /api/wx/group/relay/source/info` | `id`(int64, 必填,id) | `id`(int64id)`botType`(int32,类型 1 个微 2企微)`groupId`(int64,主讲群id)`listenBotId`(int64,消息监听botId)`speakerIds`(repeated int64,主讲人ids)`shareAccount`(repeated int64,自定义分享范围)`sourceInfo`(SourceInfo,数据源详情)`name`(string,数据源名称)`avatar`(string,群头像)`type`(string,数据源类型 group:群 meituan:美团 webhook:自定义数据源 dataoke:大淘客)... |
| 群转播-数据源-删除 | `POST /api/wx/group/relay/source/del` | `id`(int64, 必填,id) | 空对象或无业务数据 |
| 群转播-记录-转播目标 | `POST /api/wx/group/relay/record/targets` | `page`(int64, 必填,page)`pageSize`(int64, 必填,pageSize)`pid`(int64, 必填,转播计划id)`status`(string, 可选,状态筛选)`recordId`(int64, 必填,转播记录id)`botId`(int64, 可选,bot筛选)`targetIds`(repeated int64, 可选,ids筛选) | `list`(repeated Target,转播目标列表)`page`(int64page)`pageSize`(int64pageSize)`total`(int64total)`last`(boollast) |
| 群转播-记录-撤回 | `POST /api/wx/group/relay/record/retract` | `type`(int64, 必填,撤回类型,1:撤回record下所有的,2:撤回指定target)`recordId`(int64, 必填,recordId)`targetId`(int64, 可选,targetId) | 空对象或无业务数据 |
| 群转播-手动排序 | `POST /api/wx/group/relay/updatePosition` | `sourceId`(int64, 必填,移动方案id)`targetId`(int64, 必填,目标方案id) | 空对象或无业务数据 |
## 常用示例
```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}'
```