وب سرویس خدماتی Payamak-panel
وب سرویس خدماتی ،یک امکان ویژه است که برای ارسال OTP یا رمز های یکبار مصرف ،پیامکهای اطلاع رسانی در فروشگاههای اینترنتی و مانند آن استفاده میشود.
در این نوع وب سرویس شما قادر خواهید بود تا با استفاده از خط اشتراکی خدماتی موجود در سامانه پیامک پارس پیامهایی که جنبه اطلاع رسانی دارد را به گوش مخاطبان خود بفرستید و دیگر خیالتان از بابت اینکه طرف مقابل آیا دریافت پیامکهای تبلیغاتی را مسدود کرده یا خیر راحت خواهد بود.
برای دریافت این خط اشتراکی خدماتی شما نیازی نیست که چک و یا سفته بپردازید یا شرکت ثبت شده داشته باشید،بلکه فقط به شرط داشتن اینماد قادر خواهید بود از این خط اشتراکی سامانه استفاده کنید.
برای استفاده از خط اشتراکی موجود در سامانه Payamak-panel باید یک الگو یا پترن ثبت نمایید.
متد sendbybasenumber:
آدرس وب سرویس:
برای کد نویسی دات نت: http://api.payamak-panel.com/post/Send.asmx
برای کدنویسی php و جاوا: http://api.payamak-panel.com/post/Send.asmx?wsdl
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی می توانید از این متد استفاده نمایید. قبل از استفاده از این متد باید متن پیشفرض خود را از داخل سامانه > منوی توسعه دهندگان > وبسرویس خدماتی(الگو) ارسال نمایید.پس از تایید مدیریت سامانه می توانید از این وبسرویس استفاده نمایید.
پارامتر های ورودی | ||
توضیحات | نوع پارامتر | نام پارامتر |
نام کاربری مربوط به حساب شما در سامانه | String | username |
کلمه عبور مربوط به حساب شما در سامانه | String | password |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب بصورت آرایه ای ارسال نمایید. | String[] | text |
تنها یک شماره موبایل میتوانید واردکنید. | String | to |
کد متن پیشفرض که توسط مدیر سامانه تایید شده است | Int | bodyId |
مقدار بازگشتی | ||
:6- خطای داخلی رخ داده است با پشتیبانی تماس بگیرید. :5-متن ارسالی با توجه به متغیر های مشخص شده در متن پیشفرض همخوانی ندارد. :4-کد متن ارسالی صحیح نمی باشد و یا توسط مدیر سامانه تایید نشده است. :3-خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید. :2-محدودیت تعداد شماره، محدودیت هر بار ارسال 1 شماره موبایل می باشد. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. .10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 15 رقم به معنای ارسال موفق بوده و برای دریافت گزارش می توانید از متد دریافت گزارش نظیر GetDeliveries استفاده نمایید. | String | ReturnValue |
متد2: sendbybasenumber
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی می توانید از این متد استفاده نمایید. قبل از استفاده از این متد باید متن پیشفرض خود را از داخل سامانه > منوی ابزار ویژه > خط خدماتی اشتراکی ارسال نمایید.پس از تایید مدیریت سامانه می توانیداز این وب سرویس استفاده نمایید.
پارامتر های ورودی | ||
توضیحات | نوع پارامتر | نام پارامتر |
نام کاربری مربوط به حساب شما در سامانه | String | username |
کلمه عبور مربوط به حساب شما در سامانه | String | password |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب توسط ; جدا نمایید و سپس ارسال نمایید. | String | text |
تنها یک شماره موبایل میتوانید واردکنید. | String | to |
کد متن پیشفرض که توسط مدیر سامانه تایید شده است | Int | bodyId |
مقدار بازگشتی | ||
:6- خطای داخلی رخ داده است با پشتیبانی تماس بگیرید. :5-متن ارسالی با توجه به متغیر های مشخص شده در متن پیشفرض همخوانی ندارد. :4- کد متن ارسالی صحیح نمی باشد و یا توسط مدیر سامانه تایید نشده است. :3-خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید. :2-محدودیت تعداد شماره، محدودیت هر بار ارسال 1 شماره موبایل می باشد. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. .10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 15 رقم به معنای ارسال موفق بوده و برای دریافت گزارش می توانید از متد دریافت گزارش نظیر GetDeliveries استفاده نمایید. | String | ReturnValue |
متد3 Sendbybasebumber:
هدف از ایجاد این متد سهولت استفاده برای کاربرانی است که توانایی تغییر وبسرویس از ارسال ساده به استفاده از وبسرویس اشتراکی را ندارد و تنها با یک تغییر
نام متد در کد نویسی از این وبسرویس استفاده نمایید.
برای استفاده از این وبسرویس باید به مثال زیر توجه نمایید: مثال : کد متن پیشفرض شما 4321 می باشد و قرار است متغیر سالم را ارسال کنید تا در متن اصلی پیشفرض شما که پیشتر در سامانه تعریف شده است جایگزین
شود
الگو به شرح زیر می باشد: @bodyId@متغیر;2متغیر1
بنابراین باید متن زیر را باتوجه به مثال به پارامتر text ارسال کنیم:
@4321@سالم
پارامتر های ورودی | ||
توضیحات | نوع پارامتر | نام پارامتر |
نام کاربری مربوط به حساب شما در سامانه | String | username |
کلمه عبور مربوط به حساب شما در سامانه | String | password |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب توسط ; جدا نمایید و سپس ارسال نمایید. | String | text |
تنها یک شماره موبایل میتوانید واردکنید. | String | to |
مقدار بازگشتی | ||
8- : متن ارسالی طبق راهنمای مستندات باید با @ شروع شود. 7- : خطای داخلی رخ داده است با پشتیبانی تماس بگیرید :6- متن ارسالی باتوجه به متغیرهای مشخص شده در متن پیشفرض همخوانی ندارد :5- کد متن ارسالی صحیح نمیباشد و یا توسط مدیر سامانه تأیید نشده است 4- و :9- خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید :3- محدودیت تعداد شماره، محدودیت هربار ارسال یک شماره موبایل میباشد :2- در متن طبق راهنمای مستندات این متد ، bodyID ارسال نشده است. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. | String | ReturnValue |
.10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 15 رقم به معنای ارسال موفق بوده و برای دریافت گزارش می توانید از متد دریافت گزارش نظیر GetDeliveries استفاده نمایید. |
متد4 sendbybasenumber
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی می توانید از این متد استفاده نمایید. قبل از استفاده از این متد باید متن پیشفرض خود را از داخل سامانه > منوی ابزار ویژه > خط خدماتی اشتراکی ارسال نمایید.پس از تایید مدیریت سامانه می توانید
از این وبسرویس استفاده نمایید.
تفاوت این متد با سایر متد ها برگشت هزینه ارسال پیامک برحسب ریال (بدون احتساب مالیات و قانون بودجه) می باشد.
پارامتر های ورودی | ||
توضیحات | نوع پارامتر | نام پارامتر |
نام کاربری مربوط به حساب شما در سامانه | String | username |
کلمه عبور مربوط به حساب شما در سامانه | String | password |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب توسط ; جدا نمایید و سپس ارسال نمایید. | String | text |
تنها یک شماره موبایل میتوانید واردکنید. | String | to |
کد متن پیشفرض که توسط مدیر سامانه تایید شده است | Int | bodyId |
هزینه ارسال پیامک برحسب ریال (بدون احتساب مالیات و قانون بودجه) | Ref double | smsPrice |
مقدار بازگشتی | ||
:6- خطای داخلی رخ داده است با پشتیبانی تماس بگیرید. :5-متن ارسالی با توجه به متغیر های مشخص شده در متن پیشفرض همخوانی ندارد. :4- کد متن ارسالی صحیح نمی باشد و یا توسط مدیر سامانه تایید نشده است. :3-خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید. :2-محدودیت تعداد شماره، محدودیت هر بار ارسال 1 شماره موبایل می باشد. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. .10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 15 رقم به معنای ارسال موفق بوده و برای دریافت گزارش می توانید از متد دریافت گزارش نظیر GetDeliveries استفاده نمایید. | String | ReturnValue |
متد ؛AddScheduleSendByBaseNumber2
آدرس وب سرویس: http://api.payamak-panel.com/post/Schedule.asmx برای کد نویسی دات نت
Java و php کدنویسی برای http://api.payamak-panel.com/post/Schedule.asmx?wsdl
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی بصورت زماندار، می توانید از این متد استفاده نمایید. قبل از استفاده از این متد باید متن پیشفرض خود را از داخل سامانه > منوی توسعه دهندگان > وبسرویس خدماتی(الگو) ارسال نمایید.پس از تایید مدیریت سامانه می توانید از این وبسرویس استفاده نمایید.
پارامتر های ورودی | ||
توضیحات | نوع پارامتر | نام پارامتر |
نام کاربری مربوط به حساب شما در سامانه | String | username |
کلمه عبور مربوط به حساب شما در سامانه | String | password |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب توسط ; جدا نمایید و سپس ارسال نمایید. | String | text |
تنها یک شماره موبایل میتوانید واردکنید. | String | to |
کد متن پیشفرض که توسط مدیر سامانه تایید شده است | Int | bodyId |
زمان ارسال، بازه زمانی مجاز 7 الی 22 – فرمت : 2024-08-04 15:20:00 | String | scheduleDate |
مقدار بازگشتی | ||
9– : زمان ارسال سپری شده است :8- زمان ارسال مناسب نمی باشد، بازه زمانی مناسب 7 صبح الی 22 می باشد. :7- شماره فرستنده ای یافت نشد، مجددا تالش کنید. :6- خطای داخلی رخ داده است با پشتیبانی تماس بگیرید. :5-متن ارسالی با توجه به متغیر های مشخص شده در متن پیشفرض همخوانی ندارد. :4- کد متن ارسالی صحیح نمی باشد و یا توسط مدیر سامانه تایید نشده است. :3-خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید. :2-محدودیت تعداد شماره، محدودیت هر بار ارسال 1 شماره موبایل می باشد. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. .10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 4 رقم به معنای ارسال موفق بوده و برای دریافت گزارش از وضعیت ارسال آن را ذخیره نمایید. | String | ReturnValue |
Rest Web Service
راهنمای وب سرویس خدماتی Rest
https://rest.payamak-panel.com/api/SendSMS/BaseServiceNumber
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی می توانید از این متد استفاده نمایید. قبل از استفاده از این متد باید متن پیشفرض خود را از داخل سامانه > منوی توسعه دهندگان > وبسرویس خدماتی(الگو) ارسال نمایید.پس از تایید مدیریت سامانه می توانید از این وبسرویس استفاده نمایید
پارامتر های ورودی | |||
توضیحات | نوع پارامتر | نام پارامتر | |
نام کاربری مربوط به حساب شما در سامانه | String | username | |
کلمه عبور مربوط به حساب شما در سامانه | String | password | |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب توسط ; جدا نمایید و سپس ارسال نمایید. | String | text | |
تنها یک شماره موبایل میتوانید واردکنید. | String | to | |
کد متن پیشفرض که توسط مدیر سامانه تایید شده است | Int | bodyId | |
مقدار بازگشتی | |||
نمونه بازگشتی | توضیحات | نوع پارامتر | نام پارامتر |
:6- خطای داخلی رخ داده است با پشتیبانی تماس بگیرید. :5-متن ارسالی با توجه به متغیر های مشخص شده در متن پیشفرض همخوانی ندارد. :4- کد متن ارسالی صحیح نمی باشد و یا توسط مدیر سامانه تایید نشده است. :3-خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید. :2-محدودیت تعداد شماره، محدودیت هر بار ارسال 1 شماره موبایل می باشد. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. .10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 15 رقم در پارامترValue به معنای ارسال موفق بوده و برای دریافت گزارش از وضعیت ارسال آن را ذخیره نمایید. | String | Value | |
{ | |||
“Value”: “recID”, | |||
“RetStatus”: 1, | |||
“StrRetStatus”: “Ok” | |||
} | |||
درصورتیکه ارسال موفق باشید مقدار 1 دریافت می کنید در غیراینصورت مقدار 35 دریافت می کنید. | Int | RetStatus | |
اگر ارسال موفق باشد مقدار OK دریافت می کنید در | |||
صورت وجود خطا مقدار InvalidData دریافت خواهید کرد و کد خطا در پارامتر Value قابل دریافت | String | StrRetStatus | |
است. | |||
ارسال از وب سرویس خدماتی بصورت زماندار
https://rest.payamak-panel.com/api/SendSMS/BaseServiceNumberSchedule
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی بصورت زماندار، می توانید از این متد استفاده نمایید. قبل از استفاده از این متد باید متن پیشفرض خود را از داخل سامانه > منوی توسعه دهندگان > وبسرویس خدماتی(الگو) ارسال نمایید.پس از تایید مدیریت سامانه می توانید از این وبسرویس استفاده نمایید.
پارامتر های ورودی | |||
توضیحات | نوع پارامتر | نام پارامتر | |
نام کاربری مربوط به حساب شما در سامانه | String | username | |
کلمه عبور مربوط به حساب شما در سامانه | String | password | |
متغیر هایی که در متن پیشفرض تنظیم کرده اید را باید به ترتیب توسط ; جدا نمایید و سپس ارسال نمایید. | String | text | |
تنها یک شماره موبایل میتوانید واردکنید. | String | to | |
کد متن پیشفرض که توسط مدیر سامانه تایید شده است | Int | bodyId | |
2024-08-04 15:20:00 | زمان ارسال، بازه زمانی مجاز 7 الی 22 – فرمت : | String | scheduleDate |
مقدار بازگشتی | |||
نمونه بازگشتی | توضیحات | نوع پارامتر | نام پارامتر |
{ | 9– : زمان ارسال سپری شده است :8- زمان ارسال مناسب نمی باشد، بازه زمانی مناسب 7 صبح الی 22 می باشد. :7- شماره فرستنده ای یافت نشد، مجددا تالش کنید. :6- خطای داخلی رخ داده است با پشتیبانی تماس بگیرید. :5-متن ارسالی با توجه به متغیر های مشخص شده در متن پیشفرض همخوانی ندارد. :4- کد متن ارسالی صحیح نمی باشد و یا توسط مدیر سامانه تایید نشده است. :3-خط ارسالی در سیستم تعریف نشده است، با پشتیبانی سامانه تماس بگیرید. :2-محدودیت تعداد شماره، محدودیت هر بار ارسال 1 شماره موبایل می باشد. :1- دسترسی برای استفاده از این وبسرویس غیرفعال است، با پشتیبانی تماس بگیرید. :0 نام کاربری یا رمز عبور صحیح نمی باشد. :2 اعتبار کافی نمی باشد. .6سامانه در حال بروزرسانی می باشد. .7متن حاوی کلمه فیلتر شده می باشد، با واحد اداری تماس بگیرید. .10کاربر مورد نظر فعال نمی باشد. .11 ارسال نشده .12 مدارک کاربر کامل نمی باشد. در صورت دریافت یک عدد بیش از 4 رقم در پارامترValue به معنای ارسال موفق بوده و برای دریافت گزارش از وضعیت ارسال آن را ذخیره نمایید. | ||
“Value”: “scheduleId”, “RetStatus”: 1, | String | Value | |
“StrRetStatus”: “Ok” | |||
} | |||
درصورتیکه ارسال موفق باشید مقدار 1 دریافت می کنید در غیراینصورت مقدار 35 دریافت می کنید. | Int | RetStatus | |