المطوّرون

POST/v3/get_requirements

الاطلاع على متطلبات التسجيل

استرجاع متطلبات التسجيل التي تُرجع حاليا لبلد واسم نوع رقم محددين.

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

اختيار البلد ونوع الرقم

اختر بلد التسجيل، ثم استخدم اسما تُرجعه get_document_number_types. أرسل هذا الاسم في المعامل number_type، وليس معرّف نوع أو فئة عامة للبحث عن الأرقام.

قراءة التعليمات المُرجعة

احتفظ بمعرّفات المتطلبات والعلاقات لاستخدامها في سير العمل المعني بالهوية والمستندات. يُرجع هذا الاستدعاء المتطلبات؛ ولا يتحقق من صحة ملفاتك أو يقدّمها. اتبع التعليمات المُرجعة وأي متطلبات خاصة بالرقم المحدد.

لا تفسّر الخطأ على أنه إعفاء

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

الطلب

استخدم بيانات اعتماد حساب واجهة برمجة التطبيقات المفعّل لديك عبر HTTPS. تُدعم المصادقة الأساسية ورموز حامل الرمز المفعّلة لحساب واجهة برمجة التطبيقات؛ وتُطبّق قيود الحساب.

POST باستخدام application/json أو application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
معاملات متن الطلب
الاسمالنوعمطلوبالوصف
countryسلسلة نصيةنعمرمز البلد وفق معيار ISO من get_document_countries.
number_typeسلسلة نصيةنعماسم نوع من get_document_number_types، مثل Local؛ ولا تميّز المطابقة بين الأحرف الكبيرة والصغيرة. قدّم الاسم، وليس معرّفه.

الاستجابة

تحقق من status.code في متن JSON وكذلك من حالة HTTP. يمثّل response مورد متطلبات واحدا يتضمن id وtype وattributes، بالإضافة إلى relationships عند إرجاعها. المعرّفات الواردة في المورد وبيانات العلاقات معتمة ولا يُستدل من بنيتها على معناها. تُزال وسوم HTML من نص restriction_message الاختياري؛ تعامل مع النص المتبقي بوصفه نصا، وليس محتوى HTML موثوقا. يُرجع المعالج أول مورد للمتطلبات، لذا لا تستنتج أن هذه الاستجابة قائمة شاملة. يعتمد توفر السمات والعلاقات على البلد والنوع؛ ولا يمثّل المثال مخططا ثابتا وكاملا.

بنية استجابة توضيحية؛ وليست بيانات حساب فعلية في الوقت الحالي أو عرض سعر حاليّا.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

الأخطاء

  • 400: فشل التحقق من صحة البلد وnumber_type: قدّم القيمتين المطلوبتين. قد يحتوي نص التحقق على تنسيق.
  • 400: Invalid country ISO or No country registration documents required.: لا تثبت هذه الرسالة الملتبسة وحدها وجود إعفاء من التسجيل.
  • 400: Invalid number type: استخدم اسم نوع مُرجعا. تسرد رسالة الخطأ القديمة Global وLocal وMobile وNational وShared Cost وToll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: لم تُرجع المتطلبات بنجاح. أعد المحاولة لاحقا أو تواصل مع الدعم.

التوفر والآثار الجانبية

  • لا تؤدي عملية الاستعلام هذه عن الكتالوج والمتطلبات إلى إنشاء هوية أو رفع مستند إثبات أو تسجيل رقم أو تقديم طلب شراء.
  • لا تعني استجابة الكتالوج الناجحة الموافقة على مستنداتك أو تأكيد إمكانية تفعيل الرقم المحدد.