WAthink 使用手册

API 接口参考清单:查询消息、广播、营销活动、联系人、商机与流程端点及 HTTP 状态码

本页是 /api/v1 公开、带版本号的 REST API 的参考地图。认证细节、请求/响应信封与完整示例见 REST API 页。要获取准确且始终最新的契约,请使用安装实例内 /developers/docs 提供的生成式 OpenAPI 参考。

本篇面向工作区管理员与集成人员。请核对当前工作区的操作权限、套餐与集成授权,按所用版本配置连接。
本篇内容

本页是 /api/v1 公开、带版本号的 REST API 的参考地图。认证细节、请求/响应信封与完整示例见 REST API 页。要获取准确且始终最新的契约,请使用安装实例内 /developers/docs 提供的生成式 OpenAPI 参考。

一行式认证。每个请求都以 Authorization: Bearer 或 X-Api-Key 携带工作区密钥(wsk_…),且仅作用于该工作区。

消息

端点作用
POST /messages向某个号码发送消息(文本 / 位置)。
GET /messages列出消息。
GET /messages/{id}读取单条消息及其投递状态。

广播、营销活动与定时发送

端点作用
GET/POST /broadcasts列出 / 创建一次性群发。
GET /broadcasts/{id}、/recipients、/stop读取广播、其逐收件人状态,或停止广播。
GET/POST /campaigns列出 / 创建受管理的营销活动。
GET /campaigns/{id}、/stop、DELETE;GET /campaigns/statistics读取营销活动、停止或删除它;读取工作区营销活动统计。
POST /scheduled把一次发送加入队列,在未来时间执行。

CRM 与管线

端点作用
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(+ 按 id 操作)管理消息模板。
GET/POST /auto-replies(+ 按 id 操作)管理关键词 / 自动应答规则。

设备、账户与 Webhook

端点作用
GET /devices、GET /devices/{id}列出已连接的发送方及其状态。
GET /me读取当前工作区 / 密钥上下文。
事件 Webhook在你自己的服务器上接收入站与投递事件 — 见 第三方集成 与 Webhooks。

状态码

代码含义
200 / 201成功。
401API 密钥缺失或过期。
403该端点所属的套餐功能未开启。
422校验错误 — 响应体会指明有问题的字段。
429触发速率限制(限制按套餐分级)。
仍需进一步帮助?查看反馈与支持方式

文档目录

返回官网

搜索操作文档

正在准备文档索引…

↑ ↓ 切换结果 · Enter 打开Esc 关闭