وب سرویس پیامکی نیازپرداز

سریع، مقیاس‌پذیر و توسعه‌پذیر

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

مستندات کامل و شفاف (RESTful API)

کتابخانه‌های آماده برای همه زبان‌ها

پنل گزارش‌گیری دقیق و لحظه‌ای

پایداری ۹۹.۹٪ سرویس (SLA)

مستندات فنی

C#PHPJavaJSPythonGoRubyRust

https://github.com/NiazpardazSms/niazpardaz-sms-dotnet

چرا توسعه‌دهندگان نیازپرداز را انتخاب می‌کنند؟

برای توسعه‌دهندگان طراحی شده؛ برای محصول شما بهینه‌سازی شده.

پایداری و امنیت بالا

تضمین عملکرد ۹۹.۹٪ (SLA)
زیرساخت ابری و مقیاس‌پذیر
حفاظت کامل داده‌ها در حین انتقال

سرعت و بهره‌وری بی‌نظیر

زمان تحویل کمتر از چند ثانیه (OTP)
مسیرهای مستقیم و با اولویت بالا
API بهینه‌سازی‌شده برای ترافیک بالا

سادگی و تمرکز توسعه‌دهنده

مستندات RESTful API کامل و خوانا
SDK و کدهای آماده برای انواع زبان‌ها
عدم پیچیدگی در پنل کاربری

پشتیبانی تخصصی و دائمی

پاسخگویی مستقیم مهندسین فنی
مشاوره رایگان و اختصاصی برای راه‌اندازی
پشتیبانی vip برای پروژه های بزرگ

نمونه کدهای اتصال به وب‌سرویس

ساختار درخواست‌ها، نمونه کدهای آماده و پکیج‌های مورد نیاز برای اتصال آسان به سامانه پیامک

چرا از این نمونه کدها استفاده کنید؟

سایت‌ها، نرم‌افزارها و اپلیکیشن‌ها به راحتی می‌توانند از طریق نمونه‌کدها و پکیج‌های وب‌سرویس به سامانه پیامک نیازپردار متصل شوند و از امکانات آن بهره‌مند گردند.

راه‌اندازی بی‌دردسر برای تمامی پلتفرم‌ها

چه سایت، چه نرم‌افزار یا اپلیکیشن موبایل، تنها با استفاده از نمونه‌کدها و پکیج‌های وب‌سرویس، و تنظیمات ساده (مانند کد API و شماره پیامک)، به راحتی می‌توانید ارتباط با سامانه پیامک را برقرار کنید.

انعطاف بالا برای توسعه‌دهندگان

کدها و پکیج‌های ارائه‌شده برای زبان‌ها و پلتفرم‌های مختلف سازگار هستند و به راحتی می‌توانند در سایت‌ها، نرم‌افزارها و اپلیکیشن‌ها استفاده شوند، بدون نیاز به تغییرات پیچیده در ساختار پروژه.

پشتیبانی حرفه‌ای در هر مرحله

تیم فنی نیازپردار آماده است تا در هر مرحله از ادغام وب‌سرویس با سایت، نرم‌افزار یا اپلیکیشن شما، راهنمایی و پشتیبانی لازم را ارائه دهد.

مشاهده کامل مستندات وب‌سرویس

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

نمونه کد #C برای نرم‌افزارهای تحت ویندوز یا وب و پیامک درون برنامه‌ای.

مشاهده دانلود

وب‌سرویس پیامکی زبان Php

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

مشاهده دانلود

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

نمونه کد Python برای برنامه نویسان پایتون جهت ارسال پیامک درون برنامه‌ای.

مشاهده دانلود

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

نمونه کد JS برای برنامه نویسان جاوا اسکریپت جهت ارسال پیامک درون برنامه‌ای.

مشاهده دانلود

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

نمونه کد Rust برای برنامه نویسان راست جهت ارسال پیامک درون برنامه‌ای.

مشاهده دانلود

مزایای وب‌سرویس پیامکی نیازپرداز

ارسال کدهای OTP

پیامک‌های فوری مانند کدهای تایید احراز هویت یا وضعیت سفارشات، با خطوط اولویت‌دار ارسال می‌شوند تا در کمترین زمان ممکن به دست گیرنده برسد. این سرویس ویژه, امکان ارسال سریع و مطمئن OTP را می‌دهد.

ارسال به لیست سیاه

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

ارسال در تمام ساعات شبانه روز

شما می‌توانید در هر ساعتی از شبانه‌روز پیامک‌های خود را ارسال کنید و مطمئن باشید که پیام‌ها به موقع و بدون تأخیر به دست مخاطبان می‌رسد.

ارسال با کمترین هزینه

شما می‌توانید ارسال‌های پیامکی وب‌سرویس خود را با کمترین هزینه انجام دهید.این سرویس به شما این امکان را می‌دهد که پیامک‌های ضروری را به صورت اقتصادی و مقرون به صرفه ارسال کنید.

اپراتور پشتیبان

در صورت اختلال یا مشکل در یکی از اپراتورها، سرویس پیامک شما قطع نخواهد شد. سیستم به صورت خودکار به اپراتور دیگری سوئیچ می‌کند تا ارسال پیامک‌ها ادامه پیدا کند.این سرویس پشتیبان به شما اطمینان می‌دهد که پیامک‌های شما بدون تأخیر و مشکل ارسال شوند.

لایه امنیتی SSL

برای تضمین امنیت ارتباطات شما، تمامی متدهای وب‌سرویس با رعایت استانداردهای امنیتی مانند HTTP Basic Auth و لایه امن SSL فراخوانی می‌شوند. این اقدامات باعث می‌شوند که داده‌ها در هنگام انتقال به صورت رمزنگاری شده و ایمن منتقل شوند و از نفوذ و دسترسی غیرمجاز جلوگیری شود.

عدم ارسال پیامک های تکراری

سیستم ما به‌طور خودکار از ارسال پیامک‌های تکراری جلوگیری می‌کند. با استفاده از شناسه داخلی (LocalId) که از پایگاه داده شما دریافت می‌شود، هر زمان که درخواست ارسال پیامک تکراری باشد، سیستم آن را شناسایی کرده و پیامک جدیدی ارسال نمی‌شود. تنها در صورتی که خود کاربر صراحتاً درخواست ارسال مجدد کند، پیامک دوباره ارسال خواهد شد.

پیامک های نرسیده به گوشی

اگر وضعیت پیامک شما به Undelivered یا Fail تغییر کند، به این معنی است که پیامک به گیرنده نرسیده است. در این صورت، سرویس ما به‌طور خودکار تلاش می‌کند پیامک را از طریق اپراتور دیگری ارسال کند تا به گیرنده برسد.

آزمایشگاه افزونه و پلاگین‌ها

افزونه‌های وردپرسی به راحتی و با چند تنظیم ساده به سامانه پیامک نیازپردار متصل می‌شوند. کافیست افزونه مورد نظر را دانلود و نصب کنید تا ارتباط برقرار شود

ZIP

ماژول Wordpress

چنانچه تمایل دارید در وب‌سایت وردپرسی خود از سیستم پیامک درون برنامه و پیامک هوشمند استفاده کنید می‌توانید از ماژول ارسال و دریافت پیامک وردپرسی نیازپرداز استفاده کنید.

دانلود پلاگین

ZIP

ماژول WooCommerce

چنانچه تمایل دارید در فروشگاه اینترنتی خود از سیستم پیامک درون برنامه و پیامک هوشمند استفاده کنید می‌توانید از ماژول ارسال و دریافت پیامک ووکامرس نیازپرداز استفاده کنید.

دانلود پلاگین

ZIP

ماژول WHMCS

تقریبا همه سایتهای ارائه خدمات میزبانی با این سیستم کار میکنند و ارائه سرویس میزبانی و ارسال تیکت و تمدید را انجام میدهد.

دانلود پلاگین

ZIP

افزونه Digits WordPress

ورود و ساخت حساب کاربری با شماره موبایل و رمز عبور یک بار مصرف (OTP) در وردپرس علاوه بر ساده کردن فرایند خرید و ارائه تجربه کاربری بهتر، امنیت وب‌سایت را بهبود می‌دهد.

دانلود پلاگین

ZIP

افزونه Mihanpanel WordPress

افزونه ساخت پنل کاربری، ورود و عضویت، صفحه ورود و عضویت سیستم مدیریت محتوای (CMS) وردپرس. (دو پلاگین در فایل Zip قراردارد که می بایست ابتدا فایل دانلود شده را extract و آن دو را نصب نمایید)

دانلود پلاگین

ZIP

افزونه EDD WordPress

افزونه ای که با آن وب‌سایت فروشگاهی خود را راه اندازی و مدیریت کنید و انواع محصولات دیجیتالی مانند فایل های صوتی و ویدیویی، کتاب های الکترونیک، موسیقی، pdf و همچنین قالب ها و پلاگین های مختلف را به فروش برسانید

دانلود پلاگین

ZIP

افزونه Gravity Forms Wordpress

افزونه فرم ساز گرویتی حرفه ای ترین افزونه ساخت فرم های حرفه ای در وردپرس. ( سه پلاگین در فایل Zip قراردارد که می بایست ابتدا فایل دانلود شده را extract و هر سه را نصب نمایید)

دانلود پلاگین

راهنمای سریع متدهای ارسال

ساختار درخواست‌ها برای اتصال به وب‌سرویس

ارسال با متد GET

برای ارسال از طریق متد GET از فرمت زیر استفاده نمایید متد GET داده‌ها را از طریق URL ارسال می‌کند و برای دریافت سریع و مستقیم اطلاعات از سرور بسیار مناسب است.

فرمت کلی:

https://panel.niazpardaz-sms.com/SMSInOutBox/SendSms?username=نام کاربری&password=کلمه عبور&from=شماره فرستنده&to=شماره گیرنده&text=متن پیامک

مثال عملی:

https://panel.niazpardaz-sms.com/SMSInOutBox/SendSms?username=admin&password=123&from=1000...&to=0936...&text=سلام دوستان

ارسال با متد POST

برای ارسال پیامک از طریق متد POST از فرمت زیر استفاده نمایید (این روش برای استفاده در نرم افزار های مانند نرم افزار هلو مناسب است) . مقادیر باید در قالب تگ فرم یا JSON به آدرس زیر ارسال شوند.

فرمت کلی:

https://panel.niazpardaz-sms.com/SMSInOutBox/Send

پارامترهای بدنه (Body):

UserNamePasswordFromToMessage

مثال عملی:

$body = @{
    UserName = "UserName"
    Password = "Password"
    From = "1000****"
    To = "09123456789"
    Message = "تست"
  } | ConvertTo-Json

  Invoke-RestMethod -Uri 'https://panel.niazpardaz-sms.com/SMSInOutBox/Send' -Method Post -ContentType 'application/json' -Body $body

مستندات وب‌سرویس پیامکی

صفحه‌ی وب‌سرویس ما، شامل جزئیات متدها، پارامترهای ورودی و خروجی، و کدهای خطا است.

ارسال ساده

SendBatchSms

این متد جهت ارسال پیامک به یک تا حداکثر 100 شماره بکار می رود

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/SendBatchSms

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
fromNumber	string	شماره فرستنده
toNumbers	string	شماره گیرندگان پیام که با , جدا می شوند حداکثر 100 شماره در هر بار فراخوانی
messageContent	string	متن پیامک
isFlash	bool	تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
sendDelay	int	تاخیر ارسال پیامک را به مدت مشخصی به تعویق بیندازد، این زمان بر حسب ثانیه می باشد. (بصورت پیش فرض 0 در نظر گرفته می شود که به معنی ارسال فوری است)

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
20-	بعلت وارد کردن رمز اشتباه پنل مسدود شده است
0	ارسال با موفقیت انجام شد
1	نام کاربر یا کلمه عبور نامعتبر می باشد
2	کاربر مسدود شده است
3	شماره فرستنده نامعتبر است
4	محدودیت در ارسال روزانه
5	تعداد گیرندگان حداکثر 100 شماره می باشد
6	خط فرستنده غیرفعال است
7	متن پیامک شامل کلمات فیلتر شده است
8	اعتبار کافی نیست
9	سامانه در حال بروز رسانی می باشد
10	وب‌سرویس غیرفعال است
11	پیاده سازی نشده است
12	تعداد پیامها و شماره ها باید یکسان باشد
13	تعداد پیامها حداکثر 100 پیام می باشد
14	هیچ مقداری برای تعرفه جاری کاربر تعریف نشده است
15	ارسال تکراری متن مشابه به شماره مشابه در مدت زمان مشخص
16	شماره موبایل گیرنده یافت نشد، ارسال از خط تبلیغاتی به شماره های لیست سیاه
17	متن وارد نشده است
18	مغایرت متن با قالب
19	تاریخ انقضای پنل به پایان رسیده است
20	وضعیت کاربر فعال نیست
21	مقدار یکی یا بیشتر از پارامترهای وروردی معتبر نیست
22	آی پی موقت بلاک شده است
23	عملیات با خطا مواجه شد. لطفاً دقایقی دیگر مجدداً تلاش نمایید
24	درخواست کاملا تکراری در بازه کوتاه (چند ثانیه)
25	ApiKey نامعتبر
26	خطا در ساخت فایل صوتی

BatchSmsId

int

شناسه پیامک

ارسال کد یکبار مصرف صوتی

SendVoiceOtp

این متد جهت ارسال کد یکبار مصرف بصورت صوتی می باشد.

آدرس صفحه URL

URL

http:in.payamak-service.ir/api/v2/RestWebApi/SendVoiceOtp

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
fromNumber	string	شماره فرستنده
toNumbers	string	شماره گیرنده پیام
messageContent	string	شناسه یکبار مصرف (بصورت عدد int باید باشد)
isFlash	bool	تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
sendDelay	int	تاخیر ارسال پیامک را به مدت مشخصی به تعویق بیندازد، این زمان بر حسب ثانیه می باشد. (بصورت پیش فرض 0 در نظر گرفته می شود که به معنی ارسال فوری است)

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
20-	بعلت وارد کردن رمز اشتباه پنل مسدود شده است
0	ارسال با موفقیت انجام شد
1	نام کاربر یا کلمه عبور نامعتبر می باشد
2	کاربر مسدود شده است
3	شماره فرستنده نامعتبر است
4	محدودیت در ارسال روزانه
5	تعداد گیرندگان حداکثر 100 شماره می باشد
6	خط فرستنده غیرفعال است
7	متن پیامک شامل کلمات فیلتر شده است
8	اعتبار کافی نیست
9	سامانه در حال بروز رسانی می باشد
10	وب‌سرویس غیرفعال است
11	پیاده سازی نشده است
12	تعداد پیامها و شماره ها باید یکسان باشد
13	تعداد پیامها حداکثر 100 پیام می باشد
14	هیچ مقداری برای تعرفه جاری کاربر تعریف نشده است
15	ارسال تکراری متن مشابه به شماره مشابه در مدت زمان مشخص
16	شماره موبایل گیرنده یافت نشد، ارسال از خط تبلیغاتی به شماره های لیست سیاه
17	متن وارد نشده است
18	مغایرت متن با قالب
19	تاریخ انقضای پنل به پایان رسیده است
20	وضعیت کاربر فعال نیست
21	مقدار یکی یا بیشتر از پارامترهای وروردی معتبر نیست
22	آی پی موقت بلاک شده است
23	عملیات با خطا مواجه شد. لطفاً دقایقی دیگر مجدداً تلاش نمایید
24	درخواست کاملا تکراری در بازه کوتاه (چند ثانیه)
25	ApiKey نامعتبر
26	خطا در ساخت فایل صوتی

BatchSmsId

int

شناسه پیامک

ارسال متناظر

SendSmsLikeToLike

این متد جهت ارسال پیامک با متن متفاوت به یک تا حداکثر 100 شماره به کار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/SendSmsLikeToLike

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
fromNumber	string	شماره فرستنده
toNumbers	string	شماره گیرندگان پیام که با , جدا می شوند حداکثر 100 شماره در هر بار فراخوانی
messageContents	string	متون پیامک که با , جدا می شوند
isFlash	bool	تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
20-	بعلت وارد کردن رمز اشتباه پنل مسدود شده است
0	ارسال با موفقیت انجام شد
1	نام کاربر یا کلمه عبور نامعتبر می باشد
2	کاربر مسدود شده است
3	شماره فرستنده نامعتبر است
4	محدودیت در ارسال روزانه
5	تعداد گیرندگان حداکثر 100 شماره می باشد
6	خط فرستنده غیرفعال است
7	متن پیامک شامل کلمات فیلتر شده است
8	اعتبار کافی نیست
9	سامانه در حال بروز رسانی می باشد
10	وب‌سرویس غیرفعال است
11	پیاده سازی نشده است
12	تعداد پیامها و شماره ها باید یکسان باشد
13	تعداد پیامها حداکثر 100 پیام می باشد
14	هیچ مقداری برای تعرفه جاری کاربر تعریف نشده است
15	ارسال تکراری متن مشابه به شماره مشابه در مدت زمان مشخص
16	شماره موبایل گیرنده یافت نشد، ارسال از خط تبلیغاتی به شماره های لیست سیاه
17	متن وارد نشده است
18	مغایرت متن با قالب
19	تاریخ انقضای پنل به پایان رسیده است
20	وضعیت کاربر فعال نیست
21	مقدار یکی یا بیشتر از پارامترهای وروردی معتبر نیست
22	آی پی موقت بلاک شده است
23	عملیات با خطا مواجه شد. لطفاً دقایقی دیگر مجدداً تلاش نمایید
24	درخواست کاملا تکراری در بازه کوتاه (چند ثانیه)
25	ApiKey نامعتبر
26	خطا در ساخت فایل صوتی

SmsId

int

شناسه پیامک

وضعیت تحویل پیامک

GetBatchDelivery

این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetBatchDelivery

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
batchSmsId	int	شناسه پیامک ارسال شده
index	int	شماره صفحه
count	int	تعداد رکورد در صفحه

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
5-	برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید
4-	به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد
3-	به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد
2-	پیام با این کد وجود ندارد (batchSmsId نامعتبر است)
1-	خطا در ارتباط با سرویس دهنده
0	عملیات با موفقیت انجام شد

Numbers

[] string

آرایه ای از شماره های گیرنده پیامک

DeliveryStatus

[] int

کد	توضیحات
0	ارسال شده به مخابرات
1	رسیده به گوشی
2	نرسیده به گوشی
3	خطای مخابراتی
4	خطای نامشخص
5	رسیده به مخابرات
6	نرسیده به مخابرات
7	مسدود شده توسط مقصد
8	نامشخص
9	مخابرات پیام را مردود اعالم کرد
10	کنسل شده توسط اپراتور
11	ارسال نشده

وضعیت تحویل پیامک متناظر

GetDeliveryLikeToLike

این متد جهت دریافت وضعیت تحویل پیامک متناظر ارسال شده بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetDeliveryLikeToLike

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
smsId	int	شناسه پیامک ارسال شده

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
5-	برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید
4-	به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد
3-	به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد
2-	پیام با این کد وجود ندارد (batchSmsId نامعتبر است)
1-	خطا در ارتباط با سرویس دهنده
0	عملیات با موفقیت انجام شد

Numbers

[] string

آرایه ای از شماره های گیرنده پیامک

DeliveryStatus

[] int

کد	توضیحات
0	ارسال شده به مخابرات
1	رسیده به گوشی
2	نرسیده به گوشی
3	خطای مخابراتی
4	خطای نامشخص
5	رسیده به مخابرات
6	نرسیده به مخابرات
7	مسدود شده توسط مقصد
8	نامشخص
9	مخابرات پیام را مردود اعالم کرد
10	کنسل شده توسط اپراتور
11	ارسال نشده

پیامک های دریافتی یا ارسالی

GetMessages

این متد جهت دریافت پیامک های دریافتی یا ارسالی استفاده می شود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetMessages

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
messageType	int	مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی و اگر 2 باشد پیامک های ارسالی را مشخص می کند
fromNumbers	[] string	آرایه ی از شماره های فرستنده می باشد مانند : 10002188
index	int	اندیس مربوط به ردیف پیام های دریافتی، توجه مقدار اندیس از 1 شروع می شود
count	int	تعداد رکورد درخواستی، حداکثر 1000

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
2-	کاربر غیرفعال می باشد
1-	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

Messages

[] MessageInfo

آرایه ی از نوع MessageInfo

پیامک های دریافتی یا ارسالی بر اساس بازه زمانی

GetMessagesByDateRange

این متد جهت دریافت پیامک های دریافتی یا ارسالی استفاده می شود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetMessagesByDateRange

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
messageType	int	مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی و اگر 2 باشد پیامک های ارسالی را مشخص می کند
fromNumbers	string	آرایه ی از شماره های فرستنده می باشد که با , جدا می شوند
fromDate	datetime	تاریخ شروع مانند: 2026-02-21
toDate	datetime	تاریخ پایان مانند: 2026-03-21

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
2-	کاربر غیرفعال می باشد
1-	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

Messages

[] MessageInfo

آرایه ی از نوع MessageInfo

چک کردن شماره مسدود شده

NumberIsInTelecomBlacklist

این متد جهت چک کردن شماره مسدود شده توسط مخابرات بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/NumberIsInTelecomBlacklist

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
number	string	شماره همراه

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
3-	شماره همراه مشخص نشده است
2-	کاربر غیرفعال می باشد
1-	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

IsBlack

bool

اگر شماره همراه در لیست سیاه مخابرات باشد مقدار true و در غیر این صورت مقدار false را برمیگرداند

دریافت فایل شماره مسدود شده

ExtractTelecomBlacklistNumbers

این متد جهت چک کردن شماره مسدود شده توسط مخابرات تا حداکثر 1000 شماره بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/ExtractTelecomBlacklistNumbers

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
numbers	string	شماره های همراه که با , جدا می شوند حداکثر 1000 شماره در هر بار فراخوانی

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
4-	تعداد شماره ها حداکثر 1000 شماره می باشد
3-	آرایه ی شماره های همراه خالی می باشد
2-	کاربر غیرفعال می باشد
1-	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

blacklistNumbers

[] string

شماره های مسدود شده

دریافت تعداد پیامهای دریافتی

GetInboxCount

این متد جهت دریافت تعداد پیامهای دریافتی بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetInboxCount

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
isRead	bool	مقدار true برای پیامهای خوانده شده مقدار false برای پیامهای خوانده نشده

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
1 -	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

InboxCount

int

مقدار برگشتی یک عدد می باشد که بر اساس پارامتر isRead بیانگر تعداد پیامها دریافتی می باشد

میزان اعتبارکاربر

GetCredit

این متد برای دریافت میزان اعتبارکاربر بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetCredit

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
1-	نام کاربری و رمز عبور صحیح نمی باشد
2-	کاربر غیرفعال می باشد
0	عملیات با موفقیت انجام شد

Credit

decimal

میزان اعتبار کاربر به پیامک

شماره های فرستنده

GetSenderNumbers

این متد برای دریافت شماره های فرستنده بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/GetSenderNumbers

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
2-	کاربر غیرفعال می باشد
1-	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

Senders

[] string

شماره های فرستنده

چک کردن محتوای پیامک

CheckSmsContent

این متد برای چک کردن محتوای پیامک بکار می رود.

آدرس صفحه URL

URL

http://in.payamak-service.ir/api/v2/RestWebApi/CheckSmsContent

پارامترهای ورودی

نام پارامتر	نوع پارامتر	توضیحات
userName	string	نام کاربری مربوط به حساب شما در سامانه
password	string	رمز عبور مربوط به حساب شما در سامانه
message	string	متن

پارامترهای خروجی متد

نام پارامتر

نوع پارامتر

توضیحات

ResultCode

int

کد	توضیحات
7-	ApiKey نامعتبر
6-	آی پی موقت بلاک شده است
2-	کاربر غیرفعال می باشد
1-	نام کاربری و رمز عبور صحیح نمی باشد
0	عملیات با موفقیت انجام شد

IsValid

bool

اگر متن پیامک شامل کلمات فیلتر شده باشد مقدار برگشتی false و در غیر اینصورت true می باشد

اعتماد بهترین‌ها به ما

خوشحالیم که اعتماد و رضایت شما همراه ماست