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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

createCampaign	تنشئ حملة push جديدة.
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	تكوّن منصة Email للتطبيق.

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

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

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

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

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

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

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

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

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

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

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

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

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

إحصائيات الأحداث والعلامات (Events and tags)

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

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

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

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

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

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

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

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

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)

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