فهرس مرجع أساليب واجهة برمجة التطبيقات (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 القياسي بدلاً من استدعاء واجهة برمجة التطبيقات مباشرة. تقوم البوابة بالمصادقة باستخدام رمز التطبيق الخاص بك ورمز واجهة برمجة التطبيقات، ثم تعيد توجيه كل رسالة إلى Notify. راجع مرجع بوابة SMTP.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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