دورة الحياة

تنقل نقاط نهاية دورة الحياة أي Journey بين الحالات. مرر معرف Journey الخاص بـ Journey كـ uuid في جسم الطلب. يعيد الاستدعاء كائن Journey المحدث.

تكون Journey دائمًا في إحدى هذه الحالات:

الحالة	المعنى
`STATUS_DRAFT`	قيد التحرير. لا تعالج المستخدمين.
`STATUS_RUNNING`	نشطة، تعالج المستخدمين.
`STATUS_PAUSED`	متوقفة مؤقتًا، يمكن استئنافها.
`STATUS_FINISHED`	متوقفة، لم تعد تعالج المستخدمين. يمكن إيقافها مؤقتًا لاستئناف التحرير، أو أرشفتها.
`STATUS_ARCHIVED`	مؤرشفة للتخزين. حالة نهائية — لا يمكن إعادة تنشيطها من خلال نقاط النهاية هذه.

نقاط النهاية

تستخدم جميع استدعاءات دورة الحياة نفس جسم الطلب: معرف Journey الذي يتم تمريره كـ 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 المراد نقلها.

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

يتحقق API من الحالة الحالية قبل الانتقال — انظر الجدول أعلاه. على سبيل المثال، بدء Journey مؤرشفة يعيد خطأ، لأن الأرشفة ليس لها انتقال عكسي.

أمثلة على الطلبات

بدء 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