دورة الحياة

تنقل نقاط نهاية دورة الحياة رحلة بين الحالات. مرر Journey ID الخاص بالرحلة كـ uuid في جسم الطلب. تُرجع الاستدعاء كائن 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/draft`	`STATUS_DRAFT`
أرشفة	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

الطلب

الحقل	مطلوب	النوع	الوصف
`uuid`	نعم	string	Journey ID للرحلة التي سيتم نقلها.

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

يتحقق API من الحالة الحالية قبل الانتقال. على سبيل المثال، بدء رحلة تم إنهاؤها بالفعل، أو إيقاف رحلة غير قيد التشغيل مؤقتًا، يُرجع خطأ.

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

بدء رحلة

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

إيقاف رحلة مؤقتًا

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

الاستجابة

تُرجع كائن 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