آدرس وب سرویس:
https://api.payamak-panel.com/post/Actions.asmx برای کد نویسی دات نت
https://api.payamak-panel.com/post/Actions.asmx?wsdl برای کدنویسی php و Java
متد GetCredit ؛ این متد برای دریافت میزان اعتبار کاربر بکار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| مقدار بازگشتی | ||
| ReturnValue | Double | میزان اعتبار به پیامک یا به ریال بسته به نوع پنل کاربری ۰: نام کاربری و یا رمز عبور اشتباه می باشد. |
متد GetDeliveries ؛ جهت دریافت وضعیت تحویل پیامک های ارسال شده بصورت رندم بکار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| recIds | Long[] | کدهای یکتای گیرنده که از متدهای ارسال پیامک بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | Int[] |
۰: ارسال شده به مخابرات ۱: رسیده به گوشی ۲: نرسیده به گوشی ۳: خطای مخابراتی ۵: خطای نامشخص ۸: رسیده به مخابرات ۱۶: نرسیده به مخابرات ۳۵: لیست سیاه ۱۰۰: نامشخص ۲۰۰: ارسال شده ۳۰۰: فیلتر شده ۴۰۰: در لیست ارسال ۵۰۰: عدم پذیرش |
متد GetDelivery ؛ جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| recIds | Long | کد یکتای گیرنده که از متدهای ارسال پیامک بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | Int[] | ۰: ارسال شده به مخابرات ۱: رسیده به گوشی ۲: نرسیده به گوشی ۳: خطای مخابراتی ۵: خطای نامشخص ۸: رسیده به مخابرات ۱۶: نرسیده به مخابرات ۳۵: لیست سیاه ۱۰۰: نامشخص ۲۰۰: ارسال شده ۳۰۰: فیلتر شده ۴۰۰: در لیست ارسال ۵۰۰: عدم پذیرش |
متد GetDelivery2 ؛ جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| RecId | String | کد یکتای گیرنده که از متد های ارسال پیامک بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | Int[] | ۰: ارسال شده به مخابرات ۱: رسیده به گوشی ۲: نرسیده به گوشی ۳: خطای مخابراتی ۵: خطای نامشخص ۸: رسیده به مخابرات ۱۶: نرسیده به مخابرات ۱۰۰: نامشخص |
متد GetInboxCount ؛ بررسی تعداد پیامک های دریافتی از طریق این متد انجام می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| Password | String | کلمه عبور مربوط به حساب شما در سامانه |
| IsRead | Bool | کجهت مشاهده پیامک های خوانده شده true و جهت مشاهده پیامک های خوانده نشده false استفاده شود. |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: این عدد با توجه به پارامتر های ورودی، تعداد پیامک ها را نمایش می دهد. -۱ : نام کاربری یا کلمه عبور وارد شده صحیح نمی باشد. |
متد GetMultiDelivery ؛ جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود(جهت ارسال های انبوه استفاده می شود)
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| RecId | String | یکی از کدهای یکتای گیرنده که از متد Sendsms بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | byte[] |
۰: ارسال شده به مخابرات ۱: رسیده به گوشی ۲: نرسیده به گوشی ۳: خطای مخابراتی ۵: خطای نامشخص ۸: رسیده به مخابرات ۱۶: نرسیده به مخابرات ۱۰۰: نامشخص |
متد GetMultiDelivery2 ؛ جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود(جهت ارسال های انبوه استفاده می شود)
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| RecId | String | کد یکتای گیرنده که از متد Sendsms بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | string[] | ۰: ارسال شده به مخابرات ۱: رسیده به گوشی ۲: نرسیده به گوشی ۳: خطای مخابراتی ۵: خطای نامشخص ۸: رسیده به مخابرات ۱۶: نرسیده به مخابرات ۱۰۰: نامشخص |
متد GetSmsPrice ؛ جهت دریافت قیمت پیامک قبل از ارسال بکار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| Username | String | نام کاربری شما در سامانه |
| Password | String | کلمه عبور شما در سامانه |
| IrancellCount | Int | تعداد شماره های ایرانسل |
| MtnCount | Int | تعداد شماره های همراه اول |
| From | String | شماره فرستنده |
| Text | String | متن ارسال |
| مقدار بازگشتی | ||
| ReturnValue | double | |
متد SendSimpleSMS ؛ از این متد جهت ارسال پیامک به یک یا چند گیرنده مورد استفاده قرار می گیرد. محدودیت ۱۰۰ عددی در هر بسته ارسال
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| Username | String | نام کاربری شما در سامانه |
| Password | String | کلمه عبور شما در سامانه |
| From | String | شماره فرستنده |
| To | String[] | آرایه ای از رشته حروف است که هر خانه آرایه شامل یک شماره موبایل می باشد، حداکثر ۱۰۰ شماره در هر بار فراخوانی |
| Text | String | متن پیامک |
| IsFlash | boolean | تعیین می کند آیا پیامک بصورت فلش ارسال گردد یا خیر |
| مقدار بازگشتی | ||
| ReturnValue | String[] | یک عدد: recId ارسال ۰ : نام کاربری یا رمز عبور اشتباه می باشد. ۱ : درخواست با موفقیت انجام شد. ۲: اعتبار کافی نمی باشد. ۳٫ محدودیت در ارسال روزانه ۴٫ محدودیت در حجم ارسال ۵٫شماره فرستنده معتبر نمی باشد. ۶٫سامانه در حال بروزرسانی می باشد. ۷٫متن حاوی کلمه فیلتر شده می باشد. ۹٫ ارسال از خطوط عمومی از طریق وب سرویس امکان پذیر نمی باشد. ۱۰٫کاربر مورد نظر فعال نمی باشد. ۱۱٫ ارسال نشده ۱۲٫ مدارک کاربر کامل نمی باشد. |
متد SendSimpleSMS2 ؛ :از این متد جهت ارسال پیامک به یک گیرنده مورد استفاده قرار می گیرد.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| Username | String | نام کاربری شما در سامانه |
| Password | String | کلمه عبور شما در سامانه |
| From | String | شماره فرستنده |
| To | String | شماره گیرنده |
| Text | String | متن پیامک |
| IsFlash | boolean | تعیین می کند آیا پیامک بصورت فلش ارسال گردد یا خیر |
| مقدار بازگشتی | ||
| ReturnValue | String | یک عدد: recId ارسال ۰ : نام کاربری یا رمز عبور اشتباه می باشد. ۱ : درخواست با موفقیت انجام شد. ۲: اعتبار کافی نمی باشد. ۳٫ محدودیت در ارسال روزانه ۴٫ محدودیت در حجم ارسال ۵٫شماره فرستنده معتبر نمی باشد. ۶٫سامانه در حال بروزرسانی می باشد. ۷٫متن حاوی کلمه فیلتر شده می باشد. ۹٫ ارسال از خطوط عمومی از طریق وب سرویس امکان پذیر نمی باشد. ۱۰٫کاربر مورد نظر فعال نمی باشد. ۱۱٫ ارسال نشده ۱۲٫ مدارک کاربر کامل نمی باشد. |
متد SendSms ؛ :این متد جهت ارسال پیامک پیشرفته به یک یا چند گیرنده استفاده می شود. محدودیت ۱۰۰ عددی در هر بسته ارسال
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| Username | String | نام کاربری شما در سامانه |
| Password | String | کلمه عبور شما در سامانه |
| From | String | شماره فرستنده |
| To | String[] | شماره گیرنده |
| Text | String | متن ارسالی |
| IsFlash | boolean | متن بصورت flash ارسال گردد |
| UDH | String | سرآمد پیامک (برای ارسال پیامک روی یک پورت خاص) |
| RecId | Ref Long[] | هرخانه آرایه یک کد یکتا به ازای هر گیرنده تولید می کند ، این کد یکتا برای دریافت delivery کاربر دارد |
| Status | Ref Byte[] | هر خانه آرایه یک ۰ یا ۱ بوده که به ازای هر گیرنده تولید می شود و نشانگر این است که پیامک به این گیرنده موفق ارسال گردیده یا نه (۰ به معنی ارسال شده و ۱ به معنی ارسال نشده می باشد. |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: recId ارسال ۰ : نام کاربری یا رمز عبور اشتباه می باشد ۱ : درخواست با موفقیت انجام شد. ۲: اعتبار کافی نمی باشد. ۳٫ محدودیت در ارسال روزانه ۴٫ محدودیت در حجم ارسال ۵٫شماره فرستنده معتبر نمی باشد. ۶٫سامانه در حال بروزرسانی می باشد. ۷٫متن حاوی کلمه فیلتر شده می باشد. ۹٫ ارسال از خطوط عمومی از طریق وب سرویس امکان پذیر نمی باشد. ۱۰٫کاربر مورد نظر فعال نمی باشد. ۱۱٫ ارسال نشده ۱۲٫ مدارک کاربر کامل نمی باشد. |
متد SendWithDomain ؛ جهت ارسال پیامک با دامنه استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| Username | String | نام کاربری شما در سامانه |
| Password | String | کلمه عبور شما در سامانه |
| From | String | شماره فرستنده |
| To | String[] | شماره گیرنده |
| Text | String | متن پیام |
| IsFlash | bool | مشخص میکند پیام بصورت flash ارسال گردد. |
| domainName | String | دامنه |
| مقدار بازگشتی | ||
| ReturnValue | String | یک عدد: recId ارسال ۰ : نام کاربری یا رمز عبور اشتباه می باشد ۱ : درخواست با موفقیت انجام شد. ۲: اعتبار کافی نمی باشد. ۳٫ محدودیت در ارسال روزانه ۴٫ محدودیت در حجم ارسال ۵٫شماره فرستنده معتبر نمی باشد. ۶٫سامانه در حال بروزرسانی می باشد. ۷٫متن حاوی کلمه فیلتر شده می باشد. ۹٫ ارسال از خطوط عمومی از طریق وب سرویس امکان پذیر نمی باشد. ۱۰٫کاربر مورد نظر فعال نمی باشد. ۱۱٫ ارسال نشده ۱۲٫ مدارک کاربر کامل نمی باشد. |
متد GetMessages ؛ جهت بررسی پیامک های دریافتی استفاده می شود
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| Username | String | نام کاربری شما در سامانه |
| Password | String | کلمه عبور شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی – پیشنهاد می گردد این مقدار را ۰ در نظر بگیرید |
| Count | Int | تعداد رکورد درخواستی |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |