วงจรการทำงาน

endpoint ของวงจรการทำงานจะย้าย journey ไปยังสถานะต่างๆ ส่ง Journey ID ของ journey เป็น uuid ใน request body การเรียกจะส่งคืน journey object ที่อัปเดตแล้ว

Journey จะอยู่ในสถานะใดสถานะหนึ่งเสมอ:

สถานะ	ความหมาย
STATUS_DRAFT	กำลังแก้ไข ไม่ประมวลผลผู้ใช้
STATUS_RUNNING	ทำงานอยู่ กำลังประมวลผลผู้ใช้
STATUS_PAUSED	หยุดชั่วคราว สามารถกลับมาทำงานต่อได้
STATUS_FINISHED	หยุดแล้ว ไม่ประมวลผลผู้ใช้แล้ว สามารถหยุดชั่วคราวเพื่อกลับไปแก้ไข หรือจัดเก็บได้
STATUS_ARCHIVED	จัดเก็บเพื่อการเก็บรักษา เป็นสถานะสุดท้าย — ไม่สามารถเปิดใช้งานอีกครั้งผ่าน endpoint เหล่านี้ได้

Endpoints

การเรียกวงจรการทำงานทั้งหมดใช้ request body เดียวกัน: Journey ID ที่ส่งเป็น uuid ซึ่งจะแตกต่างกันที่ path เท่านั้น:

การดำเนินการ	เมธอดและ path	สถานะผลลัพธ์
เริ่ม	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	จัดเก็บ

การจัดเก็บเป็นขั้นตอนเดียวในตารางนี้ที่ไม่สามารถย้อนกลับผ่าน endpoint ของวงจรการทำงานได้

คำขอ (Request)

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
uuid	ใช่	string	Journey ID ของ journey ที่จะเปลี่ยนสถานะ

Body

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

API จะตรวจสอบสถานะปัจจุบันก่อนที่จะเปลี่ยนสถานะ — ดูตารางด้านบน ตัวอย่างเช่น การเริ่ม journey ที่ถูกจัดเก็บแล้วจะส่งคืนข้อผิดพลาด เนื่องจากไม่มีการเปลี่ยนสถานะย้อนกลับสำหรับการจัดเก็บ

หมายเหตุ

หากต้องการเริ่ม journey และใช้การแก้ไขที่รอดำเนินการในการเรียกครั้งเดียว ให้ใช้ Update and resume แทน start

ตัวอย่างคำขอ

เริ่ม journey

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" }'

หยุด journey ชั่วคราว

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" }'

การตอบกลับ (Response)

ส่งคืน journey object ที่อัปเดตแล้ว: 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 สำหรับรายการฟิลด์ทั้งหมด

ที่เกี่ยวข้อง

สร้างและอัปเดต

เริ่มโดย API

อ็อบเจกต์ Journey