API للمطورين

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

معلمات الطلب (Query Parameters):

المعلم (Parameter)	الوصف	النوع	مطلوب	مثال
country_code	رمز الدولة المكون من حرفين (ISO 3166-1 alpha-2). إذا لم يتم توفيره، سيتم إرجاع أرقام من جميع الدول.	String	لا	FR, EG, US
limit	الحد الأقصى لعدد الأرقام المراد إرجاعها (الافتراضي: 20، الأقصى: 100).	Integer	لا	10

مثال للطلب (cURL):

curl -X GET "https://api.recivsms.com/v1/numbers?country_code=FR&limit=5" \
     -H "X-API-KEY: YOUR_API_KEY_HERE"
                    

مثال للاستجابة (JSON - Status 200 OK):

{
  "status": "success",
  "data": {
    "numbers": [
      {
        "id": "FR001",
        "phone_number": "+33612345678",
        "country_code": "FR",
        "country_name": "France",
        "status": "online",
        "last_activity_at": "2024-07-29T10:30:00Z"
      },
      {
        "id": "FR002",
        "phone_number": "+33798765432",
        "country_code": "FR",
        "country_name": "France",
        "status": "online",
        "last_activity_at": "2024-07-29T10:25:00Z"
      }
      // ... المزيد من الأرقام
    ],
    "total_count": 2, // إجمالي الأرقام المطابقة للمعايير
    "limit": 5,
    "country_filter": "FR"
  }
}
                    

إرجاع قائمة بالرسائل المستلمة على رقم هاتف معين، معرف بواسطة {number_id}.

معلمات المسار (Path Parameters):

المعلم (Parameter)	الوصف	النوع
number_id	معرف الرقم الفريد (مثل "FR001" الذي تم الحصول عليه من نقطة النهاية /numbers).	String

معلمات الطلب (Query Parameters):

المعلم (Parameter)	الوصف	النوع	مطلوب	مثال
limit	الحد الأقصى لعدد الرسائل المراد إرجاعها (الافتراضي: 20، الأقصى: 50).	Integer	لا	10
since_timestamp	جلب الرسائل التي وصلت بعد هذا الطابع الزمني (Unix timestamp in seconds or ISO 8601).	Integer/String	لا	1678886400 أو 2024-07-29T00:00:00Z

مثال للطلب (cURL):

curl -X GET "https://api.recivsms.com/v1/numbers/FR001/messages?limit=3" \
     -H "X-API-KEY: YOUR_API_KEY_HERE"
                    

مثال للاستجابة (JSON - Status 200 OK):

{
  "status": "success",
  "data": {
    "number_info": {
        "id": "FR001",
        "phone_number": "+33612345678",
        "country_code": "FR"
    },
    "messages": [
      {
        "message_id": "msg_abc123",
        "sender": "Google",
        "body": "Your Google verification code is G-123456.",
        "received_at": "2024-07-29T10:30:00Z"
      },
      {
        "message_id": "msg_def456",
        "sender": "Amazon",
        "body": "رمز التحقق أمازون: 987654.",
        "received_at": "2024-07-29T10:28:15Z"
      }
      // ... المزيد من الرسائل
    ],
    "total_count": 2,
    "limit": 3
  }
}