REST API 使用指南：生成工作区 API 访问密钥、配置 Bearer 认证请求头与消息发送调用示例
WAthink 在 /api/v1 提供公开且带版本号的 REST API，让您自己的应用、CRM 与自动化流程能以编程方式操作工作区 — 发送消息、运行广播与营销活动、定时发送，以及管理联系人、商机、流程、模板与设备。
整理于 WAthink 万智客
本篇面向工作区管理员与集成人员。请核对当前工作区的操作权限、套餐与集成授权，按所用版本配置连接。
本篇内容
WAthink 在 /api/v1 提供公开且带版本号的 REST API，让您自己的应用、CRM 与自动化流程能以编程方式操作工作区 — 发送消息、运行广播与营销活动、定时发送，以及管理联系人、商机、流程、模板与设备。
套餐功能。API 访问是付费功能。API 密钥控制台位于 More → Developers，实时且始终最新的参考文档由 /developers/docs 提供。
认证
每个请求都通过工作区 API 密钥认证。在 More → Developers 中生成密钥（完整密钥仅在创建时显示一次 — 请当场复制；数据库中只保存其哈希，且密钥可随时撤销）。
以 Bearer token 方式发送：
Authorization: Bearer wsk_your_api_key_here
… 也可以放在 X-Api-Key 请求头中。密钥仅限单个工作区，因此一个密钥只能查看和操作该工作区的数据。
工作原理
API 是覆盖仪表盘同款代码的一层轻量、安全的封装。每个端点都会校验你的请求，然后通过完全相同的控制器与发送管线处理 — 因此通过 API 发送与在仪表盘中发送的行为完全一致，包括发送路由、节流、重试与逐收件人跟踪。不存在另一条可能失步的独立发送路径。
你可以做什么
| 领域 | 端点 |
|---|---|
| 消息 | POST /messages（发送文本/位置）、GET /messages、GET /messages/{id}（投递状态） |
| 广播 | GET/POST /broadcasts、GET /broadcasts/{id}、/recipients、/stop |
| 营销活动 | GET/POST /campaigns、/statistics、GET /campaigns/{id}、/stop、删除 |
| 定时发送 | POST /scheduled |
| 联系人与分组 | GET/POST /contacts、GET/PUT/DELETE /contacts/{id}、GET/POST /contact-groups |
| 商机 | GET/POST /deals、GET/PUT/DELETE /deals/{id}（通过更新 stage_id 推进阶段） |
| 流程 | GET /flows、GET /flows/{id}、POST /flows/{id}/enroll、/subscribers |
| 模板与自动回复 | GET/POST /templates、GET/POST /auto-replies（以及按 id 读取/更新/删除） |
| 设备与账户 | GET /devices、GET /devices/{id}、GET /me |
| Webhooks | 注册事件 Webhook 以接收入站与投递事件 — 见 Webhooks |
示例：发送一条消息
curl -X POST https://your-domain.com/api/v1/messages \
-H "Authorization: Bearer wsk_your_api_key_here" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"to":"15551234567","type":"text","text":"Hello from the API"}'响应为 JSON，外层是 { data, meta } 信封；校验错误返回 422 并附带明确信息，密钥缺失或过期返回 401。
在线参考
完整、可交互的端点参考 — 包含每个请求体与响应 — 由代码生成，并在你的应用中的 /developers/docs（OpenAPI）提供。由于是生成的，它始终与运行版本一致。
仍需进一步帮助？查看反馈与支持方式