نمونه‌های کدی که اعتماد شما را برای صفحه وب‌سرویسمان برقرار میکند
صفحه وب‌سرویس ما، منبعی برای ایده‌ها و نمونه کدهاست.
ارسال ساده
SendSMS
از این متد برای ارسال پیامک به یک تا حداکثر ۱۰۰ شماره استفاده می‌شود.
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| fromNumber | string | شماره فرستنده |
| toNumbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی |
| messageContent | string | متن پیامک |
| isFlash | bool | تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر |
| ref recId | [] int | هر خانه آرایه یک عدد یکتا به ازای هر گیرنده تولید می کند، این کد یکتا برای دریافت وضعیت تحویل کاربر دارد |
| ref status | [] byte | هر خانه آرایه عدد 0 یا 1 بوده به ازای هر گیرنده تولید می شود، 1 به معنی ارسال شده و 0 ارسال نشده |
پارامترهای خروجی
| نوع پارامتر | توضیحات |
|---|---|
| int | 0 : ارسال با موفقیت انجام شد 1 : نام کاربر یا کلمه عبور نامعتبر می باشد 2 : کاربر مسدود شده است 3 : شماره فرستنده نامعتبر است 4 : محدودیت در ارسال روزانه 5 : تعداد گیرندگان حداکثر 100 شماره می باشد 6 : خط فرستنده غیرفعال است 7 : متن پیامک شامل کلمات فیلتر شده است 8 : اعتبار کافی نیست 9 : سامانه در حال بروز رسانی می باشد 10 : وب‌سرویس غیرفعال است 11 : تعداد پیامها و شماره ها باید یکسان باشد 12 : تعداد پیامها حداکثر 100 پیام می باشد 13 : LimitationInMesssageContentCount 14 : هیچ مقداری برای تعرفه جاری کاربر تعریف نشده است 15 : ارسال تکراری متن مشابه به شماره مشابه در مدت زمان مشخص 16 : ﺷﻤﺎره ﻣﻮﺑﺎﻳﻞ گیرنده ﻳﺎﻓﺖ ﻧﺸﺪ، ارسال از خط تبلیغاتی به شماره های لیست سیاه 17 : متن وارد نشده است 18 : مغایرت متن با قالب 19 : تاریخ انقضای پنل به پایان رسیده است 20 - : بعلت وارد کردن رمز اشتباه پنل مسدود شده است |
ارسال گروهی
SendBatchSms
این متد جهت ارسال پیامک به یک تا حداکثر 100 شماره به کار می رود.
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| fromNumber | string | شماره فرستنده |
| toNumbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی |
| messageContent | string | متن پیامک |
| isFlash | bool | تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر |
| out batchSmsId | int | شناسه ارسال گروهی |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | 0 : ارسال با موفقیت انجام شد 1 : نام کاربر یا کلمه عبور نامعتبر می باشد 2 : کاربر مسدود شده است 3 : شماره فرستنده نامعتبر است 4 :محدودیت در ارسال روزانه 5 : تعداد گیرندگان حداکثر 100 شماره می باشد 6 : خط فرسنتده غیرفعال است 7 : متن پیامک شامل کلمات فیلتر شده است 8 : اعتبار کافی نیست 9 : سامانه در حال بروز رسانی می باشد 10 : وب‌سرویس غیرفعال است |
ارسال متناظر
SendSmsLikeToLike
این متد جهت ارسال پیامک با متن متفاوت به یک تا حداکثر 100 شماره به کار می رود.
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| fromNumber | string | شماره فرستنده |
| toNumbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی |
| messageContents | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی |
| isFlash | bool | تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر |
| out batchSmsId | int | شناسه ارسال |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | 0 : ارسال با موفقیت انجام شد 1 : نام کاربر یا کلمه عبور نامعتبر می باشد 2 : کاربر مسدود شده است 3 : شماره فرستنده نامعتبر است 4 :محدودیت در ارسال روزانه 5 : تعداد گیرندگان حداکثر 100 شماره می باشد 6 : خط فرسنتده غیرفعال است 7 : متن پیامک شامل کلمات فیلتر شده است 8 : اعتبار کافی نیست 9 : سامانه در حال بروز رسانی می باشد 10 : وب‌سرویس غیرفعال است |
وضعیت تحویل ارسال گروهی
GetBatchDelivery
از این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود که با متد SendBatchSms ارسال انجام شده است
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| batchSmsId | int | شناسه ارسال با متد SendBatchSms |
| numbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد |
| deliveryStatus | [] int | آرایه ی از وضعیت تحویل متناظر با آرایه شماره موبایل ها می باشد ترجمه مقدار وضعیت تحویل: 5 - : برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید
4 - : به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد
3 - : به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد
2 - : پیام با این کد وجود ندارد (batchSmsId نامعتبر است)
1 - : خطا در ارتباط با سرویس دهنده
0 : ارسال شده به مخابرات
1 : رسیده به گوشی
2 : نرسیده به گوشی
3 : خطای مخابراتی
4 : خطای نامشخص
5 : رسیده به مخابرات
6 : نرسیده به مخابرات
7 : مسدود شده توسط مقصد
8 : نامشخص
9 : مخابرات پیام را مردود اعالم کرد
10 : کنسل شده توسط اپراتور
11 : ارسال نشده |
| index | int | اندیس مربوط به ردیف پیام ارسالی، توجه مقدار اندیس از 1 شروع می شود. |
| count | int | تعداد رکورد درخواستی، حداکثر 100 |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | 1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : ارسال با مقدار شناسه batchSmsId وجود ندارد |
وضعیت تحویل پیامک
GetDelivery
این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| recId | long | شناسه پیامک ارسال شده |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | وضعیت تحویل پیامک می باشد ترجمه مقدار وضعیت تحویل: 5 - : برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید
4 - : به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد
3 - : به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد
2 - : پیام با این کد وجود ندارد (batchSmsId نامعتبر است)
1 - : خطا در ارتباط با سرویس دهنده
0 : ارسال شده به مخابرات
1 : رسیده به گوشی
2 : نرسیده به گوشی
3 : خطای مخابراتی
4 : خطای نامشخص
5 : رسیده به مخابرات
6 : نرسیده به مخابرات
7 : مسدود شده توسط مقصد
8 : نامشخص
9 : مخابرات پیام را مردود اعالم کرد
10 : کنسل شده توسط اپراتور
11 : ارسال نشده |
پیامک های دریافتی یا ارسالی
GetMessages
از این متد جهت دریافت پیامک های دریافتی یا ارسالی استفاده می شود
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| messageType | int | مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی و اگر 2 باشد پیامک های ارسالی را مشخص می کند |
| fromNumbers | [] string | آرایه ی از شماره های فرستنده می باشد مانند : 10002188 |
| index | int | اندیس مربوط به ردیف پیام های دریافتی، توجه مقدار اندیس از 1 شروع می شود |
| count | int | تعداد رکورد درخواستی، حداکثر 1000 |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| [] MessageInfo | آرایه ی از نوع MessageInfo |
چک کردن شماره مسدود شده
NumberIsInTelecomBlacklist
این متد جهت چک کردن شماره مسدود شده توسط مخابرات بکار می رود
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| number | string | شماره همراه |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | 1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : کاربر غیرفعال می باشد 3 - : شماره همراه مشخص نشده است 0 : شماره آزاد است 1 : شماره در لیست سیاه مخابرات است |
دریافت فایل شماره مسدود شده
ExtractTelecomBlacklistNumbers
این متد جهت چک کردن شماره مسدود شده توسط مخابرات تا حداکثر 1000 شماره بکار می رود
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| numbers | [] string | آرایه ای از شماره های همراه می باشد حداکثر 1000 شماره در هر بار فراخوانی |
| out blacklistNumbers | [] string | شماره های مسدود شده |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | 1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : کاربر غیرفعال می باشد 3 - : آرایه ی شماره های همراه خالی می باشد 4 - : تعداد شماره ها حداکثر 1000 شماره می باشد 0 : عملیات با موفقیت انجام شد |
دریافت تعداد پیامهای دریافتی
GetInboxCount
این متد جهت دریافت تعداد پیامهای دریافتی بکار می رود
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| isRead | bool | مقدار true برای پیامهای خوانده شده مقدار false برای پیامهای خوانده نشده |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| int | اگر نام کاربری و رمز عبور صحیح باشد مقدار برگشتی یک عدد می باشد که بر اساس پارامتر isRead بیانگر تعداد پیامها دریافتی می باشد 1 - : نام کاربری و رمز عبور صحیح نمی باشد |
میزان اعتبارکاربر
GetCredit
این متد برای دریافت میزان اعتبارکاربر بکار می رود
آدرس صفحه URL
URL
https://niazpardaz-sms.com/webservice
پارامترهای ورودی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
پارامترهای خروجی
| نام پارامتر | نوع پارامتر | توضیحات |
|---|---|---|
| decimal | میزان اعتبار کاربر به پیامک می باشد مقدار اعتبار صفر یا عددی برزگتر از صفر می باشد در غیر اینصورت : 1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : کاربر غیرفعال می باشد |