انتقل إلى المحتوى
أدلة المستخدمالدعم طلب عرض توضيحي تسجيل الدخول
Pushwoosh.com

البدء عبر API

POST https://journey.pushwoosh.com/api/journey/{id}/start/external

يُدخل مجموعة من المستخدمين إلى نقطة دخول API لرحلة ما. استخدمها لتوجيه الرحلات من الواجهة الخلفية (backend) الخاصة بك. على سبيل المثال، ابدأ تدفق تأهيل (onboarding flow) عندما يكمل مستخدم التسجيل على خادمك.

المتطلبات الأساسية

Anchor link to
  • الرحلة في حالة قيد التشغيل (Running).
  • تحتوي الرحلة على نقطة دخول API واحدة بالضبط (عنصر “البدء عبر API”)، وهذا العنصر غير معطل.
  • أسماء السمات التي ترسلها تتطابق مع السمات المكونة في نقطة دخول API تلك.

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

Anchor link to
الاسمالنوعالوصف
idstringمعرف الرحلة (Journey ID) للرحلة قيد التشغيل.

ترويسات الطلب

Anchor link to
الاسممطلوبالقيمة
Content-Typeنعمapplication/json
AuthorizationنعمApi <server_api_token>. انظر رمز API للخادم (Server API token).

محتوى الطلب

Anchor link to

يحتوي المحتوى على كائن payload واحد. يجب عليك توفير واحد فقط من users أو hwids أو filter لتحديد من يدخل الرحلة.

الحقلالنوعالوصف
payload.usersstring[]معرفات المستخدمين (User IDs) للدخول. لا يمكن استخدامها مع hwids و filter.
payload.hwidsstring[]معرفات الأجهزة (HWIDs) للدخول. لا يمكن استخدامها مع users و filter.
payload.filterstringتعبير seglang يحدد الجمهور. لا يمكن استخدامه مع users و hwids.
payload.attribute_valuesmap<string, string>اختياري. قيم للسمات المخصصة المحددة في نقطة دخول API. يجب أن يتطابق كل مفتاح مع اسم سمة مكون.

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

Anchor link to
إدخال مستخدمين محددين
Anchor link to
Terminal window
curl -X POST 'https://journey.pushwoosh.com/api/journey/<journey_id>/start/external' \
  -H 'Authorization: Api YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": {
      "users": ["user-123", "user-456"]
    }
  }'
إدخال مستخدمين محددين مع سمات
Anchor link to
{
  "payload": {
    "users": ["user-123", "user-456"],
    "attribute_values": {
      "promo_code": "SUMMER25",
      "tier": "gold"
    }
  }
}
إدخال جمهور حسب الفلتر
Anchor link to
{
  "payload": {
    "filter": "A(\"XXXXX-XXXXX\").tags(\"City\").eq(\"London\")"
  }
}

الاستجابة

Anchor link to
{
  "request_uuid": "9f8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d"
}
الحقلالنوعالوصف
request_uuidstringمعرف طلب الدخول المقبول. تتم معالجة الطلب بشكل غير متزامن.

مواضيع ذات صلة

Anchor link to
دورة الحياة
الحصول على إحصائيات الرحلة
لغة التجزئة