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-automation.md
+12 -9
View File
@@ -38,7 +38,7 @@
| sop-记录 | `POST /api/sop/record` | `sopType`(string, 必填，sop类型：标签模版 tag 新客模版 newFriend)；`id`(int64, 必填，id)；`itemId`(int64, 必填，itemId)；`page`(int64, 必填，page)；`pageSize`(int64, 必填，pageSize)；`startTime`(int64, 必填，开始时间)；`endTime`(int64, 必填，结束时间)；`sopBotId`(int64, 必填，应用微号的方案id) | `list`(repeated SopRecordItem，客户列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后)；`pushMode`(string，推送模式 极速群发 fastPush 正常模式 common) |
| sop-应用列表 | `POST /api/sop/apply/list` | `page`(int64, 必填，page)；`pageSize`(int64, 必填，pageSize) | `list`(repeated SopApplyInfoItem，应用列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，总数)；`last`(bool，是否最后) |
| sop-应用微号 | `POST /api/sop/apply/bot` | `sopType`(string, 必填，sop类型：标签模版 tag 新客模版 newFriend)；`id`(int64, 必填，id)；`applyType`(string, 必填，应用类型 所有微号 all 单号模式-指定 specify)；`botIds`(repeated int64, 必填，botIds)；`sopId`(int64, 必填，sopId)；`qwTag`(QwTagCondition, 可选，企微标签列表)；`name`(string, 必填，名称)；`pushMode`(string, 必填，推送模式 极速群发 fastPush 正常模式 common)；`stopSopQwTag`(QwTagCondition, 可选，停止sop任务的标签)；`condition`(repeated Condition, 可选，条件)；`isNoTriggerByCondition`(bool, 可选，true 满足条件不触发 false 满足条件触发)；`isStopByNoMeetCondition`(bool, 可选，不符合条件停止)；`conditionTriggerMode`(string, 可选，触发条件模式 and 满足所有条件 or 满足任意条件) | `sopType`(string，sop类型：标签模版 tag 新客模版 newFriend)；`id`(int64，id) |
| sop-应用Sop的详情 | `POST /api/sop/apply/info` | `id`(int64, 必填，id) | `id`(int64，id)；`sopId`(int64，sopId)；`sopType`(string，sop类型：标签模版 tag 新客模版 newFriend)；`applyType`(string，应用类型 所有微号 all 单号模式-指定 specify)；`applyBotInfo`(repeated ApplyBotInfo，单号模式-指定 应用微号信息)；`qwTag`(QwTagCondition，企微标签列表)；`name`(string，名称)；`sopTag`(SopTag，标签模版)；`sopNewFriend`(SopNewFriend，新客模版)；`botType`(int64，1 个微 2 企微)；... |
| sop-应用Sop的详情 | `POST /api/sop/apply/info` | `id`(int64, 必填，id) | `id`(int64，id)；`sopId`(int64，sopId)；`sopType`(string，sop类型：标签模版 tag 新客模版 newFriend)；`applyType`(string，应用类型 所有微号 all 单号模式-指定 specify)；`applyBotInfo`(repeated ApplyBotInfo，单号模式-指定 应用微号信息)；`qwTag`(QwTagCondition，企微标签列表)；`name`(string，名称)；`sopTag`(SopTag，标签模版)；`sopNewFriend`(SopNewFriend，新客模版)；`botType`(int32，1 个微 2 企微)；... |
| sop-应用Sop删除 | `POST /api/sop/apply/del` | `id`(int64, 必填，id) | 空对象或无业务数据 |
@@ -101,11 +101,11 @@
| 手动触发检查 | `POST /api/addListener/check/trigger` | `planId`(int64, 必填，计划ID) | 空对象或无业务数据 |
| 重置统计计数 | `POST /api/addListener/stats/reset` | `planId`(int64, 必填，计划ID)；`botIds`(repeated int64, 可选，指定重置的微信号IDs，为空则重置计划下所有微信号) | 空对象或无业务数据 |
| 中控群-列表 | `POST /api/central/control/group/list` | `page`(int64, 必填，page)；`pageSize`(int64, 必填，pageSize) | `list`(repeated CentralControlGroupItem，列表)；`page`(int64，page)；`pageSize`(int64，pageSize)；`total`(int64，total)；`last`(bool，last) |
| 中控群-添加 | `POST /api/central/control/group/add` | `id`(int64, 可选，id)；`listeningObjectList`(repeated ListeningObjectList, 必填，监听对象列表)；`targetGroupId`(int64, 必填，中控群)；`botType`(int64, 必填，1 个微 2 企微)；`msgType`(repeated string, 必填，监听的消息类型)；`userIds`(repeated int64, 必填，可见的客服)；`name`(string, 必填，名称)；`isAutoAtSender`(bool, 必填，是否自动@发送者)；`timeRange`(repeated TimeRangeItem, 必填，时间段) | `id`(int64，id) |
| 中控群-更新 | `POST /api/central/control/group/update` | `id`(int64, 可选，id)；`listeningObjectList`(repeated ListeningObjectList, 必填，监听对象列表)；`targetGroupId`(int64, 必填，中控群)；`botType`(int64, 必填，1 个微 2 企微)；`msgType`(repeated string, 必填，监听的消息类型)；`userIds`(repeated int64, 必填，可见的客服)；`name`(string, 必填，名称)；`isAutoAtSender`(bool, 必填，是否自动@发送者)；`timeRange`(repeated TimeRangeItem, 必填，时间段) | 空对象或无业务数据 |
| 中控群-详情 | `POST /api/central/control/group/info` | `id`(int64, 必填，id) | `id`(int64，id)；`listeningObjectList`(repeated ListeningObjectList，监听对象列表)；`targetGroupId`(int64，中控群)；`botType`(int64，1 个微 2 企微)；`msgType`(repeated string，监听的消息类型)；`userIds`(repeated int64，可见的客服)；`name`(string，名称)；`targetGroupName`(string，中控群昵称)；`targetGroupAvatar`(string，中控群头像)；`isAutoAtSender`(bool，是否自动@发送者)；... |
| 中控群-添加 | `POST /api/central/control/group/add` | `id`(int64, 可选，id)；`listeningObjectList`(repeated ListeningObjectList, 必填，监听对象列表)；`targetGroupId`(int64, 必填，中控群)；`botType`(int32, 必填，1 个微 2 企微)；`msgType`(repeated string, 必填，监听的消息类型)；`userIds`(repeated int64, 必填，可见的客服)；`name`(string, 必填，名称)；`isAutoAtSender`(bool, 必填，是否自动@发送者)；`timeRange`(repeated TimeRangeItem, 必填，时间段) | `id`(int64，id) |
| 中控群-更新 | `POST /api/central/control/group/update` | `id`(int64, 可选，id)；`listeningObjectList`(repeated ListeningObjectList, 必填，监听对象列表)；`targetGroupId`(int64, 必填，中控群)；`botType`(int32, 必填，1 个微 2 企微)；`msgType`(repeated string, 必填，监听的消息类型)；`userIds`(repeated int64, 必填，可见的客服)；`name`(string, 必填，名称)；`isAutoAtSender`(bool, 必填，是否自动@发送者)；`timeRange`(repeated TimeRangeItem, 必填，时间段) | 空对象或无业务数据 |
| 中控群-详情 | `POST /api/central/control/group/info` | `id`(int64, 必填，id) | `id`(int64，id)；`listeningObjectList`(repeated ListeningObjectList，监听对象列表)；`targetGroupId`(int64，中控群)；`botType`(int32，1 个微 2 企微)；`msgType`(repeated string，监听的消息类型)；`userIds`(repeated int64，可见的客服)；`name`(string，名称)；`targetGroupName`(string，中控群昵称)；`targetGroupAvatar`(string，中控群头像)；`isAutoAtSender`(bool，是否自动@发送者)；... |
| 中控群-删除 | `POST /api/central/control/group/del` | `ids`(repeated int64, 必填，ids) | 空对象或无业务数据 |
| 获取原先群的信息 | `POST /api/central/control/group/getOriginalGroup` | `msgId`(string, 必填，消息id) | `botId`(int64，微号id)；`botType`(int64，微号类型)；`chatType`(string，聊天类型)；`sender`(int64，发送者 客户就客户id 群就群就是群成员id)；`originalId`(int64，来源： 客户就客户id 群就群就是群id) |
| 获取原先群的信息 | `POST /api/central/control/group/getOriginalGroup` | `msgId`(string, 必填，消息id) | `botId`(int64，微号id)；`botType`(int32，微号类型)；`chatType`(string，聊天类型)；`sender`(int64，发送者 客户就客户id 群就群就是群成员id)；`originalId`(int64，来源： 客户就客户id 群就群就是群id) |
| 中控群关键词替换列表 | `POST /api/central/control/group/keywordReplace/list` | `{}` | `id`(int64，id)；`keywordList`(repeated string，需要替换的关键词列表)；`threePartyApi`(string，空 不使用 aliyun 使用阿里云的api)；`newKeywordList`(repeated KeywordReplaceList，支持自定义替换) |
| 中控群关键词替换更新 | `POST /api/central/control/group/keywordReplace/update` | `id`(int64, 必填，id)；`keywordList`(repeated string, 必填，需要替换的关键词列表)；`threePartyApi`(string, 必填，空 不使用 aliyun 使用阿里云的api)；`newKeywordList`(repeated KeywordReplaceList, 必填，支持自定义替换) | 空对象或无业务数据 |
| 中控群-手动排序 | `POST /api/central/control/group/updatePosition` | `sourceId`(int64, 必填，移动方案id)；`targetId`(int64, 必填，目标方案id) | 空对象或无业务数据 |
@@ -145,7 +145,7 @@
| 推广位-更新 | `POST /api/taoke/promotion/position/update` | `id`(int64, 必填，id)；`taokeId`(int64, 必填，淘客id)；`pid`(string, 必填，pid)；`name`(string, 必填，名称)；`type`(string, 必填，类型: taobao 淘宝 jd 京东 pdd 拼多多 meituan 美团) | 空对象或无业务数据 |
| 推广位-删除 | `POST /api/taoke/promotion/position/del` | `id`(int64, 必填，id) | 空对象或无业务数据 |
| 美团-选品策略 | `POST /api/taoke/meituan/productSelectionStrategy` | `{}` | `items`(repeated ProductSelectionStrategyItem)；`cities`(repeated CityItem) |
| 美团-查询订单 | `POST /api/taoke/meituan/query/product` | `platform`(int64, 可选，1 到家及其他业务类型，2 到店业务类型（包含到店美食、休闲生活、酒店、门票）；不填则默认1)；`businessLine`(repeated int64, 可选，业务线标识)；`categoryIds`(repeated int64, 可选，订单品类；)；`actId`(int64, 可选，活动物料id)；`sid`(string, 可选，二级推广位id)；`orderId`(string, 可选，订单id)；`startTime`(int64, 可选，开始时间 秒)；`endTime`(int64, 可选，结束时间 秒)；`page`(int64, 可选，页码)；`limit`(int64, 可选，每页限制条数，默认100，最大支持100)；`queryTimeType`(int64, 可选，查询时间类型，枚举值， 1 按订单支付时间查询， 2 按照更新时间查询， 默认为1)；`tradeType`(int64, 可选，交易类型，1表示CPS，2表示CPA)；`scrollId`(string, 可选，分页id，当searchType选择2逐页查询时，本字段为必填。若不填写，默认查询首页。取值为上一页查询时出参的scrollId字段)；`searchType`(int64, 可选，订单分页查询方案选择，不填则默认为1。)；`cityNames`(repeated string, 可选，可输入城市名称圈定特定城市的订单，单次最多查询10个城市（英文逗号分隔）。)；`scrmOrderMode`(int64, 可选，订单查询模式，0:查普通订单，1:查推品订单，不填默认0)；`promotionPositionId`(int64, 可选，推广位id) | `QueryOrderReply`(google.protobuf.Struct，查询美团订单的接口返回data) |
| 美团-查询订单 | `POST /api/taoke/meituan/query/product` | `platform`(int64, 可选，1 到家及其他业务类型，2 到店业务类型（包含到店美食、休闲生活、酒店、门票）；不填则默认1)；`businessLine`(repeated int64, 可选，业务线标识)；`categoryIds`(repeated int64, 可选，订单品类；)；`actId`(int64, 可选，活动物料id)；`sid`(string, 可选，二级推广位id)；`orderId`(string, 可选，订单id)；`startTime`(int64, 可选，开始时间 秒)；`endTime`(int64, 可选，结束时间 秒)；`page`(int64, 可选，页码)；`limit`(int64, 可选，每页限制条数，默认100，最大支持100)；`queryTimeType`(int64, 可选，查询时间类型，枚举值， 1 按订单支付时间查询， 2 按照更新时间查询， 默认为1)；`tradeType`(int64, 可选，交易类型，1表示CPS，2表示CPA)；`scrollId`(string, 可选，分页id，当searchType选择2逐页查询时，本字段为必填。若不填写，默认查询首页。取值为上一页查询时出参的scrollId字段)；`searchType`(int64, 可选，订单分页查询方案选择，不填则默认为1。)；`cityNames`(repeated string, 可选，可输入城市名称圈定特定城市的订单，单次最多查询10个城市（英文逗号分隔）。)；`scrmOrderMode`(int64, 可选，订单查询模式，0:查普通订单，1:查推品订单，不填默认0)；`promotionPositionId`(int64, 可选，推广位id) | `data`(google.protobuf.Struct，查询美团订单的接口返回数据) |
| 推广位-拼多多推广位备案 | `POST /api/taoke/pdd/promotionPosition/auth` | `promotionPositionId`(int64, 可选，推广位id) | `link`(string) |
@@ -157,7 +157,10 @@ _暂无公开接口。_
## 常用示例
```bash
htsy-cli call /api/keyword/list -d '{"page":1,"pageSize":20,"botType":1}'
htsy-cli call /api/messagePush/list -d '{"page":1,"pageSize":20,"botType":1}'
htsy-cli call /api/sop/list -d '{"page":1,"pageSize":20,"botType":1}'
# 关键词方案列表（botType 可选：1 个微 2 企微）
htsy-cli call /api/keyword/list -d '{"page":1,"pageSize":20,"botType":2}'
# 群发计划列表（该接口无 botType 字段；statusList 见字段表：success/fail/executing/stop/running）
htsy-cli call /api/messagePush/list -d '{"page":1,"pageSize":20,"statusList":["success","fail"]}'
# SOP 列表（sopType 必填，不传会返回 400：标签模版 tag / 新客模版 newFriend）
htsy-cli call /api/sop/list -d '{"page":1,"pageSize":20,"sopType":"tag"}'
```