المطوّرون

GET/v3/lnp/project/{uniqueid}/status

التحقق من حالة مشروع نقل الأرقام

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

في هذه الصفحة
  1. الوصول إلى الحساب والمشروع
  2. الطلب
  3. الاستجابة
  4. الملخص لا يمثّل نتيجة جميع الأرقام
  5. تفسير حالة نقل الأرقام
  6. الأخطاء والقيود
  7. الآثار

الوصول إلى الحساب والمشروع

استخدم حساب API مفعّلا عبر HTTPS من عنوان IP مسموح به. يجب أن يكون المشروع تابعا لذلك الحساب وألا يكون محذوفا. استخدم المعرّف الفريد للمشروع من سير عمل طلب نقل الأرقام، وليس معرّفه الرقمي في قاعدة البيانات أو رقم هاتف. طبّق ترميز عناوين URL على معرّف المشروع عند إنشاء الطلب.

الطلب

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

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

الاستجابة

مثال افتراضي على الاستجابة.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

الحقل الخارجي status.code يبيّن نتيجة API. أما الحقل المنفصل response.status فهو ملخص حالة نقل الأرقام المستنتج للمشروع. لا تخلط بينهما.

الملخص لا يمثّل نتيجة جميع الأرقام

يختار الملخص In Progress إذا كان أي رقم يحمل هذه الحالة، وإلا يختار Pending، ثم Completed، ثم Rejected حسب أول حالة متوفرة بهذا الترتيب. وإذا لم توجد حالة معروفة مطابقة، تكون القيمة الافتراضية Pending. لذلك فإن المشروع الذي يحتوي على أرقام اكتمل نقلها وأرقام مرفوضة معا يُظهر Completed، مع أنه لا يزال يحتوي على أرقام مرفوضة.

افحص دائما الأعداد وقائمة الأرقام الفردية قبل أن تقرر أن المشروع بأكمله قد انتهى. counts.total يشمل كل سجل يربط رقما بالمشروع؛ أما العدادات الأخرى فتغطي قيم الحالات الأربع المعروفة فقط، وقد لا يساوي مجموعها العدد الإجمالي عند وجود قيم أخرى. ويُظهر المشروع الذي لا يحتوي على أي أرقام عدادات قيمتها صفر وملخصا بالحالة Pending.

تفسير حالة نقل الأرقام

القيم المعروفة لحالة الرقم
القيمةالتسمية
0Pending
1In Progress
2Completed
9Rejected

احتفظ بالقيمة الرقمية للحالة، واجعل النظام يتعامل مع القيم غير المعروفة. عند عدم معرفة التسمية، تُستخدم القيمة المخزنة بدلا منها، ولا يُضمن توفير تسمية جديدة. ولا تشكّل حالة الاكتمال المخزنة أو التاريخ المجدول، بمفردهما، اختبارا لتوجيه المكالمات الواردة أو لجميع الخدمات المرتبطة بالرقم.

الأخطاء والقيود

تحقق من استجابة HTTP ومن status.code/status.msg. إذا كان المشروع غير موجود أو محذوفا أو لا يتبع الحساب، تُرجع API الرمز 404 مع رسالة تفيد بعدم العثور على المشروع. وتسري أيضا متطلبات المصادقة والقيود على عنوان IP المصدر. لا تُجري الأمثلة طلبا فعليا، ولا تُعد الاستجابة الناجحة دليلا على أن شركة الاتصالات قد قبلت عملية نقل أو أكملتها.

الآثار

تقرأ نقطة النهاية هذه الأعداد المخزنة للمشروع. وضمن معالج الطلبات الذي تمت مراجعته، لا تقدّم طلب نقل، ولا تغيّر حالة، ولا تبدأ مكالمة، ولا تخصم من رصيد الحساب. كما لا تتيح الاستعلام الدوري من شركة الاتصالات في الوقت الفعلي أو الاشتراك في إشعارات الويب هوك.