لیست خطاهای وبسرویس ملی پیامک

یکی از قابلیت‌‎هایی که هر وب‌سایت بزرگی از آن استفاده می‌کند وبسرویس پیامک است. وب‌سایت‌ها و اپلیکیشن‌ها از وب‌سرویس پیامکی برای ارسال اس ام اس‌های اطلاع‌رسانی ثبت‌نام و ورود کاربران، OTP و فراموشی رمز عبور، ثبت سفارش‌ها و تغییر وضعیت سفارش، تکمیل فرم، حمل و نقل و... استفاده می‌کنند. در این مسیر برنامه‌نویسان یا توسعه‌دهندگان این کسب‌وکارها ممکن است در هنگام پیاده‌سازی و استفاده از وبسرویس و API پیامک، با خطا مواجه شوند. در این مقاله قصد داریم لیست خطاهای وبسرویس پیامک را در اختیارتان قرار دهیم، اما قبل از بررسی لیست خطاهای وبسرویس اس ام اس، باید بدانیم که وبسرویس چیست؟

وبسرویس و API چیست؟

وبسرویس (Web Service) یا API مخفف Application Programming Interface، یکی از اصطلاحات رایج بین برنامه‌ نویسان است و در واقع یک رابط برنامه‌نویسی است که در بستر وب پیاده‌سازی می‌شود که این رابط‌ها با استفاده از پروتکل‌های استاندارد مانند http و https، تابع‌ها و مکانیزم‌ها و عملکردهای مختلفی را در اختیار برنامه‌نویسان قرار می‌دهند. وبسرویس همانند یک پل ارتباطی است که برای تبادل اطلاعات بین نرم‌افزارها و سایت‌های مختلف توسط سازمان W3C توسعه داده شده است. وبسرویس پیامک، مانند آن پل ارتباطی است که برای ارسال پیامک‌های اطلاع‌رسانی سایت، اپلیکیشن، نرم‌افزار یا CRM به مدیران و مشتریان شما، مورد استفاده قرار می‌گیرد.

مطالعه مقاله "وب سرویس و API چیست؟" به شما برای درک بهتر وب سرویس کمک خواهد کرد.

برنامه‌نویس، توسعه‌دهنده وب‌سایت یا نرم‌افزار شما، همگی می‌توانید از انواع وب‌سرویس ملی پیامک استفاده کنید. ملی پیامک یکی از قدرتمندترین و جامع‌ترین سامانه‌های پیامکی است که به شما امکان مدیریت پیامک‌های ارسالی، smsهای دریافتی، پیام‌های زماندار، دفترچه تلفن، پیام صوتی و... را می‌دهد. با دانستن خطاهای وبسرویس پیامک شما می‌توانید در صورت بروز مشکل به راحتی مورد را مرتفع نمائید.

انواع وبسرویس‌های پیامکی

قبل از معرفی خطاهای وبسرویس پیامک بهتر است با انواع وب سرویس و API سامانۀ ملی پیامک آشنا شوید. به طور کلی متدها و توابع وبسرویس ملی پیامک به 8 دسته کلی زیر تقسیم می‌شود:

• وب سرویس ارسال پیامک
• وب سرویس ارسال پیامک از طریق پترن و الگو
• وب سرویس دریافت پیامک
• وب سرویس پیام صوتی
• وب سرویس ارسال پیامک زمان‌بندی شده
• وب سرویس دفترچه تلفن
• وب سرویس ارسال انبوه و منطقه‌ای
• وب سرویس نمایندگان

حال، همانطور که کمی قبل‌تر نیز به آن اشاره کردیم، ممکن است زمانیکه در حال استفاده از وب سرویس پیامکی هستید، با خطاهایی روبرو شوید که ما لیست کامل و جامع خطاها و ارورهای وب سرویس پیامک را برایتان در این مقاله قرار داده‌ایم.

لیست خطاهای وب سرویس پیامک

از آنجایی که گردآوری همۀ خطاهای ممکن‌الوقوع در وب سرویس اس ام اس خارج از حوصله این مقاله است و تمامی اطلاعات مورد نیاز شما نبز در صفحه مستندات وب سرویس پیامک وجود دارد، در زیر و به اختصار فقط خطاهای وب سرویس ارسال پیامک (وبسرویس عادی و ارسال از خط اختصاصی) و خطاهای وب سرویس ارسال پیامک بر اساس پترن و الگو (وبسرویس خدماتی) را لیست کرده‌ایم. برای درک بهتر تفاوت‌های ارسال پیامک از خط اختصاصی و و ارسال پیامک از خط خدماتی-اشتراکی، نظر شما را به تعریف کوتاه هر کدام جلب می‌کنیم.

خط اختصاصی: هر یک از پنل‌های سامانه ملی پیامک، دارای حداقل 1 خط مجازی فرستنده پیامک یا همان سرشماره پیام کوتاه است که این خطوط معمولاً به‌صورت تبلیغاتی فعال می‌شوند و امکان ارسال اس ام اس به افرادی که پیامک‌های تبلیغاتی سیمکارت خودشان را مسدود کرده‌اند(لیست سیاه مخابرات) ندارند.

خط خدماتی: این خطوط با ارائه مدارک خاص، از سوی اپراتورها از حالت تبلیغاتی به حالت خدماتی تغییر می‌یابند و به شما امکان ارسال پیامک به آن دسته از مخاطبینی که در  لیست سیاه مخابرات قرار دارند را نیز می‌دهد. پیشنهاد می‌کنم برای کسب اطلاعات بیشتر به صفحه "خط خدماتی چیست؟" مراجعه کنید.

خطاهای وب سرویس ارسال پیامک

پس از اینکه از وب‌سرویس ملی پیامک استفاده کردید، عددی را در پاسخ درخواست وب سرویس و API به شما از سوی سامانه ملی پیامک نمایش می‌دهد، که این اعداد معانی مختلفی دارند. در جدول زیر به معانی این اعداد می‌پردازیم:

   

کد خطا	توضیحات
رشته عددی (recId)	شناسه یکتای ارسال پیامک است و نشان‌دهندۀ ارسال موفق می‌باشد.
111-	IP درخواست‌کننده نامعتبر است.
110-	الزام استفاده از ApiKey به‌جای رمز عبور
109-	الزام تنظیم IP مجاز برای استفاده از API
108-	مسدودشدن IP به‌دلیل تلاش ناموفق استفاده از API
1-	خطای نامشخص؛ برای بررسی با پشتیبانی تماس بگیرید.
0	اتصال به وب‌سرویس ممکن نیست یا نام کاربری و رمز عبور اشتباه است.
1	ارسال پیامک با موفقیت انجام شد.
2	اعتبار پنل پیامک کافی نیست؛ موجودی خود را افزایش دهید.
3	محدودیت در تعداد ارسال روزانه فعال است.
4	محدودیت در حجم یا تعداد پیامک‌های ارسالی وجود دارد.
5	شماره فرستنده یا سرشماره پیامکی معتبر نیست.
6	سامانه در حال بروزرسانی است؛ بعداً تلاش کنید.
7	متن پیامک شامل کلمه یا عبارت فیلترشده است.
8	تعداد پیامک‌ها کمتر از حداقل مجاز برای ارسال است.
9	ارسال از خطوط عمومی از طریق وب‌سرویس مجاز نیست.
10	پنل پیامکی غیرفعال یا مسدود شده است.
11	ارسال انجام نشد؛ شماره گیرنده در لیست سیاه مخابرات است.
12	مدارک احراز هویت کاربر کامل نیست.
14	سرشماره فرستنده امکان ارسال پیامک حاوی لینک را ندارد.
15	در پیام‌های چندگیرنده، عبارت «لغو11» در انتهای متن نوشته نشده است.
16	شماره موبایل گیرنده یافت نشد؛ پارامتر to را بررسی کنید.
17	متن پیامک خالی است یا متغیر text مقدار ندارد.
35	در متد REST، شماره گیرنده در لیست سیاه مخابرات قرار دارد.
18	شماره موبایل گیرنده نامعتبر است.

خطاهای وب سرویس ارسال پیامک بر اساس پترن (الگو)

یکی دیگر از متدهای پرطرفدار ارسال پیامک در سامانه ملی پیامک، ارسال از طریق پترن (الگو) یا همان استفاده اشتراکی از خطوط خدماتی سامانه با استفاده از وبسرویس است. در این روش نیز همانند قبل وبسرویس به شما به واسطۀ ارسال پاسخ عددی برای رفع مشکل راهنمایی می‌کند. این خطاهای عددی معمولا به شرح زیر است:

 

کد خطا	توضیحات
رشته عددی (recId)	شناسه یکتای ارسال پیامک است و نشان‌دهندۀ ارسال موفق می‌باشد.
111-	IP درخواست‌کننده نامعتبر است.
110-	الزام استفاده از ApiKey به‌جای رمز عبور
109-	الزام تنظیم IP مجاز برای استفاده از API
108-	مسدودشدن IP به‌دلیل تلاش ناموفق استفاده از API
10-	ارسال لینک، آی‌پی یا ایمیل به‌جای متغیر مجاز نیست؛ آن‌ها را از متن حذف کنید.
7-	خطا در شماره فرستنده؛ برای بررسی با پشتیبانی تماس بگیرید.
6-	خطای داخلی؛ ممکن است ساختار پترن یا کاراکترهای درون {} اشتباه نوشته شده باشند.
5-	تعداد اندیس‌های پارامتر text با تعداد متغیرهای پترن مطابقت ندارد.
4-	کد پترن (کد متن) اشتباه است یا هنوز توسط مدیر سامانه تأیید نشده است.
3-	سرشماره پیامک در سیستم تعریف نشده یا تعداد شماره گیرنده نامعتبر است.
2-	در هر بار ارسال، فقط یک شماره موبایل مجاز به استفاده است.
1-	دسترسی به وب‌سرویس پترن غیرفعال است؛ با پشتیبانی تماس بگیرید.
0	اتصال به وب‌سرویس ممکن نیست یا نام کاربری/رمز عبور اشتباه است.
1	ارسال پیامک با موفقیت انجام شد.
2	اعتبار پنل پیامکی کافی نیست؛ موجودی را افزایش دهید.
6	سامانه در حال بروزرسانی است؛ بعداً تلاش کنید.
7	متن پیامک حاوی کلمه یا عبارت فیلترشده است.
10	پنل پیامک غیرفعال یا مسدود شده است.
11	ارسال انجام نشد؛ شماره گیرنده در لیست سیاه پنل پیامکی است.
12	مدارک احراز هویت کاربر ناقص است.
16	شماره گیرنده یافت نشد؛ پارامتر to را بررسی کنید.
17	متن پیامک خالی است یا متغیر text مقدار ندارد.
18	شماره موبایل گیرنده نامعتبر است.
19	از محدودیت ساعتی فراتر رفته اید.

نحوه نمایش خطاهای وبسرویس در کنسول ملی پیامک

شاید بپرسید که کنسول ملی پیامک چیست؟! برای پاسخ به این پرسش، پیشنهاد می‌کنم مقاله کنسول ملی پیامک را مطالعه کنید.

کنسول ملی پیامک یک سرویس بر پایه REST API و Auth Token است که مخصوص برنامه‌نویسان بوده و قطعه کد کاملاً آماده و بدون نیاز به کدنویسی را ارئه می‌کند. این سرویس به شما امکان استفاده از قطعه کدهای کاملاً آماده در وب سرویس پیامک را فراهم کرده است که تنها نیاز به مقداردهی به پارامترهای توابع مختلف آن را دارد. در صورتی که قصد استفاده از این سرویس را دارید یا در حال استفاده از آن هستید، برای راحتی کار شما خطاها و پاسخ‌های بازگشتی از سوی وب سرویس سامانه را ساده‌سازی کرده‌ایم، به‌گونه‌ای که اگر هر نتیجه‌ای از سوی وبسرویس و API بازگشت داده شود، به‌جای عدد معنی فارسی آن را برایتان نمایش خواهد داد.

در حال حاضر در کنسول ملی پیامک، نمونه کدهای زبان‌های برنامه‌نویسی زیر را دارا می‌باشد که شما جهت اتصال پنل اس ام اس به وب سایت، نرم‌افزار یا CRM خود می‌توانید استفاده نمائید.

• php
• #C
• Java (اندروید)
• Node.js
• Python

لیست کامل خطاهای وبسرویس پیامک در مستندات وبسرویس ملی پیامک

در این مقاله سعی کردیم به‌طور خلاصه معنی تمامی مقادیر بازگشتی از سوی وبسرویس و API سامانه و خطاها را برایتان بنویسیم. اگر شما در حال استفاده از دیگر توابع و متدهای ملی پیامک هستید، برای مشاهده لیست خطاهای وب سرویس هر متد به صفحۀ "مستندات وب سرویس ملی پیامک" مراجعه نمائید.

نمونه کدهای وب سرویس پیامک

سامانه ملی پیامک علاوه‌بر اینکه یکی از پیشرفته‌ترین سامانه‌های ارسال پیام کوتاه است که در کنار حدود 80 امکان مختلف برای مدیریت ارسال و دریافت پیامک در بستر پنل اس ام اس فراهم کرده است، یکی از جامع‌ترین و قدرتمندترین سامانه‌های پنل پیامکی است که در حوزه وب سرویس و API پیامکی، برای بیش از 14 زبان برنامه‌نویسی گوناگون، نمونه کدها را آماده کرده است. برای دریافت نمونه کد مورد نظر خود می‌توانید به صفحه گیتهاب ملی پیامک، صفحه مستندات وب سرویس یا کنسول ملی پیامک(مخصوص برنامه‌نویسان) مراجعه کنید.

خطاهای وبسرویس پیامک برای شما ناشناخته است؟

اگر همچنان سوالی در ذهنتان باقی مانده یا برای رفع خطاهای وبسرویس پیامک خود نیاز به راهنمایی بیشتری دارید، می‌توانید به طرق مختلف با پشتیبانی فنی در ارتباط باشید. جهت ارتباط با کارشناسان فنی ملی پیامک، ضمن درج تیکت در داخل سامانه، می‌توانید با شماره 02163404 داخلی 1 و سپس داخلی 3 تماس بگیرید یا نظرات خود را در قسمت دیدگاه‌ها با ما به اشتراک بگذارید.