الدليل التقني للمطورين

مرحباً بك في توثيق "وصل API". توفر منصتنا واجهة برمجية بسيطة وقوية تتيح لك إرسال رسائل SMS لعملائك مباشرة من شريحة هاتفك الخاص، مما يوفر عليك التكاليف الباهظة لمزودي الخدمة الدوليين.

💡

جميع العمليات تتم عبر بروتوكول HTTP الآمن، ويتم تبادل البيانات بصيغة JSON. تأكد من أن هاتفك متصل بالإنترنت وتطبيق "وصل" يعمل في الخلفية لضمان وصول الرسائل فوراً.

# التوثيق (Authentication)

تستخدم واجهتنا مفاتيح الـ API (Bearer Token) للتحقق من هوية الطلبات. يمكنك الحصول على المفتاح من إعدادات مشروعك في لوحة التحكم. يجب تضمين المفتاح في الـ Header لكل طلب:

Authorization: Bearer YOUR_API_KEY

# العنوان الأساسي (Base URL)

تعمل المنصة عبر عنواين HTTP آمنة. يرجى توجيه جميع طلبات الـ API إلى العنوان الأساسي التالي:

https://wasl.abaad.dev/api/v1
⚠️ تأكد دائماً من استخدام النسخة v1 في مسارات الـ API لضمان التوافقية المستقبلية.
POST

إرسال رسالة SMS

https://wasl.abaad.dev/api/sms/send

يقوم هذا الطلب بإضافة رسالة جديدة إلى طابور الإرسال ليقوم هاتفك بإرسالها فوراً.

Parameters (JSON)

الحقل النوع الوصف
recipient String رقم الجوال بصيغة دولية (مثال: 9665XXXXXXXX)
message String محتوى الرسالة النصية
sim_slot Integer اختياري: رقم الشريحة المستخدمة (1 أو 2)
external_id String اختياري: معرّف الطلب في نظامك الخاص

مثال طلب Curl

curl -X POST "https://wasl.abaad.dev/api/sms/send" \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"recipient": "96650XXXXXXX",
"message": "مرحباً بك، كود الدخول: 7721"
}'

الاستجابة المتوقعة (202 Accepted)

{
"success": true,
"data": {
"sms_log_id": 10502,
"status": "pending"
}
}

جرب الـ API الآن (Playground)

Live Request

POST https://wasl.abaad.dev/api/sms/send
Headers: {
  "Authorization": "Bearer ...",
  "Content-Type": "application/json"
}

Response

// الاستجابة ستظهر هنا...
GET

الاستعلام بـ ID السجل

https://wasl.abaad.dev/api/sms/log/{id}

يستخدم هذا المسار للحصول على معلومات تفصيلية عن حالة إرسال رسالة معينة باستخدام المعرف الداخلي (ID) الذي تم إرجاعه في طلب الإرسال.

GET

الاستعلام بـ ID خارجي (External ID)

https://wasl.abaad.dev/api/sms/{externalId}

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