जीवनचक्र

जीवनचक्र एंडपॉइंट्स एक Journey को विभिन्न स्थितियों के बीच ले जाते हैं। अनुरोध बॉडी में uuid के रूप में Journey का Journey ID पास करें। कॉल अपडेटेड Journey ऑब्जेक्ट लौटाता है।

एक 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 का Journey ID।

बॉडी

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

API ट्रांज़िशन से पहले वर्तमान स्थिति को मान्य करता है — ऊपर दी गई तालिका देखें। उदाहरण के लिए, एक संग्रहीत Journey शुरू करने पर एक त्रुटि लौटाई जाती है, क्योंकि संग्रहीत करने का कोई रिवर्स ट्रांज़िशन नहीं है।

नोट

एक ही कॉल में Journey शुरू करने और लंबित संपादनों को लागू करने के लिए, 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" }'

प्रतिक्रिया

अपडेटेड 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 ऑब्जेक्ट संदर्भ देखें।

संबंधित

बनाएं और अपडेट करें

API द्वारा शुरू करें

Journey ऑब्जेक्ट