یکی از قابلیتهایی که هر وب‌سایت بزرگی از آن استفاده می‌کند وبسرویس پیامک است. وب‌سایت‌ها و اپلیکیشن‌ها از وبسرویس پیامکی برای ارسال اس ام اس‌های اطلاع‌رسانی ثبت‌نام و ورود کاربران، OTP و فراموشی رمز عبور، ثبت سفارش‌ها و تغییر وضعیت سفارش، تکمیل فرم، حمل و نقل و… استفاده می‌کنند. در این مسیر برنامه‌نویسان یا توسعه‌دهندگان این کسب‌وکارها ممکن است در هنگام پیاده‌سازی و استفاده از وبسرویس و API پیامک، با خطا مواجه شوند. در این مقاله قصد داریم لیست خطاهای وبسرویس پیامک را در اختیارتان قرار دهیم، اما قبل از بررسی لیست خطاهای وبسرویس اس ام اس، باید بدانیم که وبسرویس چیست؟
وبسرویس و API چیست؟
وبسرویس (Web Service) یا API مخفف Application Programming Interface، یکی از اصطلاحات رایج بین برنامه‌نویسان است و در واقع یک رابط برنامه‌نویسی است که در بستر وب پیاده‌سازی می‌شود و که این رابط‌ها با استفاده از پروتکل‌های استاندارد مانند http و https، تابع‌ها و مکانیزم‌ها و عملکردهای مختلفی را در اختیار برنامه‌نویسان قرار می‌دهند. وبسرویس همانند یک پل ارتباطی است که برای تبادل اطلاعات بین نرم‌افزارها و سایت‌های مختلف توسط سازمان W3C توسعه داده شده است. وبسرویس پیامک، مانند آن پل ارتباطی است که برای ارسال پیامک‌های اطلاع‌رسانی سایت، اپلیکیشن، نرم‌افزار یا CRM شما را به مدیران و مشتریان شما مورد استفاده قرار می‌گیرد.
مطالعه مقاله "وب سرویس و API چیست؟" به شما برای درک بهتر وب سرویس کمک خواهد کرد.
شما و یا برنامه‌نویس و توسعه‌دهنده وب‌سایت یا نرم‌افزار شما، با استفاده از وبسرویس می‌توانید از انواع وبسرویس ملی پیامک استفاده کنید. ملی پیامک یکی از قدرتمندترین و جامع‌ترین سامانه‌های پیامکی است که به شما امکان مدیریت پیامک‌های ارسالی، smsهای دریافتی، پیام‌های زماندار، دفترچه تلفن، پیام صوتی و… را می‌دهد. با دانستن خطاهای وبسرویس پیامک شما می‌توانید در صورت بروز مشکل به راحتی مورد را مرتفع نمائید.
انواع وبسرویس های پیامکی
قبل از معرفی خطاهای وبسرویس پیامک بهتر است با انواع وب سرویس و API سامانه ملی پیامک آشنا شوید. به طور کلی متدها و توابع وبسرویس ملی پیامک به 8 دسته کلی زیر تقسیم می‌شود:
- وب سرویس ارسال پیامک
- وب سرویس ارسال پیامک از طریق پترن و الگو
- وب سرویس دریافت پیامک
- وب سرویس پیام صوتی
- وب سرویس ارسال پیامک زمان‌بندی شده
- وب سرویس دفترچه تلفن
- وب سرویس ارسال انبوه و منطقه‌ای
- وب سرویس نمایندگان
حال، همانطور که کمی قبل‌تر نیز به آن اشاره کردیم، ممکن است زمانیکه در حال استفاده از وب سرویس پیامکی هستید، با خطاهایی روبرو شوید که ما لیست کامل و جامع خطاها و ارورهای وب سرویس پیامک را برایتان در این مقاله قرار داده‌ایم کرده‌ایم.
لیست خطاهای وب سرویس پیامک
از آنجایی که گردآوری همه خطاهای ممکن‌الوقوع در وب سرویس اس ام اس خارج از حوصله این مقاله است و تمامی اطلاعات مورد نیاز شما را در صفحه مستندات وب سرویس پیامک وجود دارد، در زیر و به اختصار فقط خطاهای وب سرویس ارسال پیامک (وبسرویس عادی و ارسال از خط اختصاصی) و خطاهای وب سرویس ارسال پیامک بر اساس پترن و الگو (وبسرویس خدماتی) را لیست کرده‌ایم. برای درک بهتر تفاوت‌های ارسال پیامک از خط اختصاصی و و ارسال پیامک از خط خدماتی-اشتراکی، نظر شما به تعریف کوتاه هر کدام جلب می‌کنم.
خط اختصاصی: هر یک از پنل‌های سامانه ملی پیامک، دارای حداقل 1 خط مجازی فرستنده پیامک و یا همان سرشماره پیام کوتاه است که این خطوط معمولاً به‌صورت تبلیغاتی فعال می‌شوند و امکان ارسال اس ام اس به افرادی که پیامک‌های تبلیغاتی سیمکارت خودشان را مسدود کرده‌اند(لیست سیاه مخابرات) ندارند.
خط خدماتی: این خطوط با ارائه مدارک خاص، از سوی اپراتورها از حالت تبلیغاتی به حالت خدماتی تغییر می‌یابند و به شما امکان ارسال پیامک به آن دسته از مخاطبینی که در لیست سیاه مخابرات قرار دارند را نیز می‌دهد. پیشنهاد می‌کنم برای کسب اطلاعات بیشتر به صفحه "خط خدماتی چیست؟" مراجعه کنید.
خطاهای وب سرویس ارسال پیامک
پس از اینکه از وبسرویس ملی پیامک استفاده کردید، عددی را در پاسخ درخواست وب سرویس و API به شما از سوی سامانه ملی پیامک نمایش می‌دهد، که این اعداد معانی مختلفی دارند.
رشته اعداد چند رقمی: recId ارسال پیامک که یک مقدار یکتا برای هر ارسال موفق می‌باشد. (در صورت دریافت recId که یک عدد بیش از 15 رقم است، به معنای ارسال موفق بوده و برای دریافت گزارش و وضعیت ارسال می‌توانید از متد دریافت گزارش مانند GetDeliveries استفاده نمایید.)
1-: خطای نامشخصی رخ داده است. با پشتیبانی تماس بگیرید.
0: پنل اس ام اس امکان اتصال به وب سرویس را ندارد / نام کاربری یا رمز عبور وارد شده صحیح نیست.
1: ارسال پیامک با موفقیت انجام شد.
2: موجودی و اعتبار پنل اس ام اس کافی نیست.
3: محدودیت در ارسال روزانه
4: محدودیت در حجم و تعداد ارسال پیامک
5: شماره فرستنده یا سرشماره پیامکی معتبر نمی‌باشد.
6: سامانه در حال بروزرسانی است.
7: متن پیامک حاوی کلمه یا کلمات فیلتر شده است.
8: عدم رسیدن به حداقل تعداد ارسال پیامک
9: ارسال از خطوط عمومی از طریق وب سرویس امکان‌پذیر نمی‌باشد.
10: پنل اس ام اس کاربر فعال نمی‌باشد و یا پنل پیامک کاربر مسدود شده است.
11: ارسال نشده / شماره موبایل گیرنده در لیست سیاه مخابرات قرار دارد.
12: مدارک پنل اس ام اس کاربر کامل نمی‌باشد.
14: سرشماره فرستنده پیامک، امکان ارسال لینک را ندارد.
35: در هنگام استفاده از REST به معنای وجود شماره موبایل گیرنده در لیست سیاه مخابرات است.
خطاهای وب سرویس ارسال پیامک بر اساس پترن (الگو)
یکی دیگر از متدهای پرطرفدار ارسال پیامک در سامانه ملی پیامک، ارسال از طریق پترن (الگو) یا همان استفاده اشتراکی از خطوط خدماتی سامانه با استفاده از وبسرویس است. در این روش نیز همانند قبل وبسرویس به شما به واسطه ارسال پاسخ عددی برای رفع مشکل راهنمایی می‌کند. این خطاهای عددی معمولا به شرح زیر است:
رشته اعداد چند رقمی: recId ارسال پیامک که یک مقدار یکتا برای هر ارسال موفق می‌باشد. (در صورت دریافت recId که یک عدد بیش از 15 رقم است، به معنای ارسال موفق بوده و برای دریافت گزارش و وضعیت ارسال می‌توانید از متد دریافت گزارش مانند GetDeliveries استفاده نمایید.)
7-: خطایی در شماره فرستنده پیامک رخ داده است، لطفاً با پشتیبانی فنی تماس بگیرید.
6-: خطای داخلی رخ داده است، لطفاً با پشتیبانی فنی تماس بگیرید. (در این حالت ممکن است الگو یا پترن شما به‌درستی درج نشده باشد یعنی در متغیرها به‌جای استفاده از {} از () یا کاراکتر دیگری استفاده کردید و یا ممکن است اعداد درون {} را به‌ترتیب ننوشته باشید و یا از اعداد فارسی در درون {} استفاده کرده باشید)
5-: تعداد اندیس‌های آرایه پارامتر text با تعداد متغیرهای پترن شما مطابقت ندارد. (مثلاً اگر پترن شما 3 متغیر داشته باشد، شما در پارامتر text از چیزی تعریف نکرده‌اید و یا تعداد اندیس‌های آن برابر با عدد 3 نیست، یعنی ممکن است تعداد اندیس‌های پارامتر text شما 0، 1، 2 یا 4 یا بیشتر است.)
4-: کد متن یا همان کد پترن یا همان کد الگو یا همان شماره قالب وارد شده صحیح نیست / کد متن شما توسط مدیر سامانه تایید نشده است.
3-: سرشماره فرستنده پیامک‌ها در سیستم تعریف نشده است، لطفاً با پشتیبانی فنی تماس بگیرید. / تعداد شماره موبایل گیرنده مجاز نیست.
2-: محدودیت تعداد شماره موبایل گیرنده، در هر بار ارسال یک شماره موبایل مجاز است.
1-: دسترسی برای استفاده از این وبسرویس غیرفعال است. لطفاً با پشتیبانی تماس بگیرید.
0: پنل اس ام اس امکان اتصال به وب سرویس را ندارد / نام کاربری یا رمز عبور وارد شده صحیح نیست.
1: ارسال پیامک با موفقیت انجام شد.
2: موجودی و اعتبار پنل اس ام اس کافی نیست.
6: سامانه در حال بروزرسانی است.
7: متن پیامک حاوی کلمه یا کلمات فیلتر شده است.
10: پنل اس ام اس کاربر فعال نمی‌باشد و یا پنل پیامک کاربر مسدود شده است.
11: ارسال نشده / شماره موبایل گیرنده در لیست سیاه پنل اس ام اس قرار دارد.
12: مدارک پنل اس ام اس کاربر کامل نمی‌باشد.
نحوه نمایش خطاهای وبسرویس در کنسول ملی پیامک
شاید بپرسید که کنسول ملی پیامک چیست؟! برای پاسخ به این پرسش، پیشنهاد می‌کنم مقاله کنسول ملی پیامک را مطالعه کنید.
کنسول ملی پیامک یک سرویس بر پایه REST API و Auth Token است که مخصوص برنامه‌نویسان بوده و قطعه کد کاملاً آماده و بدون نیاز به کدنویسی را ارئه می‌کند. این سرویس به شما امکان استفاده از قطعه کدهای کاملاً آماده در وب سرویس پیامک را فراهم کرده است که تنها نیاز به مقداردهی به پارامترهای توابع مختلف آن را دارد. در صورتی که قصد استفاده از این سرویس را دارید و یا در حال استفاده از آن هستید، برای راحتی کار شما خطاها و پاسخ‌های بازگشتی از سوی وب سرویس سامانه را ساده‌سازی کرده‌ایم، به‌گونه‌ای که اگر هر نتیجه‌ای از سوی وبسرویس و API بازگشت داده شود، به‌جای عدد معنی فارسی آن را برایتان نمایش خواهد داد.
در حال حاضر در کنسول ملی پیامک، نمونه کدهای زبان‌های برنامه‌نویسی زیر را دارا می‌باشد که شما جهت اتصال پنل اس ام اس به وب سایت، نرم‌افزار یا CRM خود می‌توانید استفاده نمائید.
- php
- #C
- Java (اندروید)
- Node.js
- Python
لیست کامل خطاهای وبسرویس پیامک در مستندات وبسرویس ملی پیامک
در این مقاله سعی کردیم به‌طور خلاصه معنی تمامی مقادیر بازگشتی از سوی وبسرویس و API سامانه و خطاها را برایتان بنویسیم. اگر شما در حال استفاده از دیگر توابع و متدهای ملی پیامک هستید، برای مشاهده لیست خطاهای وب سرویس هر متد به صفحه "مستندات وب سرویس ملی پیامک" مراجعه نمائید.
نمونه کدهای وب سرویس پیامک
سامانه ملی پیامک علاوه‌بر اینکه یکی از پیشرفته‌ترین سامانه‌های ارسال پیام کوتاه است که در کنار حدود 80 امکان مختلف برای مدیریت ارسال و دریافت پیامک در بستر پنل اس ام اس فراهم کرده است، یکی از جامع‌ترین و قدرتمندترین سامانه‌های پنل پیامکی است که در حوزه وب سرویس و API پیامکی، برای بیش از 14 زبان برنامه‌نویسی گوناگون، نمونه کدها را آماده کرده است. برای دریافت نمونه کد مورد نظر خود می‌توانید به صفحه گیتهاب ملی پیامک، صفحه مستندات وب سرویس و یا کنسول ملی پیامک(مخصوص برنامه‌نویسان) مراجعه کنید.
خطاهای وبسرویس پیامک برای شما ناشناخته است؟
اگر همچنان سوالی در ذهنتان باقی مانده و یا برای رفع خطاهای وبسرویس پیامک خود نیاز به راهنمایی بیشتری دارید، می‌توانید به طرق مختلف با پشتیبانی فنی در ارتباط باشید. جهت ارتباط با کارشناسان فنی ملی پیامک، ضمن درج تیکت در داخل سامانه، می‌توانید با شماره 02163404 داخلی 1 و سپس داخلی 3 تماس بگیرید و یا نظرات خود را در قسمت دیدگاه‌ها با ما به اشتراک بگذارید.
یک دیدگاه بگذارید