پرش به مطلب اصلی

کدهای وضعیت و خطاها

پاسخ بیشتر endpointها یک بدنه‌ی JSON با سه فیلد status، message و data است. status=0 یعنی موفق. برای endpointهای ارسال، خطاهای کسب‌وکاری ممکن است با کد HTTP 200 برگردند؛ پس همیشه status را بررسی کنید.

خطاهای احراز هویت​

کد HTTPبدنهعلت
401{"error":"missing_api_key", ...}کلید API ارسال نشده است
401{"error":"invalid_api_key", ...}کلید نامعتبر، غیرفعال، منقضی یا از IP غیرمجاز است
403{"error":"insufficient_scope", ...}کلید دسترسی لازم برای این بخش را ندارد
401بدون بدنه یا با پیامتوکن Bearer نامعتبر یا منقضی است؛ توکن را نوسازی کنید

جزئیات در کلید API و توکن و سشن آمده است.

کدهای status​

کددستهتوضیحات
-1عمومیخطا در انجام عملیات.
0عمومیعملیات با موفقیت انجام شد.
1موجودیموجودی کافی نیست.
2عمومیبا موفقیت حذف شد.
3عمومیبا موفقیت به‌روزرسانی شد.
4عمومیموردی یافت نشد.
5عمومیپیام شما در حال پردازش توسط سیستم می‌باشد.
2000الگوالگوی مورد نظر پیدا نشد.
2001الگوامکان استفاده از الگوی مورد نظر برای شما وجود ندارد.
2002الگوامکان ارسال پیام سریع برای الگوی مورد نظر وجود ندارد.
2003الگوپارامتر ورودی با الگو مطابقت ندارد.
2004الگوالگوی مورد نظر غیرفعال می‌باشد.
3000خطخط مورد نظر در سامانه موجود نمی‌باشد.
3001خطخط مورد نظر اختصاصی می‌باشد.
3002خطامکان ارسال پیام با الگو {0} برای شماره مورد نظر وجود ندارد.
3003خطامکان ارسال پیام با الگوی انتخابی برای شماره مورد نظر وجود ندارد.
3004خطخط مورد نظر غیرفعال می‌باشد.
3005خطارائه‌دهنده پیامک مورد نظر غیرفعال می‌باشد.
3500خط و اپراتورامکان ارسال پیام به برخی از شماره‌ها ممکن نیست (نامعتبر یا فهرست محرومان).
4000مسدودیاین پیام مطابق با قوانین سیستم تأیید نشد و ارسال آن امکان‌پذیر نیست.
4001مسدودیحساب کاربری شما مسدود شده است.
4100اعتبارسنجیسرویس اعتبارسنجی وجود ندارد.
4500برنامهاپلیکیشن معتبر نیست (X-Client-App الزامی است).
4501برنامهاپلیکیشن با حساب مطابقت ندارد.
4701شناسهمقدار UserId وجود ندارد.
4702شناسهمقدار Client_Id وجود ندارد.
5000پارامتربرخی از پارامترهای وارد شده معتبر نیستند.
5001پارامترکلید پارامتر نامعتبر است.
5002پارامترطول مقدار پارامتر از حد مجاز بیشتر است.
5003پارامترپارامتر اجباری مقدار ندارد.
5100ورودیساختار JSON ارسالی صحیح نیست.
5101ورودییکی از فیلدهای اجباری ارسال نشده است.
5102ورودیمقدار یک یا چند پارامتر ورودی معتبر نیست.
5103ورودیتعداد آیتم‌های ارسالی بیش از حد مجاز است.
6000سرویس ارسالسرویس ارسال پیام قفل می‌باشد. ارسال ممکن نیست.
6001سرویس ارسالسرویس ارسال پیامک مطابق با سرویس‌دهنده سرشماره شما یافت نشد.
6002سرویس ارسالدر ارتباط با سرویس ارسال پیامک خطایی رخ داد.
6100سرویس ارسالسرویس مدیریت ارسال مطابق با سرویس‌دهنده سرشماره شما یافت نشد.
7000پیام‌رسانهیچ پیام‌رسان فعالی برای کاربر یافت نشد.
7030پیام‌رسانکانال ارسال پیام نامعتبر می‌باشد.
8000ارسال گروهیمقادیر درخواست ارسال گروهی جدید با مقدار قبلی تطابق ندارد.
8001ارسال گروهیموجودی شما پاسخگوی عملیات نیست و به میزان {0} ریال کسری دارد.
8002ارسال گروهیخطا در بررسی وضعیت موجودی حساب شما.
8010ارسال گروهیکد دسته ارسالی در سامانه موجود نمی‌باشد.
10000مخاطبمخاطبی متناسب با فیلتر شما یافت نشد.

برای جزئیات خطاهای ارسال گروهی به خطاهای ارسال گروهی مراجعه کنید.

برای مشاهده فهرست به‌روز کدها از endpoint زیر استفاده کنید.

دریافت متن به‌روز کدها​

GET /sms/api/StatusCode

curl -X GET "https://api.payavasms.com/sms/api/StatusCode" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"status": 0,
"message": "عملیات با موفقیت انجام شد."
}
]

خطای پارامتر​

هنگام خطای پارامتر، data فهرستی از خطاهاست که اندیس گیرنده (index)، کلید (key)، کد (status) و دلیل (reason) را دارد. نمونه:

{
"status": 5002,
"message": "خطا در پارامترها",
"data": [
{ "index": 0, "key": "name", "status": 5002, "reason": "طول مقدار بیش از حد مجاز است" }
]
}

برای مشاهده فهرست کامل کدهای خطا و توضیحات مربوط به هرکدام، لطفاً به بخش وضعیت ها در پنل کاربری خود مراجعه کنید.