☰

وثائق API للمطورين

دليلك الكامل لبناء تكاملات قوية مع واجهة RecivSMS البرمجية.

مقدمة

تم تصميم واجهة RecivSMS البرمجية (API) باستخدام مبادئ REST، مما يجعلها سهلة الفهم والتكامل. تقبل واجهتنا البرمجية طلبات بترميز JSON، وتعيد استجابات بترميز JSON، وتستخدم أكواد HTTP القياسية للمصادقة والأخطاء.

عنوان الـ API الأساسي هو: https://recivsms.com/console/v1

المصادقة

تتطلب جميع الطلبات إلى الـ API مفتاح مصادقة. يجب إرسال مفتاح الـ API في ترويسة الطلب (Header) كـ Bearer Token. أي طلب يتم بدون مفتاح صالح سيؤدي إلى خطأ 401 Unauthorized.

Authorization: Bearer YOUR_API_KEY

نقاط النهاية (Endpoints)

الحصول على الأرقام

GET /numbers

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

معلمات الطلب

  • countrystring (اختياري) رمز الدولة من حرفين (مثل: US, GB). 
curl --request GET \
 --url 'https://recivsms.com/console/v1/numbers' \
 --header 'Authorization: Bearer YOUR_API_KEY'
fetch('...', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})

الحصول على الرسائل

GET /numbers/{phone}/messages

إرجاع قائمة بالرسائل المستلمة على رقم معين.

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

  • phonestring (إجباري) الرقم بالصيغة الدولية. 
curl --request GET \
 --url 'https://recivsms.com/console/v1/numbers/+12015550123/messages' \
 --header 'Authorization: Bearer YOUR_API_KEY'

الأخطاء

تستخدم واجهتنا البرمجية أكواد استجابة HTTP التقليدية للإشارة إلى نجاح أو فشل طلب الـ API.

  • 200 OKالطلب ناجح.
  • 400 Bad Requestالطلب غير صالح (مثل معلم مفقود).
  • 401 Unauthorizedمفتاح الـ API مفقود أو غير صالح.
  • 404 Not Foundالمورد المطلوب غير موجود.
  • 429 Too Many Requestsلقد تجاوزت حد الطلبات المسموح به.