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

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

واجهة برمجة تطبيقات الرسائل v2

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

Notify	تنشئ وترسل رسالة واحدة عبر أي قناة. تحل محل /createMessage، /createTargetedMessage، /createEmailMessage، /createSMSMessage، /createKakaoMessage.

بوابة SMTP

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

واجهة برمجة تطبيقات الرسائل

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

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

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

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

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

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

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

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

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

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

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

واجهة برمجة تطبيقات تتمحور حول المستخدم

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

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

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

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

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

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

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

واجهة برمجة تطبيقات تكوين التطبيق

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	تكوّن منصة البريد الإلكتروني للتطبيق.

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

createEmailMessage مهمل	تنشئ رسالة بريد إلكتروني. استخدم Notify مع platforms: ["EMAIL"] وemail_payload بدلاً من ذلك.
registerEmail	تسجل عنوان بريد إلكتروني للتطبيق.
deleteEmail	تزيل عنوان بريد إلكتروني من قاعدة بياناتك.
setEmailTags	تحدد قيم العلامات لعنوان البريد الإلكتروني المحدد.
registerEmailUser	تربط User ID خارجيًا بعنوان بريد إلكتروني محدد.

واجهة برمجة تطبيقات أجهزة الاختبار

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

واجهة برمجة تطبيقات صندوق الوارد للرسائل

getInboxMessages	تسترجع قائمة رسائل صندوق الوارد لـ HWID محدد.
inboxStatus	تحدّث حالة رسالة صندوق وارد معينة.

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

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

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

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

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

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

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

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

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

واجهة برمجة تطبيقات أنشطة iOS المباشرة

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

واجهة برمجة تطبيقات رحلة العميل

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

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

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

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

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

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

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

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

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

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

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

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

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