واجهة برمجة تطبيقات المستندات للإشعارات - SMSMobileAPI
SMSMobileAPI - وثائق واجهة برمجة تطبيقات الإشعارات

وثائق واجهة برمجة تطبيقات الإشعارات

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

ال قائمة الإشعارات تُعيد نقطة النهاية وقت إرسال الإشعار ووقت توزيعه في بتوقيت غرينيتش، بما في ذلك سلاسل التاريخ والوقت الكاملة و الطوابع الزمنية لنظام يونكس.

هل تحتاج إلى مساعدة؟ api@smsmobileapi.com

التشغيل السريع

عنوان URL الأساسي

يحصل https://api.smsmobileapi.com
جميع الأمثلة أدناه معروضة على النحو التالي: يحصل طلبات التبسيط. إرسال/إشعار تقبل نقطة النهاية أيضًا بريد و نص JSON. يستبدل مفتاح واجهة برمجة التطبيقات الخاص بك مع مفتاحك الحقيقي.

أمثلة

طلب GET إلى https://api.smsmobileapi.com/notification/send?apikey=YOUR_API_KEY&sid=TARGET_SIDENTIFIANT&title=Notification&message=Helloworld&type=notification
GET https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY
GET https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY&sidentifiant=TARGET_SIDENTIFIANT&distribued=1&date_from=2026-03-01&date_to=2026-03-18

المصادقة

تستخدم نقاط نهاية الإشعارات المصادقة التالية: أبيكي المعلمة.

مطلوب على كلا الطرفين: مفتاح API إلزامي لـ إرسال/إشعار و قائمة الإشعارات.

المفاهيم المشتركة

تارجت موبايل

يتم إرسال الإشعارات إلى جهاز محمول محدد باستخدام سيديمكن لنقطة نهاية القائمة تصفية نفس الهدف باستخدام المقيم أو سيد.

حالة التوزيع

  • موزع = 1 يعني ذلك أنه تم توزيع الإشعار.
  • موزع = 0 يعني غير موزع.
  • حالة التوزيع عمليات الإرجاع تم التوزيع أو غير موزع.

التواريخ والمناطق الزمنية

  • مرسل_* تمثل الحقول تاريخ/وقت إرسال الإشعار في بتوقيت غرينيتش.
  • موزعة تمثل الحقول تاريخ/وقت التوزيع في بتوقيت غرينيتش.
  • *_at_unix الحقول عبارة عن طوابع زمنية بنظام يونكس.

سلوك نقطة نهاية القائمة

  • تُرجع نقطة نهاية القائمة دائمًا حدًا أقصى قدره 200 صفوف.
  • يتم ترتيب النتائج من الأحدث إلى الأقدم باستخدام تاريخ/وقت الإرسال.
  • استخدام فلاتر التاريخ تاريخ التحديث داخليًا ويتم عرضها على أنها تاريخ_من / تاريخ_إلى.

أخطاء

HTTP مثال على الخطأ معنى
400 {"success":false,"message":"المعامل المطلوب مفقود: apikey."} مفقود أو فارغ أبيكي.
400 {"success":false,"message":"المعلمات المطلوبة مفقودة: apikey و sid إلزاميّان."} مفتقد سيد على إرسال/إشعار.
400 {"success":false,"message":"المعامل المطلوب مفقود: message."} مفتقد رسالة على إرسال/إشعار.
400 {"success":false,"message":"تنسيق تاريخ_البداية غير صالح. المتوقع هو YYYY-MM-DD."} غير صالح تاريخ_من التنسيقات قائمة الإشعارات.
400 {"success":false,"message":"قيمة موزعة غير صالحة. القيم المسموح بها: 0 أو 1."} غير صالح تم التوزيع قيمة التصفية.
500 {"success":false,"message":"فشل الاتصال بقاعدة البيانات."} مشكلة في الاتصال بقاعدة البيانات.
500 {"success":false,"message":"فشل الاستعلام: ..."} خطأ في تنفيذ SQL.

إشعار – إرسال

أنشئ إشعارًا جديدًا لجهاز جوال مستهدف.

نقطة النهاية

يحصل بريد https://api.smsmobileapi.com/notification/send

معلمات الاستعلام / نص الاستعلام

المعلمةيكتبوصف
أبيكي خيط مطلوب مفتاح API الخاص بك.
سيد خيط مطلوب استهداف الهوية عبر الهاتف المحمول.
عنوان خيط خياري عنوان الإشعار. الافتراضي: إشعار.
رسالة خيط مطلوب محتوى رسالة الإشعار.
يكتب خيط خياري نوع الإشعار. الافتراضي: إشعار.

مثال على استجابة ناجحة

{ "success": true, "message": "تم إنشاء الإشعار.", "id": 22087, "apikey": "YOUR_API_KEY", "sid": "508b004b4aadacc4" }

قائمة الإشعارات

استرجع أحدث الإشعارات الخاصة بمفتاح API، مع إمكانية التصفية الاختيارية.

نقطة النهاية

يحصل https://api.smsmobileapi.com/notification/list/

معلمات الاستعلام

المعلمةيكتبوصف
أبيكي خيط مطلوب مفتاح API الخاص بك.
المقيم خيط خياري تصفية الإشعارات حسب الهاتف المحمول المستهدف.
سيد خيط خياري اسم مستعار لـ المقيم.
تم التوزيع 0 | 1 خياري 1 = موزعة فقط، 0 = غير موزعة فقط.
تاريخ_من YYYY-MM-DD خياري قم بتصفية تاريخ الإرسال من هذا اليوم.
تاريخ_إلى YYYY-MM-DD خياري تم إرسال الفلتر بتاريخ حتى هذا اليوم.
تُرجع نقطة نهاية القائمة على الأكثر 200 ويتم ترتيبها حسب تاريخ إرسال الإشعار أولاً.

مثال على استجابة ناجحة

{ "success": true, "message": "تم استرداد الإشعارات بنجاح.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "إشعار", "message": "vers miano", "distribued": "1", "distribued_status": "distributed", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110، "distributed_timezone": "GMT"، "sent_date_gmt": "2026-03-18"، "sent_time_gmt": "10:15:03"، "sent_at_gmt": "2026-03-18 10:15:03"، "sent_at_unix": 1773828903، "sent_timezone": "GMT" } ] }

إرسال حقول الاستجابة

مجاليكتبوصف
نجاحمنطقيحالة الطلب.
رسالةخيطرسالة نتائج قابلة للقراءة البشرية.
بطاقة تعريفعدد صحيحتم إنشاء معرّف الإشعار في قاعدة البيانات.
أبيكيخيطمفتاح API المُعاد استخدامه.
سيدخيطالمعرف المستهدف للهاتف المحمول المستخدم أثناء الإنشاء.

حقول استجابة القائمة

مجاليكتبوصف
نجاحمنطقيحالة الطلب.
رسالةخيطرسالة نتائج قابلة للقراءة البشرية.
الفلاترهدفالمرشحات المُعاد استخدامها في الطلب.
عددعدد صحيحعدد الإشعارات المُعادة.
بياناتمصفوفةقائمة الإشعارات.
البيانات[].المعرفخيطمعرّف الهاتف المحمول المستهدف.
data[].titleخيطعنوان الإشعار.
رسالة البيانات[].خيطرسالة إشعار.
البيانات[].موزعةخيطالعلم الموزع الخام.
data[].distribued_statusخيطتم التوزيع أو غير موزع.
data[].distributed_date_gmtخيطتاريخ التوزيع بتوقيت غرينتش.
data[].distributed_time_gmtخيطوقت التوزيع بتوقيت غرينتش.
تم توزيع البيانات في توقيت غرينتشخيطتاريخ ووقت التوزيع الكامل بتوقيت غرينتش.
البيانات[].distributed_at_unixعدد صحيح | لا شيءتاريخ ووقت التوزيع كطابع زمني لنظام يونكس.
data[].distributed_timezoneخيطدائماً بتوقيت غرينيتش.
data[].sent_date_gmtخيطأرسل التاريخ بتوقيت غرينتش.
data[].sent_time_gmtخيطأرسل الوقت بتوقيت غرينتش.
data[].sent_at_gmtخيطتاريخ ووقت الإرسال الكامل بتوقيت غرينتش.
data[].sent_at_unixعدد صحيح | لا شيءأرسل التاريخ والوقت كطابع زمني يونكس.
data[].sent_timezoneخيطدائماً بتوقيت غرينيتش.
هل تحتاج إلى مساعدة؟ اتصال api@smsmobileapi.com
نصيحة: لا تنشر مفتاح API الخاص بك في لقطات الشاشة أو التذاكر أو المستودعات العامة.
💬 الدردشة المباشرة
💬 الدردشة المباشرة متاحة
هل لديك أي أسئلة أو تحتاج إلى مساعدة؟
فريقنا هنا لمساعدتك!
أدخل عنوان بريدك الإلكتروني
لمساعدتنا في متابعة طلبك:
لوحة القيادة