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

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

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

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

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

بوابة SMTP

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

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

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

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

Create	ينشئ إعدادًا مسبقًا جديدًا للإشعارات الفورية.
List	يسرد الإعدادات المسبقة للإشعارات الفورية للتطبيق.
Get	يسترجع إعدادًا مسبقًا واحدًا للإشعارات الفورية حسب الرمز.
Update	يستبدل إعدادًا مسبقًا للإشعارات الفورية حسب الرمز.
UpdatePartial	يحدّث فقط الحقول المقدمة لإعداد مسبق للإشعارات الفورية حسب الرمز.
Clone	ينسخ إعدادًا مسبقًا للإشعارات الفورية داخل نفس التطبيق.
Delete	يحذف إعدادًا مسبقًا للإشعارات الفورية حسب الرمز.

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

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

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

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

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

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

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

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	يضبط قيم العلامات (Tags) لعنوان البريد الإلكتروني المحدد.
registerEmailUser	يربط معرف مستخدم (User ID) خارجي بعنوان بريد إلكتروني محدد.

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

Create	ينشئ قالب بريد إلكتروني جديدًا في تطبيق.
List	يسرد قوالب البريد الإلكتروني للتطبيق.
Get	يعيد قالب بريد إلكتروني واحدًا حسب الرمز.
Update	يحدّث قالب بريد إلكتروني موجودًا حسب الرمز.
Delete	يحذف قالب بريد إلكتروني وإعداده المسبق المتصل به حسب الرمز.
Clone	ينسخ قالب بريد إلكتروني إلى تطبيق وجهة.

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

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

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

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

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

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

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

تصدير إحصائيات الرسائل غير المتزامن

exportMessagesStatistics/export	يضع تصدير سجل الرسائل في قائمة انتظار إلى ملف CSV، دون حدود الصفوف لـ messages:list.
exportMessagesStatistics/status	يعيد تقدم مهمة التصدير.
exportMessagesStatistics/result	يعيد اسم الملف الذي تم إنشاؤه بمجرد اكتمال المهمة.
exportMessagesStatistics/lastTasks	يسرد مهام التصدير الأخيرة لتطبيق ما.
exportMessagesStatistics/delete	يحذف مهمة وملفها قبل انتهاء فترة الاحتفاظ.
exportMessagesStatistics/download	يقوم بتنزيل ملف CSV الذي تم إنشاؤه بالاسم.

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

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

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

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

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

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

إحصائيات الرسائل داخل التطبيق (In-app)

inapps:totals	يسترجع إجماليات مرات الظهور والتفاعل وتحديد التكرار لحملة أو أكثر داخل التطبيق على مدى فترة.
inapps:timeline	يسترجع إجماليات الفترة وسلسلة زمنية لمقاييس الرسائل داخل التطبيق لحملة واحدة.

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

startLiveActivity	ينشئ نشاطًا مباشرًا جديدًا لنظام iOS.
updateLiveActivity	يحدّث نشاطًا مباشرًا موجودًا لنظام 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)

Lifecycle	يبدأ أو يوقف مؤقتًا أو ينهي أو يحفظ كمسودة أو يؤرشف رحلة حسب UUID الخاص بها.
Create and update	ينشئ تعريف رحلة جديدًا أو يستبدل تعريفًا موجودًا.
Start by API	يدخل المستخدمين إلى نقطة دخول API لرحلة قيد التشغيل.
Get Journey stats	يحصل على إحصائيات لرحلة معينة حسب معرفها.
Remove users from 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	يسترجع معلمات أقرب منطقة جغرافية والمسافة إليها. يسجل أيضًا موقع الجهاز لإشعارات الدفع الجغرافية.
addGeoZone	يضيف منطقة جغرافية (Geozone) إلى تطبيق معين.
updateGeoZone	يحدّث خصائص المنطقة الجغرافية مثل الاسم والحالة والمحتوى والنطاق.
deleteGeoZone	يزيل المناطق الجغرافية من التطبيق.
addGeoZoneCluster	يضيف مجموعة مناطق جغرافية إلى التطبيق.
deleteGeoZoneCluster	يزيل مجموعة مناطق جغرافية من التطبيق.
listGeoZones	يسترجع قائمة بالمناطق الجغرافية للتطبيق.
listGeoZoneClusters	يسترجع قائمة بمجموعات المناطق الجغرافية للتطبيق.