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

2026-07-02 09:29:31 +08:00
parent 1f4a00a0b0
commit 7d9f09c0bf
8 changed files with 92 additions and 71 deletions
@@ -21,7 +21,8 @@ description: 当用户需要通过海豚私域 htsy-cli 操作账号、用户、
 htsy-cli status
 htsy-cli login --username USER --password PASS
 htsy-cli call /api/account/user/info -d '{}'
-htsy-cli call /api/bot/wx/list -d '{"page":1,"pageSize":20,"botType":1}'
+htsy-cli call /api/bot/wx/list -d '{"page":1,"pageSize":20,"botType":1}'   # 个微
+htsy-cli call /api/bot/wx/list -d '{"page":1,"pageSize":20,"botType":2}'   # 企微
 htsy-cli call /api/bot/wx/list -d @request.json
 ```

@@ -48,5 +49,6 @@ htsy-cli call /api/bot/wx/list -d @request.json
 - 不要在回答里输出用户密码、token 或 `.htsy/config.json` 的完整内容。
 - 不确定字段时，先读对应模块参考，不要臆造请求字段。
 - `botType` 常用取值：`1` 个微，`2` 企微。
+- 企微接口需要 `corpId` 时，先调用 `POST /api/bot/wx/corp/list` 获取主体列表，返回项的 `id` 就是请求里的 `corpId`。
 - 时间字段如未特别说明，按毫秒时间戳处理。
 - 不面向用户直接调用的协议实例、Cron、客户端节点、回调上报、内部专用、第三方特供接口不要主动提供给用户。