توثيق REST API

أرسل أول طلب API إلى MultiTEL

ابدأ بطلب للقراءة فقط، وافهم الاستجابة، ثم اختر المرجع الخاص بالخدمة التي تريد بناءها.

اختر واجهة API وبيانات الاعتماد معًا

يمكن للحسابات المعتمدة ضمن فئات «المطوّرون والأتمتة» و«الأعمال» و«مقدّمو خدمات الاتصالات» دمج الخدمات المفعّلة. لا يحتاج المطوّر الفرد إلى التظاهر بأنه شركة. تتطلب رسائل SMS/MMS الخاصة بالتطبيقات موافقة الإرسال والتسجيل المعمول بهما. أما خدمات «الأفراد والعائلات» فلا تتضمن واجهة API متاحة للعملاء لإنشاء الرسائل.

عائلة APIعنوان URL الأساسيالمصادقة والنتيجة
الاتصالات v3https://api.multitel.net/v3بيانات اعتماد Basic المعتمدة؛ ولا تُستخدم الرموز المميزة المؤهلة والمُزوَّدة إلا في العمليات التي تدعمها. يتضمن JSON الحقلين status وresponse.
التسجيل لخدمة الاتصال بالطوارئhttps://api.multi.tel/emergencyبيانات اعتماد Basic المعتمدة أو وصول bearer مُزوَّد خصيصًا. يتضمن JSON الحقول code وmessage وdata.
تكاملات REST الخاصة بالبوابةالمضيف والعملية كما يظهران في مرجع المطوّر الخاص بحسابكاستخدم بيانات الاعتماد والنطاقات والمخطط الموثقة لتلك العملية. تستخدم طلبات جلسة المتصفح واجهة منفصلة.

عيّن MULTITEL_API_USERNAME وMULTITEL_API_PASSWORD عبر إعدادات الأسرار في خادمك قبل استخدام الأمثلة. لا تضمّنهما أبدًا في JavaScript العام للمتصفح أو في عناوين URL أو في نظام التحكم بالمصدر. تُدار بيانات الاعتماد المخصصة في إعدادات تكامل API.

الطلب الأول: قراءة رصيدك

هذه القراءة لا تشتري خدمة ولا تُجري مكالمة ولا ترسل رسالة.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getbalance"

تعيد واجهة API الخاصة بالاتصالات v3 نتيجة التطبيق داخل نص JSON. تحقق من حالة HTTP ومن status.code قبل قراءة response؛ فقد لا يحتوي الطلب المرفوض على كائن استجابة. يمكن أن تكون قيم الرمز نصوصًا أو أرقامًا.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "25.0000",
    "currency": "USD",
    "terms": "Prepaid"
  }
}

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

استخدم بيانات الفوترة بشكل صحيح

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

اختر تكاملك التالي

واجهة REST API للبحث عن توجيه LRN

ابحث عن رقم التوجيه ومعلومات مشغّل الاتصالات المتاحة لرقم هاتف في أمريكا الشمالية بسعر ثابت.

اقرأ دليل التكامل ←

واجهات REST API لأرقام الهاتف

اكتشف الدول والأرقام المتاحة، وافحص العرض كاملاً، وأدِر الأرقام التي تملكها.

اقرأ دليل التكامل ←

واجهات REST API للرسائل SMS وMMS

أرسل رسائل التطبيقات المعتمدة وتعامل مع القبول وأحداث التسليم والتجزئة والرسوم.

اقرأ دليل التكامل ←

واجهات REST API للاتصال بالطوارئ

سجّل رقماً وعنوان خدمة، وتابع حالة تفعيله، وحافظ على تحديث السجل عند تغيّر الموقع.

اقرأ دليل التكامل ←

واجهات REST API للحساب والفوترة

اقرأ الرصيد ومعلومات الفوترة المتاحة للتكامل المعتمد لديك.

اقرأ دليل التكامل ←

عمليات البحث عن CNAM والتوجيه

اقرأ أسماء المتصلين، وافهم مستويات البحث، واستخدم معلومات توجيه الأرقام.

مرجع CNAM REST ←

طلب LRN والأسعار ←

PBX المستضاف

ابدأ بخطط الخدمة المتاحة والمستأجر (tenant) الذي تنوي إعداده.

واجهة API لخطط خدمة PBX المستضاف ←

التعامل مع الأخطاء وإعادة المحاولة

فشل المصادقة أو الصلاحيات
تحقق من حالة تفعيل بيانات اعتماد API، والخدمة المسموح بها، وقيد عنوان IP المصدر. ملف تعريف الارتباط الخاص بجلسة البوابة ليس بيانات اعتماد للتكامل.
رصيد غير كافٍ أو موافقة غير مستوفاة
عالج مسألة رصيد الحساب أو موافقة الإرسال أو متطلب المستندات قبل تكرار العملية.
لا توجد نتيجة
تعامل مع المخزون الفارغ أو غياب اسم المتصل على أنه نتيجة عادية. لا تفترض أن رقمًا صحيح الصياغة تتوفر له كل الخدمات.
انتهاء مهلة الشبكة أو فشل الخدمة
استخدم إعادة محاولات محدودة مع تأخير تصاعدي لعمليات القراءة. وفي حالة الشراء أو الإرسال أو التسجيل، افحص حالة العملية أولًا؛ فإعادة إرسال طلب مقبول قد تكرر إجراءً يترتب عليه رسوم.

دعم تكرار الطلب بأمان (idempotency) يخص كل عائلة API على حدة. تدعم واجهة Emergency API مفاتيح إعادة المحاولة، لكن ذلك لا يجعل أي طلب عشوائي في v3 آمنًا للتكرار. احتفظ بالطوابع الزمنية والمعرّفات المُعادة والاستجابات بعد حجب بياناتها الحساسة لأغراض الدعم.

تابع مع المرجع الخاص بحسابك

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