Overview
تُبلغ API برمجة تطبيقات BroadNet REST عن الأخطاء باستخدام رمز حالة HTTP قياسي ونص JSON يُسمى ExceptionResponse، ويتكون من خمسة حقول: status و error و message و errorCode و requestUri. يتم التحقق من حالة HTTP أولاً، ثم من errorCode. استثناء واحد: يتم رفض رمز Bearer غير الصالح أو المفقود في وقت سابق، عند بوابة واجهة API، برمز 401 يحتوي نصه على error و message فقط.
رموز الحالة
يشير الرمز 400 إلى خطأ في التحقق أو حقل مطلوب مفقود: قم بتصحيح الطلب. يشير الرمز 401 إلى أن رمز Bearer مفقود أو غير صالح، ويشير الرمز 403 إلى أنه لا يُسمح باستدعاء العملية: قم بتصحيح الرمز. يشير الرمز 500 إلى خطأ غير متوقع في الخادم، ويشير الرمز 502 إلى أن مزود الخدمة رفض الاستدعاء: أعد المحاولة مع تأخير أسّي (exponential backoff). أما عمليات ربط SMPP فتُرجع بدلاً من ذلك رموز command_status القياسية في SMPP.
أمثلة
انسخ والصق واستبدل القيم النائبة — هذه الأمثلة تستدعي واجهة API لبيئة الإنتاج كما هي مكتوبة.
{
"status": 400,
"error": "Bad Request",
"message": "…",
"errorCode": "…",
"requestUri": "/sms/sendSms"
}{
"error": "Unauthorized",
"message": "Missing Authorization token"
}