الإشعارات
الإشعارات
الإشعارات
أرسل إشعارات لجهاز واحد أو أكثر عبر REST API الخاص بـ Atelerix.
POST
الإشعارات
أرسل إشعاراً لواحد أو أكثر من رموز الأجهزة المسجّلة، أو لكل جهاز مشترك في
موضوع (topic).
احتفظ بـ
راجع مقدمة الـ API لإعداد الرابط الأساسي ومفتاحك الخاص قبل إرسال الطلبات.
المعاملات (Parameters)
string
مطلوب
معرّف مشروعك من إعدادات المشروع في لوحة التحكم.
string
مطلوب
عنوان الإشعار الذي يظهر للمستخدم.
string
مطلوب
نص رسالة الإشعار.
string[]
رمز جهاز واحد أو أكثر لتسليم الإشعار إليه. مطلوب ما لم يكن
sendByTopic
بقيمة true.boolean
افتراضي:"false"
اضبطه على
true للتسليم لكل جهاز مشترك في topic بدلاً من deviceTokens
محددة — عند true يتم تجاهل deviceTokens حتى لو كانت موجودة. تشترك
الأجهزة في موضوع من تطبيقك عبر الـ SDK؛ يُنشأ الموضوع تلقائياً أول مرة يشترك
فيها جهاز، أو يمكنك إنشاء واحد يدوياً من تبويب المواضيع في لوحة
التحكم.string
مفتاح الموضوع الذي يتم البث إليه. مطلوب عندما يكون
sendByTopic بقيمة
true، ويُتجاهَل خلاف ذلك.string
اسم صوت إشعار مخصّص. يجب أن يكون الملف نفسه مُرفقاً بالفعل داخل مشروع
تطبيقك — يمرّر Atelerix اسم الملف فقط إلى APNs/FCM، ولا يستضيف أو يرفع
ملفات الصوت. اتركه فارغاً لاستخدام صوت الإشعار الافتراضي للجهاز.iOS: اسم ملف الصوت مع امتداده (مثال:
sound.mp3؛ مدعوم أيضاً
.caf/.wav).Android: اسم المورد (resource) بدون امتداد، بحيث يطابق ملفاً تحت
res/raw/ (مثال: sound لملف عند res/raw/sound.mp3).- الصيغ المدعومة:
.wav،.mp3،.ogg. - اجعل اسم الملف بأحرف صغيرة (lowercase) — بعض الأدوات/الأجهزة تتجاهل الأحرف الكبيرة في أسماء الموارد.
- اجعل حجم الملف صغيراً وأقل من ~30 ثانية؛ قد لا تعمل الملفات الكبيرة على بعض الأجهزة.
- إذا لم يُعثر على الملف المحدّد، يعود الإشعار إلى صوت الجهاز الافتراضي بدلاً من الفشل.
- يُثبَّت الصوت المحدّد أول مرة يُستخدم فيها على الجهاز — يُثبّت Android
صوت قناة الإشعارات (notification channel) عند إنشائها ولا يسمح بتغييره
لاحقاً، لذا فإن التبديل إلى قيمة
soundمختلفة لاحقاً يُنشئ قناة جديدة بدلاً من تحديث القناة القديمة.
object
بيانات مخصّصة حرّة لإرفاقها بالإشعار. أي كائن JSON؛ اتركه فارغاً لعدم إرفاق
أي بيانات وصفية. تصل إلى الجهاز جنباً إلى جنب مع
title/body، وتُقرأ من
الـ SDK كـ payload.metadata في
setOnNotificationReceived/setOnNotificationTapped.string
مطلوب
اسم المسار (slug) الخاص بمشروعك من إعدادات المشروع.
string
مطلوب
مفتاحك الخاص من إعدادات المشروع.
string
افتراضي:"API"
المصدر الذي أُرسل منه الإشعار.
string
طابع زمني بصيغة ISO 8601 لجدولة التسليم لوقت لاحق بدلاً من الإرسال الفوري.
اتركه فارغاً (أو مرّر وقتاً في الماضي) للإرسال فوراً. يمكن تعديل الإشعار
المجدوَل أو إلغاؤه قبل إرساله — راجع تحديث إشعار وإلغاء إشعار مجدوَل.
الاستجابة (Response)
201 Created
notificationId — فهو ما تمرّره إلى نقاط النهاية الأخرى الخاصة
بالإشعارات (التحديث، إلغاء الإرسال، الإلغاء، وحالة التسليم).
عند الفشل، تتبع الاستجابة الشكل الموثّق في رموز الأخطاء والنجاح.