सामग्री पर जाएं

जीवनचक्र

जीवनचक्र एंडपॉइंट्स एक जर्नी को विभिन्न स्थितियों के बीच ले जाते हैं। रिक्वेस्ट बॉडी में जर्नी की 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/startSTATUS_RUNNING
रोकेंPOST /api/v3/journeygateway/pauseSTATUS_PAUSED
समाप्त करेंPOST /api/v3/journeygateway/finishSTATUS_FINISHED
ड्राफ्टPOST /api/v3/journeygateway/draftSTATUS_DRAFT
संग्रहीत करेंPOST /api/v3/journeygateway/archiveSTATUS_ARCHIVED

रिक्वेस्ट

Anchor link to
फील्डआवश्यकप्रकारविवरण
uuidहाँstringउस जर्नी की Journey ID जिसे ट्रांज़िशन करना है।
Body
{ "uuid": "11111111-2222-3333-4444-555555555555" }

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

रिक्वेस्ट के उदाहरण

Anchor link to

एक जर्नी शुरू करें

Anchor link to
Terminal window
curl -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 to
Terminal window
curl -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, और commentsinfo.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 देखें।

संबंधित

Anchor link to