जीवनचक्र
जीवनचक्र एंडपॉइंट्स एक जर्नी को विभिन्न स्थितियों के बीच ले जाते हैं। रिक्वेस्ट बॉडी में जर्नी की Journey ID को uuid के रूप में पास करें। यह कॉल अपडेटेड journey object लौटाता है।
एक जर्नी हमेशा इन स्थितियों में से एक में होती है:
| स्थिति | अर्थ |
|---|---|
STATUS_DRAFT | संपादित किया जा रहा है। उपयोगकर्ताओं को प्रोसेस नहीं करता है। |
STATUS_RUNNING | सक्रिय, उपयोगकर्ताओं को प्रोसेस कर रहा है। |
STATUS_PAUSED | अस्थायी रूप से रुका हुआ है, फिर से शुरू किया जा सकता है। |
STATUS_FINISHED | पूरा हो गया है, अब उपयोगकर्ताओं को प्रोसेस नहीं कर रहा है। |
STATUS_ARCHIVED | भंडारण के लिए संग्रहीत। |
एंडपॉइंट्स
Anchor link toसभी जीवनचक्र कॉल्स एक ही रिक्वेस्ट बॉडी का उपयोग करते हैं: 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/draft | STATUS_DRAFT |
| संग्रहीत करें | POST /api/v3/journeygateway/archive | STATUS_ARCHIVED |
रिक्वेस्ट
Anchor link to| फील्ड | आवश्यक | प्रकार | विवरण |
|---|---|---|---|
uuid | हाँ | string | उस जर्नी की Journey ID जिसे ट्रांज़िशन करना है। |
{ "uuid": "11111111-2222-3333-4444-555555555555" }API ट्रांज़िशन करने से पहले वर्तमान स्थिति को मान्य करता है। उदाहरण के लिए, एक ऐसी जर्नी शुरू करना जो पहले से ही समाप्त हो चुकी है, या एक ऐसी जर्नी को रोकना जो चल नहीं रही है, एक त्रुटि लौटाता है।
रिक्वेस्ट के उदाहरण
Anchor link toएक जर्नी शुरू करें
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" }'एक जर्नी रोकें
Anchor link tocurl -X POST https://journey.pushwoosh.com/api/v3/journeygateway/pause \ -H "Authorization: Api YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'रिस्पॉन्स
Anchor link toअपडेटेड journey object लौटाता है: info, points, और comments। info.status फ़ील्ड नई स्थिति को दर्शाता है।
रिस्पॉन्स का उदाहरण
Anchor link to{ "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 object reference देखें।