فهرس مرجع أساليب API

توفر Pushwoosh مكتبة واسعة تضم أكثر من 100 أسلوب API، مصنفة لوظائف مختلفة مثل إرسال الإشعارات، وإدارة المستخدمين، وتتبع التحليلات.

واجهة برمجة تطبيقات الرسائل (Messages API)

createMessage	ينشئ إشعار دفع جديد.
deleteMessage	يحذف رسالة مجدولة.
getMessageDetails	يسترجع تفاصيل الرسالة.
createTargetedMessage	ينشئ إشعار دفع مستهدف جديد للاستهداف المتقدم عبر تطبيقات متعددة.
getPushHistory	يحصل على سجل الرسائل مع تفاصيل الدفع.
cancelMessage	يلغي رسالة مجدولة.

واجهة برمجة تطبيقات الإعدادات المسبقة (Presets API)

createPreset	ينشئ إعدادًا مسبقًا جديدًا.
getPreset	يسترجع معلمات إعداد الدفع المسبق المحدد.
listPresets	يسترجع قائمة بالإعدادات المسبقة التي تم إنشاؤها للتطبيق.
deletePreset	يحذف إعدادًا مسبقًا من حسابك.

واجهة برمجة تطبيقات الجهاز (Device API)

registerDevice	يسجل جهازًا للتطبيق.
unregisterDevice	يزيل رمز الدفع الخاص بالجهاز.
setTags	يضبط قيم العلامات للجهاز.
getTags	يسترجع العلامات مع قيمها المقابلة لجهاز معين.
setBadge	يرسل قيمة الشارة الحالية لجهاز إلى Pushwoosh.
applicationOpen	يسجل حدث فتح التطبيق.
pushStat	يسجل حدث فتح إشعار الدفع.
messageDeliveryEvent	يسجل حدث تسليم إشعار الدفع للجهاز.

واجهة برمجة تطبيقات الجمهور (Audience API)

bulkSetTags	يضبط قيم العلامات لأجهزة متعددة.
bulkSetTags Status	يعيد حالة عملية bulkSetTags.
bulkRegisterDevice	يسجل أجهزة متعددة في طلب واحد، بما في ذلك قيم العلامات الاختيارية لكل جهاز.
bulkRegisterDevice Status	يسترجع حالة ونتائج طلب تسجيل جهاز مجمع باستخدام معرف الطلب.
bulkUnregisterDevice	يلغي تسجيل أجهزة متعددة في طلب واحد.
bulkUnregisterDevice Status	يسترجع حالة ونتائج طلب إلغاء تسجيل جهاز مجمع باستخدام معرف الطلب.

واجهة برمجة تطبيقات العلامات (Tags API)

addTag	ينشئ علامة في حسابك.
deleteTag	يزيل علامة مع جميع المعلومات المرتبطة بها.
listTags	يسترجع قائمة بالعلامات الموجودة في الحساب.

واجهة برمجة تطبيقات التجزئة (الفلاتر) (Segmentation (Filters) API)

createFilter	ينشئ شريحة جديدة.
listFilters	يعيد قائمة بالشرائح المتاحة مع شروطها.
deleteFilter	يحذف شريحة موجودة.
exportSegment	يجدول طلبًا لتصدير المشتركين المطابقين لشروط الشريحة.
exportSegment Results	يسترجع رابط CSV لنتائج exportSegment.

واجهة برمجة التطبيقات المتمحورة حول المستخدم (User-centric API)

registerUser	يربط معرف المستخدم الخارجي (User ID) بجهاز محدد.
postEvent	يستدعي الحدث داخل التطبيق.

واجهة برمجة تطبيقات الأحداث (Events API)

createEvent	ينشئ حدثًا للتطبيق.

واجهة برمجة تطبيقات التطبيقات (Applications API)

createApplication	ينشئ تطبيقًا جديدًا في الحساب.
updateApplication	يحدّث إعدادات التطبيق.
deleteApplication	يحذف التطبيق من الحساب.
getApplication	يحصل على تفاصيل حول التطبيق.
getApplications	يسترجع قائمة بالتطبيقات الموجودة في الحساب.
getApplicationFile	يسترجع ملفات التكوين المتعلقة بالتطبيق.
setApplicationPlatformStatus	يغير حالة المنصة للتطبيق.

واجهة برمجة تطبيقات الحملات (Campaigns API)

createCampaign	ينشئ حملة دفع جديدة.
deleteCampaign	يحذف حملة معينة.
getCampaigns	يسترجع قائمة بالحملات الخاصة بالتطبيق.

واجهة برمجة تطبيقات تكوين التطبيق (App configuration API)

configureApplication for iOS	يهيئ منصة iOS للتطبيق.
configureApplication for Android	يهيئ منصة Android للتطبيق.
configureApplication for Mac OS X	يهيئ منصة macOS للتطبيق.
configureApplication for Windows	يهيئ منصة Windows للتطبيق.
configureApplication for Amazon	يهيئ منصة Amazon للتطبيق.
configureApplication for Chrome	يهيئ منصة Chrome للتطبيق.
configureApplication for Safari	يهيئ منصة Safari للتطبيق.
configureApplication for Firefox	يهيئ منصة Firefox للتطبيق.
configureApplication for Email	يهيئ منصة البريد الإلكتروني (Email) للتطبيق.

واجهة برمجة تطبيقات البريد الإلكتروني (Email API)

createEmailMessage	ينشئ رسالة بريد إلكتروني.
registerEmail	يسجل عنوان بريد إلكتروني للتطبيق.
deleteEmail	يزيل عنوان بريد إلكتروني من قاعدة بياناتك.
setEmailTags	يضبط قيم العلامات لعنوان البريد الإلكتروني المحدد.
registerEmailUser	يربط معرف المستخدم الخارجي (User ID) بعنوان بريد إلكتروني محدد.

واجهة برمجة تطبيقات أجهزة الاختبار (Test devices API)

createTestDevice	يسجل جهاز اختبار للتطبيق.
listTestDevices	يسترجع جميع أجهزة الاختبار المسجلة للتطبيق.

واجهة برمجة تطبيقات صندوق الوارد للرسائل (Message inbox API)

getInboxMessages	يسترجع قائمة رسائل صندوق الوارد (Inbox) لمعرف جهاز (HWID) محدد.
inboxStatus	يحدّث حالة رسالة صندوق وارد (Inbox) معينة.

واجهة برمجة تطبيقات الإحصائيات (Statistics API)

إحصائيات الرسائل

messages:list	يسترجع قائمة بالرسائل المرسلة.
totalsByIntervals	يوفر مقاييس وبيانات التحويل مجمعة حسب الساعة.
getMessageLog	يسترجع معلومات مفصلة حول الرسائل المرسلة.
linksInteractions	يوفر إحصائيات حول نقرات روابط البريد الإلكتروني.
linksInteractionsDevices	يسرد المستخدمين الذين نقروا على الروابط في رسائل البريد الإلكتروني.
bouncedEmails	يوفر معلومات حول رسائل البريد الإلكتروني المرتدة والشكاوى وأسباب الارتداد.

إحصائيات التطبيق والمشتركين

getApplicationSubscribersStats	يسترجع إحصائيات مشتركي التطبيق، مجمعة حسب نوع الجهاز.
getAppStats	يسترجع إحصائيات التطبيق لفترة زمنية محددة.
getSubscribersStatistics	يسترجع إحصائيات المشتركين لفترة زمنية محددة.

إحصائيات الحملة

getCampaignStats	يسترجع إحصائيات الحملة لفترة زمنية محددة.

إحصائيات الأحداث والعلامات

getEventStatistics	يسترجع عدد المرات التي تم فيها تشغيل حدث خلال فترة محددة.
getTagStats	يسترجع إحصائيات لعلامة معينة.

واجهة برمجة تطبيقات أنشطة iOS المباشرة (iOS Live Activities API)

startLiveActivity	ينشئ نشاطًا مباشرًا (Live Activity) جديدًا لنظام iOS.
updateLiveActivity	يحدّث نشاطًا مباشرًا (Live Activity) موجودًا لنظام iOS.

واجهة برمجة تطبيقات رحلة العميل (Customer Journey API)

Get Journey stats	يحصل على إحصائيات لرحلة (Journey) معينة بواسطة معرفها.
Remove users from journeys	يزيل مستخدمًا واحدًا أو أكثر من جميع الرحلات (Journeys) النشطة أو من رحلات محددة.

واجهة برمجة تطبيقات الطلبات المجدولة (Scheduled requests API)

getResults	يسترجع نتيجة طلب مجدول.

واجهة برمجة تطبيقات الرسائل القصيرة (SMS API)

createSMSMessage	ينشئ رسالة SMS جديدة.

واجهة برمجة تطبيقات واتساب (WhatsApp API)

createWhatsAppMessage	ينشئ رسالة WhatsApp جديدة.

واجهة برمجة تطبيقات لاين (LINE API)

createLineMessage	ينشئ رسالة LINE جديدة.

واجهة برمجة تطبيقات المناطق الجغرافية (Geozones API)

getNearestZone	يسترجع معلمات أقرب منطقة جغرافية (geozone) والمسافة إليها. يسجل أيضًا موقع الجهاز لإشعارات الدفع الجغرافية.
addGeoZone	يضيف منطقة جغرافية (Geozone) إلى تطبيق معين.
updateGeoZone	يحدّث خصائص المنطقة الجغرافية (Geozone) مثل الاسم والحالة والمحتوى والنطاق.
deleteGeoZone	يزيل المناطق الجغرافية (Geozones) من التطبيق.
addGeoZoneCluster	يضيف مجموعة مناطق جغرافية (Geozone Cluster) إلى التطبيق.
deleteGeoZoneCluster	يزيل مجموعة مناطق جغرافية (Geozone Cluster) من التطبيق.
listGeoZones	يسترجع قائمة بالمناطق الجغرافية (Geozones) للتطبيق.
listGeoZoneClusters	يسترجع قائمة بمجموعات المناطق الجغرافية (Geozone clusters) للتطبيق.