مرجع کامل کدهای خطا
هر خطا شامل statusCode (کد وضعیت HTTP) و code (کد خطای دامنه، داخل بدنه‌ی ProblemResponse) است.
پاسخ خطا به‌صورت RFC 7807 با هدر Content-Type: application/problem+json برگردانده می‌شود.
خطاهای دامنه‌ای (SMS)
POST /sms/send, POST /sms/pattern, POST /sms/phonebook/send| statusCode | code | نام | توضیح |
|---|---|---|---|
| 422 | 422 | ErrorTypeValidation | تعداد شماره‌های ارسالی بیش از حد مجاز است. |
| 412 | 1003 | UserInactive | وضعیت حساب کاربری شما فعال نمی‌باشد. |
| 400 | 2001 | InsufficientBalance | موجودی کیف پول شما کافی نمی‌باشد. |
| 422 | 3002 | SmsPatternNoActiveVersion | این پترن نسخه فعالی ندارد. |
| 412 | 3011 | SmsSendNotAllowed | ارسال پیامک موقتا غیرفعال می‌باشد. |
| 406 | 3012 | SmsHeadNumberNotFound | سرشماره انتخاب‌شده برای ارسال پیامک نامعتبر است. |
| 406 | 3013 | SmsPatternHeadNumberNotAcceptable | پترن موردنظر قابل ارسال با سرخط انتخابی نمی‌باشد. |
| 406 | 3014 | SmsPatternVariableHasNoValue | مقداری برای متغیر پترن داده نشده است. |
| 406 | 3015 | SmsPatternVariableNotValid | مقدار متغیر پترن نامعتبر است. |
| 422 | 3016 | SmsRecipientBlacklisted | گیرنده‌ها در لیست سیاه شما قرار دارند. |
| 404 | 404 | NotFound | دفترچه یا شماره پیدا نشد. |
| 405 | 405 | MethodNotAllowed | متد ارسالی صحیح نیست. |
| 500 | 500 | InternalServerError | خطای سرور. |
خطاهای دامنه‌ای (دفترچه تلفن)
POST/PUT/DELETE /phonebook, /phonebook/number/*| statusCode | code | نام | توضیح |
|---|---|---|---|
| 422 | 422 | ErrorTypeValidation | مقادیر الزامی وارد نشده است / نوع یا فرمت مقادیر صحیح نیست. |
| 405 | 405 | MethodNotAllowed | متد ارسالی صحیح نیست / اشتباه است. |
| 404 | 404 | NotFound | پیدا نشد / دفترچه یا شماره پیدا نشد. |
| 500 | 500 | InternalServerError | خطای سرور. |
خطاهای عمومی HTTP
در همه‌ی endpointها ممکن است برگردانده شوند (CommonErrorResponses)| statusCode | نام | توضیح |
|---|---|---|
| 400 | Bad Request | درخواست نامعتبر است. |
| 401 | Unauthorized | احراز هویت انجام نشده یا API Key نامعتبر است. |
| 403 | Forbidden | دسترسی به این منبع مجاز نیست. |
| 422 | Validation Error | خطای اعتبارسنجی ورودی (جزئیات در فیلد extra). |
| 429 | Too Many Requests | تعداد درخواست‌ها بیش از حد مجاز است (rate limit). |
| 500 | Internal Server Error | خطای داخلی سرور. |