وب سرویس پیامک آی نوتی
به کمک وب سرویس های پیامک شما میتوانید از خدمات پیام کوتاه آی نوتی بر روی سرور خودتان بهره مند شوید.
متدهای ارسال پیامک
متدهای ارسال پیامک به دو صورت تکی و گروهی قابل فراخوانی هستند،این متدها عبارتند از
- SendSingleSMS
- SendBatchSMS
متد ارسال تکی (SendSingleSMS)
این متد برای ارسال یک متن پیامک به یک شماره موبایل خاص از این متد استفاده می شود. ورودی های این وب سرویس به ترتیب زیر است :
| فیلد | نوع داده | توضیحات |
|---|---|---|
| Username | string | نام کاربری شما در پرتال آی نوتی |
| Password | string | کلمه عبور شما در آی نوتی |
| LineNo | string | شماره ای که می خواهید پیامک شما از آن ارسال شود و در پنل آی نوتی برای شما فعال شده است. مثال "200008590" |
| MobileNumber | string | شماره موبایلی که می خواهید پیامک برای آن ارسال گردد. مانند "09121234567" |
| Message | string | متن پیامکی که میخواهید برای مخاطب ارسال گردد. |
** خروجی تابع مقدار عددی integer می باشد. در صورتیکه اطلاعات ورودی صحیح بوده و پیامک با موفقیت جهت ارسال به پرتال آی نوتی تحویل گردد. یک عدد صحیح مثبت که شناسه ی پیامک ارسال شده شما در آی نوتی میباشد برگشت داده خواهد شد. در صورت بروز خطا که اعداد منفی هستند و شرح آنها در جدول زیر آمده است برگشت داده میشوند.
| عنوان | شرح |
|---|---|
| اطلاعات کاربری نامعتبر | زمانیکه Username یا password ارسال شده توسط شما در پرتال آی نوتی موجود و فعال نباشد با این کد خطا روبرو خواهید شد |
| شماره خط نامعتبر | زمانیکه LineNo ارسال شده توسط شما در پنل حساب کاربری شما در آی نوتی تعریف نشده باشد و یا فعال نباشد با این کد خطا روبرو خواهید شد |
| شماره موبایل نامعتبر | درصورتی که MobileNumber وارد شده توسط شما اشتباه باشد با این خطا مواجه خواهید شد |
| موجودی نا کافی | در صورتیکه موجودی کافی برای ارسال پیامک در پنل کاربری شما در پرتال آی نوتی نداشته باشید با این پیغام خطا روبرو خواهید شد |
گزارش دلیوری تکی (DeliverSMS)
این متد جهت دریافت وضعیت دلیوری یک پیامک است. درصورتیکه اقدام به ارسال تکی پیامک خود کرده اید و یا فقط وضعیت دلیوری یک پیامک خاص را میخواهید بررسی کنید ، میتوانید از این متد استفاده کنید. پارامتر های ورودی این متد:
| فیلد | نوع داده | توضیحات |
|---|---|---|
| Username | string | نام کاربری شما در پرتال آی نوتی |
| Password | string | کلمه عبور شما در آی نوتی |
| LineNo | string | شماره ای که پیامک را از آن ارسال کرده اید. مثال "200008590" |
| MobileNumber | string | شماره موبایلی که پیامک را برای آن ارسال کرده اید. مانند "09121234567" |
| BulkID | string | شماره شناسه ای که هنگام ارسال پیامک از طریق وب سرویس آی نوتی به عنوان خروجی دریافت کرده اید |
** خروجی تابع مقدار عددی integer میباشد. درصورتیکه درخواست شما با خطا روبرو شود یک کد منفی و در صورتیکه درخواست شما با موفقیت پاسخ داده شود یک کد مثبت به عنوان خروجی متد برگشت داده میشود که شرح آنها ذیلا آمده است: جدول کدهای خروجی (وضعیت دلیوری)
| خروجی | عنوان |
|---|---|
| -1 | اطلاعات کاربری نامعتبر |
| -2 | شماره خط نامعتبر |
| -3 | شماره موبایل نامعتبر |
| -4 | موجودی نا کافی |
دریافت موجودی شارژ پنل پیامکی
برای دریافت مبلغ موجودی شارژ پنل پیامکی خود در آی نوتی از این متد استفاده میشود. پارامترهای ورودی :
| فیلد | نوع داده | توضیحات |
|---|---|---|
| Username | string | نام کاربری شما در پرتال آی نوتی |
| Password | string | کلمه عبور شما در آی نوتی |
** مقدار خروجی این متد یک عدد اعشاری float که نمایانگر مبلغ موجودی شارژ است میباشد. در صورتیکه نام کاربری و یا رمز ارسال شده اشتباه باشد ، مقدار 1- و در صورت بروز خطار در سیستم مقدار 2- برگشت داده میشود.