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

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

المعرفات العامة

رمز التطبيق

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

أين تجده

Pushwoosh Control Panel ← تحت اسم التطبيق.

رمز الوصول إلى API

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

أين تجده

Pushwoosh Control Panel ← API Access.

معرفات الجهاز

معرف الجهاز (Hardware ID)

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

أين تجده

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

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

• في ملف CSV الذي تم تنزيله من Segments list

رمز الدفع (Push token)

رمز صادر عن مزودي المنصات يحدد زوج التطبيق-الجهاز لتوصيل إشعارات الدفع. يتم جمعه تلقائيًا بواسطة 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

معرفات المستخدم

معرف المستخدم (User ID)

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

أين تجده

Pushwoosh Control Panel ← Audience → User Explorer

معرفات الرسائل

رمز الرسالة

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

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

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

أين تجده

• Pushwoosh Control Panel: انتقل إلى Campaigns ← One-time messages، ثم افتح properties للرسالة المطلوبة. سيتم عرض رمز الرسالة هناك.
• استجابة /createMessage API: عند إنشاء رسالة جديدة عبر API، يتم تضمين رمز الرسالة في الاستجابة.

معرف الطلب (Request ID)

يربط رسالة بطلب 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 ← افتح رسالة ← Message Details ← Show all properties ← Message settings ← Request ID (مع زر نسخ).

مثال: a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d

ملاحظة

هذا لا علاقة له بحقل request_id الذي تعيده نقاط النهاية غير المتزامنة/الدفعة — /getResults وطرق bulk* في Audience API. هذا request_id هو رمز مهمة تستعلم عنه للحصول على نتيجة؛ لا علاقة له بالتتبع على مستوى HTTP.

رمز In-app

رمز فريد يحدد حملة in-app فورية. أين تجده

Pushwoosh Control Panel ← Campaigns ← Instant in-apps. في القائمة، يتم عرض الرمز تحت اسم الحملة.

مثال: AAAAA-BBBBB

معرفات المحتوى

رمز الإعداد المسبق (Preset code)

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

أين تجده

Pushwoosh Control Panel ← Content → Presets.

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

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

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

مثال:

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

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

رمز الوسائط الغنية (Rich media code)

معرف لقالب رسالة in-app. اعرف المزيد

أين تجده

Pushwoosh Control Panel ← Content → Rich media.

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

رمز محتوى البريد الإلكتروني

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

أين تجده

Pushwoosh Control Panel ← Content → Email content.

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

مثال:

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

معرفات الحملة

رمز الحملة

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

أين تجده

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

مثال:

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

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

معرف Journey (Journey ID)

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

أين تجده

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

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

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

معرفات التقسيم والاستهداف

اسم الشريحة / الفلتر

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

أين تجده

Pushwoosh Control Panel ← Segments.

رمز الشريحة / الفلتر

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

أين تجده

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

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

مثال:

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

علامة (Tag)

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

أين تجده

Pushwoosh Control Panel ← Tags أو عبر /getTags API.

معرفات الأحداث

اسم الحدث

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

أين تجده

Pushwoosh Control Panel ← Audience → Events.

معرفات الموقع الجغرافي

معرف المنطقة الجغرافية (Geozone ID)

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

أين تجده

Pushwoosh Control Panel ← Geozones.