فهرس مرجع أساليب 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	تنشئ نشاطًا حيًا جديدًا على iOS.
updateLiveActivity	تحدث نشاطًا حيًا موجودًا على iOS.

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

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

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

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

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

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

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

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

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

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

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

createKakaoMessage	ترسل رسالة Kakao باستخدام قالب معتمد.

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

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