راهنمای وب سرویس

سجاد نبیونی 1400/11/06 912

با استفاده از مستندات وب سرویس و API شرکت و نمونه کدهای آن می توانید وبسایت، نرم افزار و اپلیکیشن خود را به سامانه پیامکی متصل نمایید.

وب سرویس  ارسال پیامک

 

 

کاربرانی که قصد فعالسازی وب سرویس را دارند و می خواهند وب سایت و یا نرم افزار خود را به پنل پیامکی جهت ارسال پیامک متصل کنند، پس از خرید پنل می بایست وب سرویس خود را فعال نمایند.

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

 

 

 

فعالسازی وب سرویس

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

در این قسمت زبان های برنامه نویسی مختلف مانند:

.net , python , c#, php, java ,….


وجود دارند و با توجه به زبانی که برنامه یا وبسایت شما نوشته شده است می توانید نمونه کد مربوطه را دانلود و استفاده نمایید.

 

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

وردپرس

در صورتی که از cms  وردپرس برای ایجاد سایت خود استفاده کرده‌اید، می توانید از افزونه‌های شخصی سازی شده موجود در وب سرویس و نمونه کدها استفاده نمایید

 


 

افزونه ها:

. هر افزونه کاربرد خاصی دارد و با توجه به نیاز خود می توانید آنها را دانلود و استفاده نمایید.

 

افزونه دیجیتس :

 افزونه digits برای ارسال های otp  استفاده می شود و محبوب ترین افزونه در این زمینه است. با این افزونه، قابلیت ثبت نام با شماره موبایل و تایید شماره موبایل به سایت وردپرس شما اضافه می شود و کاربران سایت شما می توانند بدون نیاز به ایمیل در سایت شما عضو شوند.

 

افزونه پیامک ووکامرس woocommerce

افزونه پیامکی ووکامرس، در وبسایت های فروشگاهی برا پایه فروشگاه ساز ووکامرس استفاده می شود و  ارسال پیامک در هنگام ثبت سفارش، ارسال پیامک بعد از خرید و تغییر وضعیت خرید برای مدیر و مشتریان را در اختیار کاربران قرار می دهد.

 

افزونه پیامک  وردپرس wp-sms:

 افزونه پیامکی وردپرس برای کاربرانی است که سایت فروشگاهی ندارند و یا میخواهند به صورت مستقل برای کاربران خود و یا اعضای خبرنامه وبسایت خود ارسال پیامک انجام دهند.

 

افزونه پیامکی گرویتی فرم Gravity Form:

 افزونه گرویتی فرم برای ساخت ، ویرایش و پیکربندی فرم در وردپرس مورد استفاده قرار می گیرد و به وسیله افزونه پیامکی آن می توانید از برای کاربران ارسال پیامک نمایید.

 

افزونه میهن پنل Mihan-panel:

افزونه میهن پنل یک افزونه ایرانی شخصی سازی شده است و کاربرد های فراوانی دارد که می توان به ایجاد صفحه ورود و ثبت نام با شماره موبایل و ایجاد پنل کاربری برای هر شخص و امکان ویرایش پنل توسط کاربر اشاره کرد.

 

تنظیمات افزونه های وردپرس :

تمام افزونه ها دارای بخشی به نام تنظیمات پیامک است .

درگاه: در قسمت تنظیمات پیامک می بایست درگاه را بر روی نیازپرداز (niazpardaz)  قرار دهید. درگاه افزونه پیامک ووکامرس login.niazpardaz.ir  و درگاه افزونه پیامک ورد پرس (wp-sms) نیز new niazpardaz  است .

نام کاربری و رمز عبور می بایست مطابق نام کاربری و رمز عبور پنل باشد.

شماره فرستنده : شماره فرستنده را بر روی خط اختصاصی خود تنظیم نمایید. خط اختصاصی، امکان ارسال به لیست سیاه ( شماره هایی که پیام های تبلیغاتی خود را بسته اند ) ندارد. در صورت تمایل برای ارسال به لیست سیاه می بایست خط خدماتی دریافت نمایید که شرح آن در ادامه گفته شده است.

 

پیامک ارسال سریع وب سرویس نیازپرداز

مراحل فعالسازی خط خدماتی جهت ارسال به لیست سیاه و OTP :


در صورتی که پنل خود را جهت استفاده از وب سرویس و ارسال پیامک اطلاع رسانی ( مانند OTP  و .. ) به همه شماره ها ( لیست سیاه و آزاد ) خریداری کرده‌اید می بایست از خط خدماتی استفاده نمایید.

 

برای اینکار:

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

 

 

 

نکات:

 

  • کاربرانی که از خط تبلیغاتی استفاده می کنند در صورت ارسال به لیست سیاه با خطای 16 مواجه خواهند شد.

 

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

 

 

نکات موجود در فایل پترن ها:


- بعد از باز کردن فایل آماده جهت سهولت در استفاده ابتدا متن های آماده را با RCtrl + Rshift راست چین کنید

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

- متون اعلام شده توسط کاربر می بایست مشابه فایل اعلام شده باشد و می بایست بخش ثابت و متغیر ها مشخص باشد.

- در صورتی که قسمت ثابت متن ها تغییر یابد خطای بازگشتی 18 دریافت خواهید کرد . با دریافت این خطا می توانید جهت رفع مشکل متن از طریق منو سمت راست ، پشتیبانی ، تیکت اقدام نمایید.

 

 

 

 

 

کدهای بازگشتی:

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

int

0 : ارسال با موفقیت انجام شد

1 : نام کاربر یا کلمه عبور نامعتبر می باشد

2 : کاربر مسدود شده است

3 : شماره فرستنده نامعتبر است

4 : محدودیت در ارسال روزانه

5 : تعداد گیرندگان حداکثر 100 شماره می باشد

6 : خط فرسنتده غیرفعال است

7 : متن پیامک شامل کلمات فیلتر شده است

8 : اعتبار کافی نیست

9 : سامانه در حال بروز رسانی می باشد

10 : وب سرویس غیرفعال است

11 : تعداد پیامها و شماره ها باید یکسان باشد

12 : تعداد پیامها حداکثر 100 پیام می باشد

13 : LimitationInMesssageContentCount

14 : هیچ مقداری برای تعرفه جاری کاربر تعریف نشده است

15 : ارسال تکراری متن مشابه به شماره مشابه در مدت زمان مشخص

16 : ﺷﻤﺎره ﻣﻮﺑﺎﻳﻞ گیرنده ﻳﺎﻓﺖ ﻧﺸﺪ، ارسال از خط تبلیغاتی به شماره های لیست سیاه

17 : متن وارد نشده است

18 : مغایرت متن با قالب

19: تاریخ انقضای پنل 

 

نرم افزار تست وب سرویس :

در صورتی که تمایل به تست فعال بودن وب سرویس خود دارید می توانید از نرم افزار تحت ویندوز موجود در قسمت وب سرویس و نمونه کدها استفاده نمایید. در صورتی که این نرم افزار پیام شما را به درستی ارسال نماید به این معنی است که کدها و یا تنظیمات نرم افزار یا وبسایت شما به درستی انجام نشده است.

 

نرم افزار تست وب سرویس

 

نرم افزار های مدیریت مشتری و حسابداری:

در نرم افزا های مدیریت مشتری و حسابداری عموما از لینک برای ارسال پیامک استفاده می شود. کافی است از قسمت وب سرویس و نمونه کدها لینک url ، متد get  و post  را مشاهده نمایید و از آن استفاده نمایید. به عنوان مثال متد post   در نرم افزار حسابداری هلو مورد استفاده قرار می گیرد. که می بایست در قسمت تنظیمات مدیریتی ، تنظیمات سرویس دهنده قرار گیرد.

 

هلو وب سرویس نیازپرداز اس ام اس

 

تنظیمات مدیریتی هلو
 

 

** حتما فایل راهنمای وب سرویس را نیز ، دانلود و مطالعه نمایید