معرفات API الرئيسية

يسرد هذا المقال المعرفات الأساسية المستخدمة في طلبات Pushwoosh API. هذه المعرفات مطلوبة للمصادقة، وإنشاء الرسائل، والاستهداف، والتقسيم، والتتبع، وإدارة المستخدمين عبر تطبيقاتك.

معرف فريد يتم تعيينه لكل تطبيق في حساب Pushwoosh الخاص بك. وهو مطلوب في معظم استدعاءات API لتحديد التطبيق المستهدف.

أين تجده

Pushwoosh Control Panel → أسفل اسم التطبيق.

رمز فريد يتم تعيينه لحساب Pushwoosh، يستخدم لمصادقة طلبات API. يتيح الوصول لإدارة المشاريع، وإرسال الرسائل، وتعديل الإعدادات، واسترداد البيانات. لكل حساب رمز واحد على الأقل يتم إنشاؤه افتراضيًا. اعرف المزيد

أين تجده

Pushwoosh Control Panel → API Access.

معرف فريد يتم تعيينه للجهاز بواسطة Pushwoosh SDK. يتم تعيينه تلقائيًا بواسطة SDK أو يتم تمريره أثناء تسجيل الجهاز. اعرف المزيد

أين تجده

• في سجلات الجهاز. اعرف المزيد

• في User Explorer عند البحث بواسطة User ID

• في ملف CSV الذي تم تنزيله من قائمة الشرائح (Segments)

رمز مميز صادر عن مزودي المنصات يحدد زوج التطبيق-الجهاز لتوصيل إشعارات الدفع. يتم جمعه تلقائيًا بواسطة SDK عند منح أذونات الدفع. اعرف المزيد

أين تجده

• في سجلات الجهاز. اعرف المزيد

• في User Explorer، أدخل HWID في حقل البحث للعثور على الجهاز المرتبط، ثم افتح تفاصيل الجهاز لعرض الرمز المميز للدفع.

يشير إلى منصة الجهاز المستهدف باستخدام رمز رقمي. يتم تعيينه تلقائيًا بواسطة SDK.

القيم المدعومة:

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
13 – Internet Explorer
14 – Email
17 – Huawei
18 – SMS
20 – Web
21 – WhatsApp
22 – Line
23 – Kakao Talk
24 – Telegram
25 – Apple Wallet
26 – Google Wallet
27 – Viber

معرف مخصص يتم تعيينه للمستخدم، مما يتيح الاستهداف عبر الأجهزة والشخصي. اعرف المزيد

أين تجده

Pushwoosh Control Panel → الجمهور → User Explorer

معرف فريد يتم تعيينه لكل رسالة عند إنشائها. يتبع تنسيقًا محددًا: XXXX-XXXXXXXX-XXXXXXXX.

هذا الرمز ضروري لـ:

• تتبع حالة وتسليم رسالة معينة
• إلغاء (أو حذف) رسالة تم إرسالها مسبقًا
• الحصول على إحصائيات الرسالة

أين تجده

• Pushwoosh Control Panel: انتقل إلى الحملات → رسائل لمرة واحدة، ثم افتح خصائص الرسالة المطلوبة. سيتم عرض رمز الرسالة هناك.
• استجابة API /createMessage: عند إنشاء رسالة جديدة عبر API، يتم تضمين رمز الرسالة في الاستجابة.

يربط رسالة بطلب HTTP الذي أنشأها، مما يتيح لك تتبع إرسال واحد من البداية إلى النهاية — من استدعاء HTTP عبر طبقة توجيه Pushwoosh إلى الرسالة الناتجة.

موجود في أي رسالة تم إنشاؤها بواسطة استدعاء HTTP إلى /createMessage أو Messaging API v2، بما في ذلك الرسائل المرسلة من Control Panel. الرسائل التي تم إنشاؤها بواسطة Journeys، أو عمليات الإرسال المجدولة (cron)، أو المشغلات الداخلية الأخرى غير HTTP ليس لها معرف طلب (Request ID).

تعيين القيمة الخاصة بك

مرر رأس X-Request-ID مع الطلب. إذا كانت القيمة بطول 8-128 حرفًا وتحتوي فقط على أحرف لاتينية وأرقام ونقاط وشرطات سفلية وواصلات، فإن Pushwoosh يعيد استخدامها؛ وإلا — أو إذا تم حذف الرأس — فإن Pushwoosh ينشئ واحدًا لك. يتم استبدال القيمة غير الصالحة بصمت، لذلك لا يفشل الطلب أبدًا بسببها. لا يتم فرض التفرد، لذا استخدم قيمة فريدة بالفعل لكل طلب إذا كنت تعتمد عليها للتتبع.

أين تجده

Pushwoosh Control Panel → افتح رسالة → تفاصيل الرسالة → إظهار جميع الخصائص → إعدادات الرسالة → معرف الطلب (Request ID) (مع زر نسخ).

مثال: a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d

رمز فريد يحدد حملة رسائل فورية داخل التطبيق (instant in-app). أين تجده

Pushwoosh Control Panel → الحملات → رسائل فورية داخل التطبيق. في القائمة، يتم عرض الرمز أسفل اسم الحملة.

مثال: AAAAA-BBBBB

معرف لإعداد مسبق محفوظ للرسالة (على سبيل المثال، push أو SMS). اعرف المزيد

أين تجده

Pushwoosh Control Panel → المحتوى → الإعدادات المسبقة.

يمكنك العثور على رمز الإعداد المسبق في مكانين:

• في عرض القائمة، معروضًا أسفل اسم الإعداد المسبق.

• في عنوان URL عند تحرير أو إنشاء إعداد مسبق (إنه الجزء الأخير من عنوان URL).

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

رمز الإعداد المسبق: AAAAA-BBBBB

معرف لقالب رسالة داخل التطبيق. اعرف المزيد

أين تجده

Pushwoosh Control Panel → المحتوى → الوسائط الغنية.

مثال: URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics رمز الوسائط الغنية: AAAAA-BBBBB

رمز محتوى البريد الإلكتروني هو معرف فريد لمحتوى البريد الإلكتروني المحفوظ. اعرف المزيد

أين تجده

Pushwoosh Control Panel → المحتوى → محتوى البريد الإلكتروني.

الرمز هو الجزء الأخير من عنوان URL.

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB رمز محتوى البريد الإلكتروني: AAAAA-BBBBB

معرف فريد يستخدم للإشارة إلى حملة معينة للتتبع والتحليل.

أين تجده

يظهر رمز الحملة في عنوان URL عند عرض الإحصائيات المتعلقة بالحملة في Pushwoosh Control Panel. لتحديد موقعه، انتقل إلى الإحصائيات → الإحصائيات المجمعة، انقر على الحملة المطلوبة، وانسخ الرمز الموجود في نهاية عنوان URL.

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY

رمز الحملة: YYYYY-YYYYY

معرف فريد يستخدم لربط الرسائل بحملات تسويقية معينة لتتبع وتحليل الأداء.

أين تجده

• في عنوان URL الخاص بلوحة الحملة في Pushwoosh Control Panel.
• حدد نقطة على اللوحة واضغط على Ctrl+I (Cmd+I) — ينسخ <journey UUID>/<point UUID> إلى الحافظة؛ معرف Journey هو الجزء قبل الشرطة المائلة.

مثال: URL: https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

معرف Journey: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

اسم شريحة مستخدمين محددة مسبقًا تم إنشاؤها في Pushwoosh لاستهداف الجمهور. اعرف المزيد

أين تجده

Pushwoosh Control Panel → الشرائح.

رمز فريد بالتنسيق XXXXX-XXXXX يحدد شريحة (تسمى أيضًا فلتر) في Pushwoosh. يستخدم هذا الرمز في استدعاءات API، ومنطق الأتمتة، وقواعد التقسيم الديناميكي.

أين تجده

• عبر طريقة API /listFilters.

• في شريط العنوان عند عرض شريحة في Pushwoosh Control Panel:

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail رمز الشريحة: XXXE9-XXX49

سمة مخصصة يتم تعيينها للمستخدمين أو الأجهزة. تستخدم للتقسيم الديناميكي والتخصيص. اعرف المزيد

أين تجده

Pushwoosh Control Panel → العلامات أو عبر API /getTags.

اسم حدث يتم تتبعه (على سبيل المثال، purchase، login، subscription). يستخدم لتشغيل تدفقات عمل آلية أو للتحليلات. اعرف المزيد

أين تجده

Pushwoosh Control Panel → الجمهور → الأحداث.

يحدد منطقة مسيجة جغرافيًا تستخدم لتشغيل الإشعارات المستندة إلى الموقع. اعرف المزيد

أين تجده

Pushwoosh Control Panel → Geozones.