إنشاء وتحديث

تقوم نقاط النهاية هذه بإنشاء وتعديل تعريف الرحلة: عنوانها، وإعداداتها، والنقاط على لوحة الرسم. هي لا تبدأ الرحلة. استخدم دورة الحياة لذلك.

كلاهما يقبل ويعيد كائن الرحلة.

نصيحة

كتابة رسم بياني كامل للرحلة في JSON أمر صعب. كل نقطة لها حقول وشروط قناة خاصة بها (مرجع النقطة). سير العمل الأكثر موثوقية هو بناء الرحلة مرة واحدة في منشئ رحلة العميل، وقراءتها مرة أخرى من استجابة إنشاء/تحديث، ثم استخدام نقاط النهاية هذه لاستنساخها أو تعديلها برمجيًا.

إنشاء

POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway

ينشئ رحلة جديدة في حالة STATUS_DRAFT.

الطلب

الحقل	مطلوب	النوع	الوصف
title	نعم	string	اسم الرحلة.
params	نعم	JourneyParams	تكوين على مستوى الرحلة. params.application_code مطلوب.
points	لا	array of Point	عناصر الرحلة على لوحة الرسم واتصالاتها.
comments	لا	array of JourneyComment	تعليقات لوحة الرسم.

مثال على الطلب

إنشاء رحلة

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Welcome series",
    "params": { "application_code": "XXXXX-XXXXX" },
    "points": [],
    "comments": []
  }'

الاستجابة

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

مثال على الاستجابة

{
  "info": {
    "uuid": "11111111-2222-3333-4444-555555555555",
    "title": "Welcome series",
    "status": "STATUS_DRAFT",
    "params": { "application_code": "XXXXX-XXXXX" }
  },
  "points": [],
  "comments": []
}

مثال رحلة كاملة

جسم Create كامل لتدفق ترحيبي صغير. الرسم البياني هو:

البدء حسب الشريحة ──افتراضي──▶ إرسال إشعار فوري ──افتراضي──▶ انتظار يوم واحد ──افتراضي──▶ مقسم بولياني ──output1──▶ إرسال بريد إلكتروني ──افتراضي──▶ خروج
                                                                                              └──افتراضي───────────────────────────▶ خروج

يتم توصيل النقاط ببعضها البعض من خلال info.next_point_uuid لكل مخرج. لاحظ مفاتيح المخرجات: كل نقطة تستخدم default، باستثناء المقسم البولياني، الذي يضيف output1 لفرع الشرط المطابق (default هو احتياطيه). نقطة الخروج ليس لها مخرجات.

{
  "title": "Welcome series",
  "params": {
    "application_code": "XXXXX-XXXXX",
    "user_id_track_change_policy": "TRACK"
  },
  "points": [
    {
      "uuid": "11111111-1111-1111-1111-111111111111",
      "title": "New signups",
      "point_type": "POINT_TYPE_START_BY_SEGMENT",
      "position": { "x": 80, "y": 200 },
      "outputs": [
        { "identity": { "key": "default", "order": 0 },
          "info": { "title": "", "next_point_uuid": "22222222-2222-2222-2222-222222222222" } }
      ],
      "point_data": {
        "start_by_segment": {
          "application_code": "XXXXX-XXXXX",
          "filter_code": "AAAAA-BBBBB"
        }
      }
    },
    {
      "uuid": "22222222-2222-2222-2222-222222222222",
      "title": "Welcome push",
      "point_type": "POINT_TYPE_SEND_PUSH",
      "position": { "x": 340, "y": 200 },
      "outputs": [
        { "identity": { "key": "default", "order": 0 },
          "info": { "title": "", "next_point_uuid": "33333333-3333-3333-3333-333333333333" } }
      ],
      "point_data": {
        "send_push": {
          "application_code": "XXXXX-XXXXX",
          "title": "Welcome!",
          "content": "Thanks for joining — here's how to get started."
        }
      }
    },
    {
      "uuid": "33333333-3333-3333-3333-333333333333",
      "title": "Wait 1 day",
      "point_type": "POINT_TYPE_WAIT",
      "position": { "x": 600, "y": 200 },
      "outputs": [
        { "identity": { "key": "default", "order": 0 },
          "info": { "title": "", "next_point_uuid": "44444444-4444-4444-4444-444444444444" } }
      ],
      "point_data": {
        "delay": { "sec": 86400 }
      }
    },
    {
      "uuid": "44444444-4444-4444-4444-444444444444",
      "title": "Opened the push?",
      "point_type": "POINT_TYPE_BOOLEAN_SPLITTER",
      "position": { "x": 860, "y": 200 },
      "outputs": [
        { "identity": { "key": "output1", "order": 1 },
          "info": { "title": "Matched", "next_point_uuid": "55555555-5555-5555-5555-555555555555" } },
        { "identity": { "key": "default", "order": 0 },
          "info": { "title": "Everyone else", "next_point_uuid": "66666666-6666-6666-6666-666666666666" } }
      ],
      "point_data": {
        "boolean_splitter": {
          "split_strategy": "SPLIT_FILTER",
          "load_policy": "ALL",
          "filter_code": "CCCCC-DDDDD"
        }
      }
    },
    {
      "uuid": "55555555-5555-5555-5555-555555555555",
      "title": "Follow-up email",
      "point_type": "POINT_TYPE_SEND_EMAIL",
      "position": { "x": 1120, "y": 120 },
      "outputs": [
        { "identity": { "key": "default", "order": 0 },
          "info": { "title": "", "next_point_uuid": "66666666-6666-6666-6666-666666666666" } }
      ],
      "point_data": {
        "send_email": {
          "application_code": "XXXXX-XXXXX",
          "preset_code": "12345-67890"
        }
      }
    },
    {
      "uuid": "66666666-6666-6666-6666-666666666666",
      "title": "Exit",
      "point_type": "POINT_TYPE_EXIT",
      "position": { "x": 1380, "y": 200 },
      "outputs": [],
      "point_data": {
        "terminator": {}
      }
    }
  ],
  "comments": []
}

تحديث

PUT https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/{uuid}

يستبدل تعريف رحلة موجودة. أرسل التعريف الكامل. النقاط والتعليقات التي ترسلها تستبدل الحالية.

معلمات المسار

الاسم	النوع	الوصف
uuid	string	معرف الرحلة للتحديث.

الطلب

الحقل	النوع	الوصف
title	string	اسم الرحلة الجديد.
params	JourneyParams	تكوين جديد على مستوى الرحلة.
points	array of Point	مجموعة كاملة جديدة من النقاط.
comments	array of JourneyComment	مجموعة كاملة جديدة من التعليقات.
autosave	bool	عندما تكون true، يتم التعامل مع التغيير كحفظ تلقائي للمحرر. القيمة الافتراضية هي false.

مثال على الطلب

إعادة تسمية وإعادة تكوين رحلة

curl -X PUT https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/11111111-2222-3333-4444-555555555555 \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Welcome series v2",
    "params": { "application_code": "XXXXX-XXXXX" },
    "points": [],
    "comments": []
  }'

الاستجابة

يعيد كائن الرحلة المحدث.

تحديث واستئناف

POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/{uuid}/resume

يطبق التعديلات على رحلة ويستأنفها في استدعاء واحد. هذا يعادل تحديث متبوعًا بـ بدء دورة الحياة. يتطابق جسم الطلب مع تحديث. استخدم هذا عند تعديل رحلة متوقفة مؤقتًا تريد إعادتها إلى حالة STATUS_RUNNING.

إعادة تسمية

POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/{uuid}/rename

يغير عنوان الرحلة فقط، دون المساس بنقاطها أو إعداداتها.

الحقل	مطلوب	النوع	الوصف
title	نعم	string	اسم الرحلة الجديد.

مثال على الطلب

إعادة تسمية رحلة

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/11111111-2222-3333-4444-555555555555/rename \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Welcome series (Q3)" }'

ذات صلة

كائن الرحلة

دورة الحياة

البدء بواسطة API