Customer Journey API 概览
Customer Journey API 允许后端以编程方式管理 Customer Journey：创建和编辑 Journey 定义，在 Journey 的生命周期中移动（启动、暂停、完成、草稿、归档），从您自己的系统触发正在运行的 Journey，以及拉取每个 Journey 的统计数据。
它与 Customer Journey 构建器使用的 API 相同，通过 gRPC-Gateway 桥接在 REST/JSON 上公开。
基础 URL
Anchor link tohttps://journey.pushwoosh.com身份验证
Anchor link to每个请求都必须包含一个 Authorization 标头，其中包含一个服务器端的 Pushwoosh API 访问令牌：
Authorization: Api YOUR_API_TOKEN管理 Journey
Anchor link to- 生命周期：
POST /api/v3/journeygateway/{action}。通过 Journey 的 UUID 启动、暂停、完成、草稿或归档一个 Journey。 - 创建和更新：
POST /api/v3/journeygateway和PUT /api/v3/journeygateway/{uuid}。创建一个新的 Journey 定义或替换一个现有的定义。
触发 Journey
Anchor link to- 通过 API 启动：
POST /api/journey/{id}/start/external。将用户注入到一个已在运行的 Journey 的 API 入口点。
统计数据和受众
Anchor link to- 获取 Journey 统计数据：
GET /api/journey/{id}/statistics/external。每个点的投放和转化指标。 - 从 Journey 中移除用户：
POST /api/journey/drop-users/external。从所有或选定的活动 Journey 中移除用户。
- Journey 对象：由生命周期、创建和更新方法返回的 Journey 定义的结构（信息、参数、点、注释）。
- 点参考：每种点类型的
point_data结构：入口、计时、拆分、操作和消息元素。
生命周期启动 vs API 启动
Anchor link toCustomer Journey 有两个操作听起来相似，但行为不同。
生命周期启动 会更改 Journey 状态（例如，从“草稿”变为运行中）。 通过 API 启动 会将用户注入到一个已在运行的 Journey 中。下表对它们进行了并排比较。
| 生命周期启动 | 通过 API 启动 | |
|---|---|---|
| 端点 | POST /api/v3/journeygateway/start | POST /api/journey/{id}/start/external |
| 作用 | 激活 Journey 并将其移至运行中状态 | 将用户注入到一个已在运行的 Journey 的API 入口点 |
| 要求的 Journey 状态 | 草稿或暂停 | 运行中（带有 API 启动点） |
| 运行频率 | 每次状态更改运行一次 | 重复运行，根据用户进入的需求 |
请求和响应格式
Anchor link to- 内容类型：
application/json。 v3字段名称使用snake_case（蛇形命名法）。枚举值序列化为其字符串名称（例如，"STATUS_RUNNING"、"POINT_TYPE_SEND_PUSH"）。- gRPC-Gateway 方法 (
/api/v3/journeygateway/...) 在成功时返回 Journey 对象，在失败时返回标准的 gRPC-Gateway 错误信封：{ "code": ..., "message": ..., "details": [...] }。 - 旧版的外部方法 (
/api/journey/...) 在成功时返回特定于方法的 JSON 主体，在验证错误时返回{ "success": false, "message": ... }并附带 HTTP400。
快速入门
Anchor link tocurl -X POST https://journey.pushwoosh.com/api/v3/journeygateway/start \ -H "Authorization: Api YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'