آدرس وب سرویس:
https://api.payamak-panel.com/post/Actions.asmx برای کد نویسی دات نت
https://api.payamak-panel.com/post/Actions.asmx?wsdl برای کدنویسی php و Java
متد ChangeIsRead؛ جهت دانلود فکس های دریافتی استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی – پیشنهاد می گردد این مقدار را ۰ در نظر بگیرید |
| Count | Int | تعداد رکورد درخواستی |
| changeIsRead | bool | |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |
متد GetInboxCount؛ بررسی تعداد پیامک های دریافتی از طریق این متد انجام می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| IsRead | Bool | جهت مشاهده پیامک های خوانده شده true و جهت مشاهده پیامک های خوانده نشده false استفاده شود. |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: این عدد با توجه به پارامتر های ورودی، تعداد پیامک ها را نمایش می دهد. -۱ : نام کاربری یا کلمه عبور وارد شده صحیح نمی باشد. |
متد GetMessages؛ جهت بررسی پیامک های دریافتی استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی – پیشنهاد می گردد این مقدار را ۰ در نظر بگیرید |
| Count | Int | تعداد رکورد درخواستی |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |
متد GetMessageStr؛ جهت بررسی پیامک های دریافتی استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی – پیشنهاد می گردد این مقدار را ۰ در نظر بگیرید |
| Count | Int | تعداد رکورد درخواستی |
| مقدار بازگشتی | ||
| ReturnValue | string | پیام های دریافتی |
متدGetMessagesByDate؛ جهت بررسی پیامک های دریافتی بر اساس تاریخ استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی مثلا: از ردیف ۱ |
| Count | Int | تعداد رکورد درخواستی |
| DateFrom | Datetime | از تاریخ |
| DateTo | Datetime | تا تاریخ |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |
متد GetMessagesReceptions ؛ : مشاهده مشخصات پیام( شماره موبایل، تاریخ و recid)
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| msgIds | Int | Id مربوط پیام مورد نظر |
| fromRows | Int | شماره ردیف (برای مشاهده کلیه پیام های کد مورد نظر پیشنهاد می گردد ۰ در نظر گرفته شود) |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |
متد GetMessagesWithChangeIsRead ؛
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی – پیشنهاد می گردد این مقدار را ۰ در نظر بگیرید |
| Count | Int | تعداد رکورد درخواستی. |
| isRead | bool | جهت مشاهده پیامک های خوانده شده true و جهت مشاهده پیامک های خوانده نشده false استفاده شود. |
| changeIsRead | bool | در صورتی که می خواهید وضعیت پیام به خوانده شده تغییر پیدا نکند این گزینه را false قرار دهید. |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |
متد GetUsersMessagesByDate ؛ جهت بررسی پیامک های دریافتی کاربران بر اساس تاریخ استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | Int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی، اگر ۲ باشد پیامک های ارسالی را مشخص می کند و اگر -۱ تنظیم شود کلیه پیامک ها درخواست می شوند. |
| From | String | شماره فرستنده (مثلا: ۱۰۰۰۱۲۳) ، در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود. |
| Index | Int | اندیس مربوط به ردیف پیام های دریافتی مثلا: از ردیف ۱ |
| Count | Int | تعداد رکورد درخواستی. |
| DateFrom | Datetime | از تاریخ |
| DateTo | Datetime | تا تاریخ |
| مقدار بازگشتی | ||
| ReturnValue | List of class | MessagesBL [] |
متد RemoveMessages ؛ حذف پیام دریافتی
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Location | MessageLocation | مشخص کننده نوع پیام (دریافتی ، اسالی،...) |
| msgIds | String | Id مربوط پیام مورد نظر |
| مقدار بازگشتی | ||
| ReturnValue | int | ۱: پیام مورد نظر حذف گردید ۰: نام کاربری یا رمز عبور صحیح نمی باشد. |