آدرس وب سرویس:
https://api.payamak-panel.com/post/Actions.asmx برای کد نویسی دات نت
https://api.payamak-panel.com/post/Actions.asmx?wsdl برای کدنویسی php و Java
متد GetBranchs ؛ این متد برای دریافت شناسه شاخه های بانک اطلاعات شماره ها و همچنین تعداد شماره های هر شاخه بکار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Owner | Int | شناسه مربوط به شاخه مرتبه بالاتر (برای شاخه اصلی عدد صفر را وارد نمائید) |
| مقدار بازگشتی | ||
| ReturnValue | Branchs[] | خروجی آرایه ای از کلاس Branchs می باشد. |
متد AddBranch ؛ این متد برای اضافه کردن نام شاخه (نام بانک اطلاعاتی) موردنظر شما به کار می رود..
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| BranchName | String | نام شاخه موردنظر که قرار است در پنل کاربران اضافه شود |
| Owner | Int | درصورتیکه تصمیم به درج زیرشاخه دارید، شناسه مربوط به شاخه مرتبه بالاتر وارد شود. برای شاخه اصلی صفر لحاظ شود. |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: این عدد شناسه مربوط به شاخه اضافه شده می باشد. ۰ : نام کاربری یا کلمه عبور وارد شده صحیح نمی باشد. ۱: شناسه شاخه وارد شده صحیح نمی باشد. |
متد AddNumber؛ برای اضافه کردن شماره های موردنظر در شاخه های دلخواه، استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| BranchId | Int | شناسه مربوط به شاخه مرتبه بالاتر (برای شاخه اصلی عدد صفر را وارد نمائید) |
| MobilNumbers | String | شماره موبایل (حداکثر ۱۰۰۰ شماره) |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۰ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. ۱: شماره های موردنظر با موفقیت در شاخه دلخواه اضافه شدند. ۳: شناسه شاخه وارد شده ۰ درج گردیده است. ۴: شناسه شاخه وارد شده صحیح نمی باشد. |
متد RemoveBranch؛ این متد برای حذف شاخه های اضافه شده مورد استفاده قرار می گیرد.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Bulkid | Int | آی دی مربوط به شاخه موردنظر که از متد addBranch بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۱ : شاخه موردنظر باموفقیت حذف گردید. ۲: : نام کاربری یا کلمه عبور یا شناسه شاخه مورد نظر صحیح نمی باشد. |
متد AddBulk؛ ا از این متد جهت ارسال به شاخه موردنظر استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| From | String | شماره فرستنده (به عنوان مثال ۱۰۰۰۱۲۳) |
| Branch | Int | کد شاخه دریافت شده از متد GetBranchs |
| BulkType | Byte | تصادفی: ۱ | ترتیبی: ۲ |
| Title | String | عنوان ارسال |
| Message | String | متن پیامک |
| RangeFrom | Int | از شماره ، مثلا ۹۱۲۲۸۰ |
| RangeTo | Int | تا شماره، مثلا ۹۱۲۲۸۹ |
| DateToSend | DateTime | تاریخ و زمان میلادی برای ارسال |
| RequestCout | Int | تعداد شماره های درخواستی که نباید بیشتر از شماره های موجود باشد. |
| RowFrom | Int | تعیین ردیف درخواستی (به صورت پیشفرض می توانید از ردیف ۰ درخواست نمائید.) |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: این عدد شناسه بسته ارسال (کد ارسال) می باشد. (این مقدار جهت مشاهده وضعیت ارسال می بایست ذخیره گردد.) ۰ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. |
متد AddBulk۲؛ از این متد جهت ارسال به شاخه موردنظر استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| From | String | شماره فرستنده (به عنوان مثال ۱۰۰۰۱۲۳) |
| Branch | Int | کد شاخه دریافت شده از متد GetBranchs |
| BulkType | Byte | تصادفی: ۱ | ترتیبی: ۲ |
| Title | String | عنوان ارسال |
| Message | String | متن پیامک |
| RangeFrom | Int | از شماره ، مثلا ۹۱۲۲۸۰ |
| RangeTo | Int | تا شماره، مثلا ۹۱۲۲۸۹ |
| DateToSend | DateTime | تاریخ و زمان میلادی برای ارسال با فرمت زیر وارد شود: (تفاوت این متد با متد AddBulk در نوع این پارامتر می باشد) ((دقیقه):(ساعت) (عدد روز میلادی) . (عدد ماه میلادی) . (عدد سال میلادی))، به عنوان مثال: ۲۰۱۳.۵.۱۵ ۱۱:۵۶ |
| RequestCout | Int | تعداد شماره های درخواستی که نباید بیشتر از شماره های موجود باشد. |
| RowFrom | Int | تعیین ردیف درخواستی (به صورت پیشفرض می توانید از ردیف ۰ درخواست نمائید.) |
| مقدار بازگشتی | ||
| ReturnValue | Int |
یک عدد: این عدد شناسه بسته ارسال (کد ارسال) می باشد. (این مقدار جهت مشاهده وضعیت ارسال می بایست ذخیره گردد.) ۰ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. |
متد GetBulkCount؛ این متد برای دریافت تعداد شماره های موجود در شاخه موردنظر استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| From | String | شماره فرستنده (به عنوان مثال ۱۰۰۰۱۲۳) |
| Branch | Int | کد شاخه دریافت شده از متد GetBranchs |
| BulkType | Byte | تصادفی: ۱ | ترتیبی: ۲ |
| Title | String | عنوان ارسال |
| Message | String | متن پیامک |
| RangeFrom | Int | از شماره ، مثلا ۹۱۲۲۸۰ |
| RangeTo | Int | تا شماره، مثلا ۹۱۲۲۸۹ |
| مقدار بازگشتی | ||
| ReturnValue | Int |
یک عدد: این عدد تعداد شماره های موجود در شاخه می باشد. ۰ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. |
متد GetBulkReceptions؛ این متد برای دریافت گزارش گیری کامل ارسال های addBulk استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| bulkId | Int | خروجی متد addBulk |
| rowFrom | Int | در صورتی که گیرندگان شما بیش از ۱۰۰ نیست fromRows را ۰ وارد کنید در غیر این صورت از این ورودی میتوانید جهت صفحه بندی و واکشی اطلاعات استفاده نمایید. |
| مقدار بازگشتی | ||
| ReturnValue | List<> | مشاهده گزارش کامل ارسال (شماره گیرنده، وضعیت ارسال و زمان ارسال، recId) ۰: ارسال شده به مخابرات ۱: رسیده به گوشی ۲: نرسیده به گوشی ۳: خطای مخابراتی ۵: خطای نامشخص ۸: رسیده به مخابرات ۱۶: نرسیده به مخابرات ۱۰۰: نامشخص |
متد GetBulkStatus؛ این متد جهت تعیین وضعیت ارسال بسته ارسال شده استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| BulkId | Int | کد یا شناسه ارسال که از متد AddBulk بدست آمده است. |
| پارامتر های خروجی | ||
| Send | Ref int | پارامتر خروجی به صورت ref مشخص کننده تعداد پیامک های ارسال شده است. |
| failed | Ref int | پارامتر خروجی به صورت ref مشخص کننده تعداد پیامک های ارسال نشده است. |
| status | Ref byte | پارامتر خروجی به صورت ref مشخص کننده وضعیت بسته است. ۰ : منتظر تائید ۱ : منتظر ارسال ۲ : در حال ارسال ۳ : ارسال شده ۴ : ارسال نشده ۵ : انصراف از ارسال ۶ : حذف شده ۷ : تائید نشده |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۰ : درخواست ناموفق بود. ۱ : درخواست با موفقیت انجام شد. |
متد GetTodaySent؛ این متد برای دریافت تعداد کل ارسال های روز به کار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: این عدد تعداد ارسال های روز را نمایش می دهد. ۱ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. |
متدGetTotalSent؛ این متد برای دریافت تعدادکل ارسال ها به کار می رود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| مقدار بازگشتی | ||
| ReturnValue | Int | یک عدد: این عدد تعداد کل ارسال ها را نمایش می دهد. ۱ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. |
متد RemoveBulk؛ این متد برای حذف ارسال منطقه ای استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Bulkid | Int | آی دی مربوط به ارسال منطقه ای موردنظر که از متد addBulk بدست آمده است. |
| مقدار بازگشتی | ||
| ReturnValue | Int |
۰ : نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است. -۱ : آی دی مربوط به ارسال منطقه ای به درستی وارد نشده است. ۱ : ارسال منطقه ای موردنظر با آی دی وارد شده باموفقیت حذف گردید. |
متد SendMultipleSMS؛ این متد برای چندین ارسال همزمان چند پیامک با متون مختلف، به چند شماره استفاده می شود. (ارسال متناظر)
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| To | String[] | آرایه ای از شماره های مورد نظر جهت ارسال (شماره های دریافت کننده پیامک) |
| From | String | شماره خط اختصاصی جهت ارسال، به عنوان مثال: ۱۰۰۰۱۲۳ |
| To | String[] | آرایه ای از شماره های مورد نظر جهت ارسال (شماره های دریافت کننده پیامک) |
| Text | String[] | آرایه ای از متون موردنظر جهت ارسال (این متون به ترتیب برای آرایه مربوط به شماره ها ی دریافت کننده، ارسال می شوند) |
| Isflash | Bool | نحوه ارسال به صورت فلش یا معمولی را تعیین می کند. (true = تائید ارسال فلش و false= ارسال معمولی) |
| Udh | String | برای ارسال روی پورت خاص استفاده می شود در غیراینصورت آنرا خالی رها کنید. |
| پارامتر های خروجی | ||
| RecId | Ref long[] | پارامتر خروجی به صورت ref ، این مقدار جهت دریافت وضعیت تحویل استفاده می شود. |
| status | Ref byte[] | پارامتر خروجی به صورت ref ، به ازای هر خانه آرایه، عدد ۰ نشانده ارسال موفق و عدد ۱ بیانگر ارسال ناموفق می باشد. |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۰ : نام کاربری یا رمز عبور صحیح نمی باشد. ۱ : ارسال با موفقیت انجام شد. ۲ : اعتبار کافی نمی باشد. ۳ : محدودیت در ارسال روزانه ۴ : محدودیت در حجم ارسال ۵ : شماره فرستنده معتبر نمی باشد. ۶ : سامانه درحال بروز رسانی می باشد. ۷ : متن پیامک حاوی کلمات فیلتر شده می باشد. ۸ : عدم رسیدن به حداقل ارسال ۹ : ارسال از خطوط عمومی از طریق وب سرویس امکانپذیر نمی باشد. ۱۰ : کاربر مسدود شده است. |
متد SendMultipleSMS۲؛ این متد برای ارسال همزمان چند پیامک با متون مختلف و شماره فرستنده های مختلف، به چند شماره استفاده می شود. (ارسال متناظر)
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| To | String[] | آرایه ای از شماره های مورد نظر جهت ارسال (شماره های دریافت کننده پیامک) |
| From | String | شماره خط اختصاصی جهت ارسال، به عنوان مثال: ۱۰۰۰۱۲۳ |
| To | String[] | آرایه ای از شماره های مورد نظر جهت ارسال (شماره های دریافت کننده پیامک) |
| Text | String[] | آرایه ای از متون موردنظر جهت ارسال (این متون به ترتیب برای آرایه مربوط به شماره ها ی دریافت کننده، ارسال می شوند) |
| Isflash | Bool | نحوه ارسال به صورت فلش یا معمولی را تعیین می کند. (true = تائید ارسال فلش و false= ارسال معمولی) |
| Udh | String | برای ارسال روی پورت خاص استفاده می شود در غیراینصورت آنرا خالی رها کنید. |
| پارامتر های خروجی | ||
| RecId | Ref long[] | پارامتر خروجی به صورت ref ، این مقدار جهت دریافت وضعیت تحویل استفاده می شود. |
| status | Ref byte[] | پارامتر خروجی به صورت ref ، به ازای هر خانه آرایه، عدد ۰ نشانده ارسال موفق و عدد ۱ بیانگر ارسال ناموفق می باشد. |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۰ : نام کاربری یا رمز عبور صحیح نمی باشد. ۱ : ارسال با موفقیت انجام شد. ۲ : اعتبار کافی نمی باشد. ۳ : محدودیت در ارسال روزانه ۴ : محدودیت در حجم ارسال ۵ : شماره فرستنده معتبر نمی باشد. ۶ : سامانه درحال بروز رسانی می باشد. ۷ : متن پیامک حاوی کلمات فیلتر شده می باشد. ۸ : عدم رسیدن به حداقل ارسال ۹ : ارسال از خطوط عمومی از طریق وب سرویس امکانپذیر نمی باشد. ۱۰ : کاربر مسدود شده است. |
متد UpdateBulkDelivery؛ این متد نمایش دهنده وضعیت گزارش گیری می باشد.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| Bulkid | Int | آی دی مربوط به ارسال منطقه ای موردنظر که از متد addBulk بدست آمده است. |
| پارامتر های خروجی | ||
| RecId | Ref long[] | پارامتر خروجی به صورت ref ، این مقدار جهت دریافت وضعیت تحویل استفاده می شود. |
| status | Ref byte[] | پارامتر خروجی به صورت ref ، به ازای هر خانه آرایه، عدد ۰ نشانده ارسال موفق و عدد ۱ بیانگر ارسال ناموفق می باشد. |
| مقدار بازگشتی | ||
| ReturnValue | Int | -۲: آی دی مربوط به ارسال منطقه ای به درستی وارد نشده است. -۱ نام کاربری یا کلمه عبور حساب کاربری به درستی وارد نشده است.: ۱ : گزارش ارسال منطقه ای با آی دی وارد شده باموفقیت به روز رسانی گردیده است. |