生命周期

生命周期端点用于在不同状态之间移动旅程。在请求正文中将旅程的 Journey ID 作为 uuid 传递。该调用会返回更新后的 journey 对象。

一个旅程总是处于以下状态之一：

状态	含义
`STATUS_DRAFT`	正在编辑。不处理用户。
`STATUS_RUNNING`	活动状态，正在处理用户。
`STATUS_PAUSED`	暂时停止，可以恢复。
`STATUS_FINISHED`	已停止，不再处理用户。可以暂停以恢复编辑，或进行归档。
`STATUS_ARCHIVED`	已归档以供存储。这是最终状态——无法通过这些端点重新激活。

端点

所有生命周期调用都使用相同的请求正文：将 Journey ID 作为 uuid 传递。它们仅在路径上有所不同：

操作	方法和路径	结果状态
启动	`POST /api/v3/journeygateway/start`	`STATUS_RUNNING`
暂停	`POST /api/v3/journeygateway/pause`	`STATUS_PAUSED`
完成	`POST /api/v3/journeygateway/finish`	`STATUS_FINISHED`
归档	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

有效转换

从	到	通过
`STATUS_DRAFT`	`STATUS_RUNNING`	启动
`STATUS_RUNNING`	`STATUS_PAUSED`	暂停
`STATUS_PAUSED`	`STATUS_RUNNING`	启动
`STATUS_RUNNING`	`STATUS_FINISHED`	完成
`STATUS_PAUSED`	`STATUS_FINISHED`	完成
`STATUS_FINISHED`	`STATUS_PAUSED`	暂停
`STATUS_FINISHED`	`STATUS_ARCHIVED`	归档

在此表中，归档是唯一无法通过生命周期端点逆转的步骤。

请求

字段	必需	类型	描述
`uuid`	是	string	要转换状态的旅程的 Journey ID。

{ "uuid": "11111111-2222-3333-4444-555555555555" }

API 会在转换状态前验证当前状态——请参见上表。例如，启动一个已归档的旅程会返回错误，因为归档没有逆向转换。

请求示例

启动旅程

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/start \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

暂停旅程

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/pause \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

响应

返回更新后的 journey 对象：info、points 和 comments。info.status 字段反映了新的状态。

响应示例

{
  "info": {
    "uuid": "11111111-2222-3333-4444-555555555555",
    "title": "Welcome series",
    "status": "STATUS_RUNNING",
    "created_at": "2026-05-01T09:00:00Z",
    "updated_at": "2026-06-17T12:00:00Z",
    "params": { "application_code": "XXXXX-XXXXX" },
    "campaign_type": "TriggerBased"
  },
  "points": [],
  "comments": []
}

有关完整的字段列表，请参阅 journey 对象参考。