# QiWe 官方文档爬取目录说明

> 供领导要求的交付包 **「① 官方文档文件夹」** 使用。与 `doc/企微客户服务-官方接口按模块统计.md`（② 接口统计）配套。

## 当前已有文件

| 文件 | 来源 URL（约） | 状态 | 说明 |
|------|----------------|------|------|
| [callback-structure.md](./callback-structure.md) | https://doc.qiweapi.com/doc-7331304 | ✅ 可用 | 含 `cmd=15000`、`msgType=13`（链接）等回调字段与示例，**1175 行** |
| [sync-history-messages.md](./sync-history-messages.md) | https://doc.qiweapi.com/api-344613926 | ❌ **爬取失败** | 内容为 Apifox 502 错误页，需 **重新爬取** |
| [images/](./images/) | — | ✅ | 配图 |

## 与 output 目录的关系

| 文件 | 路径 | 说明 |
|------|------|------|
| 平台介绍（含 API 目录树） | `output/qiweapi-test/platform-intro.md` | 与 callback-structure 前部目录类似，可作总索引 |

> 建议打 zip 时：**合并** `doc/qiweapi-scrape/` + `output/qiweapi-test/` 为 `01-官方文档/`，避免领导以为只有 2 个 md。

## 建议补爬的页面（本项目要用、尚无独立 md）

用仓库根目录 `fetch_url_to_md.py`：

```bash
python fetch_url_to_md.py -u "https://doc.qiweapi.com/doc-7562288" -o doc/qiweapi-scrape --name quick-start
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-354411522" -o doc/qiweapi-scrape --name set-callback
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613926" -o doc/qiweapi-scrape --name sync-history-messages
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613881" -o doc/qiweapi-scrape --name room-page
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613882" -o doc/qiweapi-scrape --name room-detail-batch
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-437674162" -o doc/qiweapi-scrape --name room-member-change
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613883" -o doc/qiweapi-scrape --name room-create
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613890" -o doc/qiweapi-scrape --name room-notice
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613920" -o doc/qiweapi-scrape --name pin-list
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613921" -o doc/qiweapi-scrape --name pin-add
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613906" -o doc/qiweapi-scrape --name send-text
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613923" -o doc/qiweapi-scrape --name mass-send
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613924" -o doc/qiweapi-scrape --name mass-send-status
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613869" -o doc/qiweapi-scrape --name external-contact-page
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613868" -o doc/qiweapi-scrape --name contact-detail-batch
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613937" -o doc/qiweapi-scrape --name customer-tag
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-425758709" -o doc/qiweapi-scrape --name add-room-friend
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-347221662" -o doc/qiweapi-scrape --name user-status
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613850" -o doc/qiweapi-scrape --name create-device
python fetch_url_to_md.py -u "https://doc.qiweapi.com/api-344613901" -o doc/qiweapi-scrape --name wework-file-download
```

爬取后检查 md 正文是否为接口说明（非 502/错误页）。

**用语说明：**

- 接口是否存在、怎么调，以 **https://doc.qiweapi.com/** 为准。  
- 本文件夹只是「从官网另存下来的 md」，供打 zip；**不是**接口定义本身。  
- 《官方接口按模块统计》主表已**不再**写「本地文档」列；离线副本清单见该文档**文末附录**。

## 重新生成 zip 建议结构

```text
企微客户服务-官方资料包.zip
├── 01-官方文档/
│   ├── qiweapi-scrape/          （本目录）
│   └── qiweapi-test/            （platform-intro 等）
├── 02-官方接口按模块统计.md      （见 doc/企微客户服务-官方接口按模块统计.md）
└── README.txt                   （说明①②含义、爬取日期）
```