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

نحوه استفاده از وب‌سرویس و APIهای فراپیامک

 

وب‌سرویس و API های فراپیامک

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

تنوع در وب‌سرویس و APIهای ارائه شده توسط فراپیامک یکی دیگر از دلایل متمایز بودن این سامانه با سایر پنل‌های پیامکی می‌باشد.

وب‌سرویس‌های ارائه شده فراپیامک

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

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

برای تمامی وب‌سرویس و APIهای نمونه کد با زبان‌های مختلف در بخش مربوطه در پنل فراپیامک برای استفاده سریعتر قرار گرفته است، به عنوان مثال برای استفاده از وب‌سرویس ارسال، ارسال به صورت تکی انتخاب و برای شما توضیح داده می‌شود:

ارسال تکی پیامک از وب‌سرویسsend را می‌توان با فراخوانی http://api.payamak-panel.com/post/Send.asmx برای کد نویسی به زبان دات نت انجام داد، از متد SendSimpleSMS استفاده می نماییم:

پارامترهای ورودی
نام پارامتر نوع پارامتر توضیحات
UserName String نام کاربری حساب شما در سامانه
PassWord String کلمه عبور حساب کاربری شما در سامانه
From String شماره فرستنده
To String رایه ای از رشته حروف است که هر خانه آرایه شامل یک شماره موبایل می باشد، حداکثر 100 شماره در هر بار فراخوانی
Text String متن پیامک
IsFlash Boolean تعیین می کند ایا پیامک به صورت فلش ارسال گردد یا خیر
مقدار بازگشتی
ReturnValue String[] یک عدد:Rec ID ارسال
0:
1:درخواست با موفقیت انجام شد.
2:اعتبار کافی نمی باشد.
3:محدودیت در ارسال روزانه
4:محدودیت در حجم ارسال
5:شماره فرستنده معتبر نمی باشد.
6:سامانه در حال بروز رسانی می باشد.
7:متن حاوی کلمات فیلتر شده می باشد.نام کاربری یا رمز عبور اشتباه می باشد

عکسی که در بالا مشاهده می‌فرمایید از متد Send Simple Sms که یکی از ساده‌ترین متدها جهت ارسال پیامک تکی و گروهی می‌باشد را نمایش می‌دهد، پارامترهای ورودی به ترتیبی که نمایش داده شده است در نمونه کدها با زبان‌های مختلف آورده می‌شود و مقادیری که پاسخ بازگردانده می‌شود نیز به صورت کدهای عددی می‌باشند که هر کدام معنی خاصی را در بر دارد.بعد از ارسال پیامک شما می‌توانید با استفاده از متد دیگری با نام GetDeliveryمی‌توانید وضعیت پیامک‌هایی را که ارسال نموده‌اید دریافت و مشاهده نمایید که برای نمونه در عکس زیر نیز پارامترهای ورودی و مقدارهای بازگشتی تابع برای مثال آورده شده است:

پارامترهای ورودی
نام پارامتر نوع پارامتر توضیحات
RecId long کد یکتای گیرنده که از متدهای ارسال پیامک بدست امده است.
مقدار بازگشتی
ReturnValue Int 0:ارسال شده به مخابرات
1:رسیده به گوشی
2:نرسیده به گوشی
3:خطای مخابراتی
5:خطای نامشخص
8:رسیده به مخابرات
16:نرسیده به مخابرات
35:لیست سیاه
100:نامشخص
200:ارسال شده
300:فیلتر شده
400:در لیست ارسال
500:عدم پذیرش

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

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

ماژول‌های open source متصل به وب‌سرویس فراپیامک

علاوه بر موارد ذکرشده در بالا، فراپیامک این امکان را به کاربران می‌دهد که از ماژول‌های open source استفاده نمایند.

نرم‌افزارOpen source چیست؟

به آن دسته از نرم‌افزارهایی که هر شخص قادر به بازرسی (inspect)، تغییر، افزایش و اشتراک‌گذاری آن می‌باشدopen source گفته می‌شود، که درزمینه‌ی ساخت نرم‌افزار به‌منظور ایجاد برنامه‌های کامپیوتری مورداستفاده قرار می‌گیرند. این دسته از نرم‌افزارها توسط شرکت سازنده کدهای قابل استفاده قابل دسترسی قرار داده می‌شود تا کاربر بتواند به نسبت نیاز خود مواردی را که در نظر دارد در کدهای برنامه اعمال نموده و به هدفی که دارد دست یابد.

ماژول‌های Open source ارائه‌شده توسط فراپیامک عبارت‌اند از:

  • ماژول جوملا
  • ماژول پرستا شاپ
  • ماژول ورد پرس
  • ماژول WHMCS
  • ماژول اپن کارت
  • ماژول فریر شارژ
  • ماژول مجنتو
  • ماژول ووکامرس
  • ماژول توماتو کارت
  • ماژول فرم ساز عضویت
  • ماژول فرم لاگین
  • ماژول فرم ساز نمودار سنجی