فهرس مرجع أساليب 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	يلغي رسالة مجدولة، مع الاحتفاظ بها في سجل الرسائل.

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

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

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

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	يربط معرف مستخدم خارجي بجهاز محدد.
deleteUser	يحذف مستخدمًا وجميع الأجهزة المرتبطة بمعرف المستخدم المحدد.
postEvent	يستدعي الحدث داخل التطبيق.

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

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

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

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

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

List	يسرد مجموعات التحكم الخاصة بالتطبيق.
Create	ينشئ مجموعة تحكم.
Get	يسترجع مجموعة تحكم واحدة حسب الرمز.
UpdatePercentage	يعيد تحديد نسبة الاستبعاد لمجموعة التحكم.
UpdateCountries	يعيد تحديد نطاق مجموعة التحكم لمجموعة من البلدان.
Disable	يوقف تشغيل مجموعة التحكم.
Reshuffle	يعيد سحب عينة الاستبعاد لمجموعة التحكم.
ForceUpdateCalculation	يبدأ عدًا جديدًا لحجم مجموعة التحكم.
GetCalculationStatus	يستعلم عن حساب حجم قيد التشغيل.
GetAnalytics	يسترجع تحليلات المقارنة بين مجموعة التحكم والمعالجة لمجموعة تحكم.
CheckControlGroupMembership	يبلغ عما إذا كان كل معرف مستخدم في دفعة مستبعدًا بواسطة مجموعة تحكم.
Delete	يزيل مجموعة تحكم.

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

Create	يبدأ محو (أو عد تجريبي لـ) البيانات الشخصية لأحد الأفراد.
Upload	ينشئ مهمة محو من ملف CSV تم تحميله يحتوي على معرفات.
ListTasks	يسرد مهام المحو الخاصة بالحساب.
GetTask	يسترجع حالة وعدّادات مهمة محو واحدة.
ListTaskRows	يسرد نتائج مهمة واحدة لكل معرف.
GetTaskReport	يُنزّل تقرير مهمة واحدة بصيغة CSV.
GetJournalReport	يُنزّل جميع مهام فترة معينة في ملف CSV واحد.

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

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	يربط معرف مستخدم خارجي بعنوان بريد إلكتروني محدد.

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

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

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

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

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

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

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

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

messages:list	يسترجع قائمة بالرسائل المرسلة.
totalsByIntervals	يوفر المقاييس وبيانات التحويل مجمعة حسب الساعة.
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	يسترجع إحصائيات لعلامة معينة.

إحصائيات داخل التطبيق

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	يسرد قوالب البطاقات أو يجلب واحدًا كنقطة بداية.

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

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"] بدلاً منه.

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

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