API 接口参考清单:查询消息、广播、营销活动、联系人、商机与流程端点及 HTTP 状态码
本页是 /api/v1 公开、带版本号的 REST API 的参考地图。认证细节、请求/响应信封与完整示例见 REST API 页。要获取准确且始终最新的契约,请使用安装实例内 /developers/docs 提供的生成式 OpenAPI 参考。
整理于 WAthink 万智客
本篇面向工作区管理员与集成人员。请核对当前工作区的操作权限、套餐与集成授权,按所用版本配置连接。
本篇内容
本页是 /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
状态码
| 代码 | 含义 |
|---|---|
200 / 201 | 成功。 |
401 | API 密钥缺失或过期。 |
403 | 该端点所属的套餐功能未开启。 |
422 | 校验错误 — 响应体会指明有问题的字段。 |
429 | 触发速率限制(限制按套餐分级)。 |
仍需进一步帮助?查看反馈与支持方式