توضیحات اولیه

این قسمت با آخرین تکنولوژی های روز و به صورت اختصاصی برای ارسال پیامک از طریق Rest Api ایجاد شده است،با مطالعه توضیحات این داکیومنت میتوانید با سرعت بالا ارسال داشته باشید.

توجه : در سرویس هایی که برای ارسال میباشد،شما حداکثر 100 شماره را میتوانید در یک درخواست ارسال کنید
توجه : سرویس هایی که برای دریافت اطلاعات پیامهای ارسالی وجود دارند،اطلاعات پیامهای مربوط به 30 روزگذشته را نشان میدهند.

مدل خروجی سرویس ها

توجه : تمامی سرویس ها خروجی یکسانی خواهند داشت که به صورت زیر میباشد : 
        
            {
                "status" : "200",
                "message" : "با موفقیت انجام شد",
                "id" : 1,
                "data" : ...
                "errors" : [...]
            }
پارامتر توضیحات
status وضعیت درخواست
message توضیحات در صورت موفق بودن
id در صورت نیاز این شناسه برمیگردد
data داده های برگشته از سرویس
errors لیستی از خطاها
توجه : در صورتی که قرار باشد در یک سرویس مقداری یا مقادیری برگردد در قسمت data برمیگرد
توجه : در قسمت errors لیست از خطاها به صورت زیر برمیگردد 
        
            {
                "message" : "خطایی اتفاق افتاده است",
                "url" : "https://..",
                "code" : "3002",
                "field" : "UserName"
            }
پارامتر توضیحات
message پیام خطا
url آدرس توضیحات تکمیلی خطا
code کد خطا
field فیلدی که خطا روی آن اتفاق افتاده

کدهای وضعیت ارسال

توجه : این کدها شامل کدهای وضعیت پیامهای ارسال شده میباشد
کد وضعیت
0 ارسال شده به مخابرات
1 رسیده به گوشی
2 نرسیده به گوشی
8 رسیده به مخابرات
16 نرسیده به مخابرات
32 لیست سیاه
100 هنوز وضعیتی دریافت نشده
200 ارسال نشده

کدهای HttpStatus

توجه : در جدول زیر میتوانید کدهای اصلی خروجی سرویسها را مشاهده کنید :
کد پیام
200 درخواست با موفقیت انجام شد
204 داده ای برای درخواست شما وجود ندارد
400 درخواست شما اشتباه است
404 سرویس درخواستی شما اشتباه است
401 دسترسی شما غیر مجاز است
403 شما به این قسمت دسترسی ندارید
500 خطای داخلی سرور

کدهای خروجی سیستم

توجه : در این قسمت میتوانید لیست کدهای خروجی سیستم را مشاهده کنید :
کد پیام
0 درخواست شما با موفقیت انجام شد
1 شماره گیرنده نادرست است
2 شماره فرستنده نادرست است
3 پارامتر انکودینگ نامعتبر است
4 پارامتر mclass نامعتبر است
6 پارامتر UDH نامعتبر است
13 محتویات پیامک خالی است
14 مانده اعتبار ریالی مورد نیاز برای ارسال پیامک کافی نیست
15 سرور در هنگام ارسال پیام مشغول بر طرف نمودن ایراد داخلی بوده است
16 حساب غیر فعال است
17 حساب منقضی شده است
18 نام کاربری و یا کلمه عبور نا معتبر است
19 درخواست معتبر نیست
20 شماره فرستنده به حساب تعلق ندارد
22 این سرویس برای حساب فعال نشده است
23 در حال حاضر امکان پردازش درخواست جدید وجود ندارد،لطفا دوباره سعی کنید
24 شناسه پیامک نا معتبر است
25 نام متد درخواستی معتبر نیست
27 شماره گیرنده در لیست سیاه اپراتور قرار دارد
28 شماره گیرنده بر اساس پیش شماره در حال حاضر در پروایدر مسدود است
29 آدرس IP مبدا، اجازه دسترسی به این سرویس را ندارد
30 تعداد بخش‌های پیامک بیش از حد مجاز استاندارد (۲۶۵ عدد) است
101 طول آرايه پارامتر messageBodies با طول آرايه گيرندگان تطابق ندارد
102 طول آرايه پارامتر messageClass با طول آرايه گيرندگان تطابق ندارد
103 طول آرايه پارامتر senderNumbers با طول آرايه گيرندگان تطابق ندارد
104 طول آرايه پارامتر udhs با طول آرايه گيرندگان تطابق ندارد
105 طول آرايه پارامتر priorities با طول آرايه گيرندگان تطابق ندارد
106 آرايه‌ی گيرندگان خالی است
107 طول آرايه پارامتر گيرندگان بيشتر از طول مجاز است
108 طول آرايه پارامتر encoding با طول آرايه گيرندگان تطابق ندارد
109 طول آرايه پارامتر گيرندگان بيشتر از طول مجاز است
110 طول آرايه پارامتر checkingMessageIds با طول آرايه گيرندگان تطابق ندارد
401 کلید امنیتی شما منقضی شده یا اشتباه است
500 خطایی اتفاق افتاده است،لطفا با پشتیبانی تماس بگیرید
1001 کلید امنیتی شما با موفقیت ایجاد شد
1002 داده ای وجود ندارد
3000 نام کاربری اجباری است
3001 طول نام کاربری نمیتواند بیشتر از 150 کاراکتر باشد
3002 وارد کردن رمز وب سرویس اجباری است
3003 شماره ارسال اجباری است
3004 تعداد روز اعتبار کلید باید حداقل یک و حداکثر 365 روز باشد
3005 تعداد پیامها نباید بیشتر از 100 باشد
4001 نام کاربری یا رمز عبور اشتباه است
4002 شما نمیتوانید از طریق این دامنه درخواست بدهید
4003 شماره ارسال اشتباه است
4004 وضعیت شماره ارسال مناسب ارسال نیست