فهرس مرجع دوال الـ API

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

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

واجهة API موحدة تحل محل عائلة /create*Message بأكملها (push, email, SMS, Kakao). راجع النظرة العامة ودليل الترحيل.

Notify	تنشئ وترسل رسالة واحدة عبر أي قناة. تحل محل /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage.
Cancel	تلغي رسالة تم إنشاؤها مسبقًا قبل تسليمها. استخدمها مع message_code من Notify.
Update	تستبدل رسالة لا تزال مجدولة بتعريف جديد (استبدال كامل). استخدمها مع message_code من Notify.

بوابة SMTP

أرسل البريد الإلكتروني للمعاملات عبر بروتوكول SMTP القياسي بدلاً من استدعاء الـ API مباشرة. تقوم البوابة بالمصادقة باستخدام رمز التطبيق الخاص بك ورمز API، ثم تعيد توجيه كل رسالة إلى Notify. راجع مرجع بوابة SMTP.

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

createMessage مهملة	تنشئ إشعار push جديد. استخدم Notify بدلاً من ذلك.
deleteMessage	تحذف رسالة مجدولة.
getMessageDetails	تسترجع تفاصيل الرسالة.
createTargetedMessage مهملة	تنشئ إشعار push مستهدف جديد. استخدم Notify مع النوع transactional بدلاً من ذلك.
getPushHistory مهملة	استخدم /messages:list لاسترداد سجل الرسائل مع بيانات مفصلة.
cancelMessage	تلغي رسالة مجدولة.

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

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

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

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

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

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

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

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

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

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

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

registerUser	تربط User ID خارجي بجهاز محدد.
deleteUser	تحذف مستخدمًا وجميع الأجهزة المرتبطة بـ User ID المحدد.
postEvent	تستدعي الحدث (Event) داخل التطبيق.

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

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

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

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

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

createCampaign	تنشئ حملة إشعارات push جديدة.
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 مهملة	تنشئ رسالة بريد إلكتروني. استخدم Notify مع platforms: ["EMAIL"] وemail_payload بدلاً من ذلك.
registerEmail	تسجل عنوان بريد إلكتروني للتطبيق.
deleteEmail	تزيل عنوان بريد إلكتروني من قاعدة بياناتك.
setEmailTags	تضبط قيم الـ Tag لعنوان البريد الإلكتروني المحدد.
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	تسترجع عدد المرات التي تم فيها تشغيل حدث (Event) خلال فترة محددة.
getTagStats	تسترجع إحصائيات لـ Tag معين.

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

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

واجهة برمجة تطبيقات Apple Wallet PassKit

Apple Wallet PassKit API	مرجع لإدارة بطاقات Apple Wallet والإعدادات ذات الصلة في Pushwoosh.

واجهة برمجة تطبيقات Google Wallet

Create a pass	تنشئ البطاقة في Google Wallet وتعيد رابط حفظ.
Validate a pass	تتحقق من إعدادات البطاقة دون إنشائها.
Update a pass	تحدّث بطاقة موجودة. تقوم Google بتسليم التغيير إلى الأجهزة المحفوظة.
Get a save link	تعيد رابط حفظ “إضافة إلى Google Wallet” لبطاقة موجودة.
Get a pass	تعيد بطاقة واحدة مخزنة.
List passes	تعيد قائمة مقسمة إلى صفحات للبطاقات الخاصة بتطبيق ما.
Set pass state	تنشط أو تبطل صلاحية بطاقة.
Delete a pass	تبطل صلاحية البطاقة في Google وتزيل سجلها من Pushwoosh.
Get configuration	تعيد حالة إعدادات Google Wallet لتطبيق ما.
Templates	تسرد قوالب البطاقات أو تجلب واحدًا كنقطة بداية.

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

Lifecycle	تبدأ أو توقف مؤقتًا أو تنهي أو تحفظ كمسودة أو تؤرشف رحلة (Journey) بواسطة UUID الخاص بها.
Create and update	تنشئ تعريف رحلة (Journey) جديد أو تستبدل تعريفًا موجودًا.
Start by API	تدخل المستخدمين في نقطة دخول API لرحلة (Journey) قيد التشغيل.
Get Journey stats	تحصل على إحصائيات لرحلة (Journey) معينة بواسطة معرفها.
Remove users from journeys	تزيل مستخدمًا واحدًا أو أكثر من جميع الرحلات (Journeys) النشطة أو من رحلات محددة.

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

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

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

createSMSMessage مهملة	تنشئ رسالة SMS جديدة. استخدم Notify مع platforms: ["SMS"] بدلاً من ذلك.

واجهة برمجة تطبيقات WhatsApp

createWhatsAppMessage مهملة	تنشئ رسالة WhatsApp جديدة. استخدم Notify مع platforms: ["WHATS_APP"] بدلاً من ذلك.

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

createLineMessage مهملة	تنشئ رسالة LINE جديدة. استخدم Notify مع platforms: ["LINE"] بدلاً من ذلك.

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

createKakaoMessage مهملة	ترسل رسالة Kakao باستخدام قالب معتمد. استخدم Notify مع platforms: ["KAKAO"] بدلاً من ذلك.

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

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