مستندات وب سرویس نسخه جدید چاپ

در زیر متد ها و نحوه استفاده از هر متد شرح داده شده است . 

نام متد sms_get_number_in_cat  : این متد برای دریافت لیست شماره های ذخیره شده در یک دسته بندی ( مخاطبین سامانه ) استفاده میشود . 

پارامتر ها : 

 - username : نام کاربری مورد استفاده در سامانه پیامک  [اجباری]

 - password : رمز عبور مورد استفاده در سامانه پیامک [اجباری]

 - catid : شناسه گروه شماره های موردنظر  [اجباری]

 - start : اندیس شروع کننده نتیجه ( مثلا اگر شماره سی ام تا پنجاهم را نیاز دارید باید این پارامتر را عدد 30 قرار دهید )    [اختیاری]

- perpage : تعداد سطور نتایج [اختیاری]

 - order :  میتوان نتیجه را براساس پارامتریابارگذاری و فیلتر نمود ( sort )   [اختیاری]

پاسخ : پاسخ این متد به صورت آرایه ارسال خواهد شد . 

نام متد sms_get_cat_list  : این متد برای دریافت لیست دسته بندی مخاطبین کاربر استفاده میشود . 

پارامتر ها : 

 - username : نام کاربری مورد استفاده در سامانه پیامک  [اجباری]

 - password : رمز عبور مورد استفاده در سامانه پیامک [اجباری]

پاسخ : پاسخ این متد به صورت آرایه دو بعدی خواهد بود که شامل کلیه اطلاعات هر دسته بندی مثل عنوان , شناسه و دیگر موارد خواهد بود . 

نام متد send_sms  : این متد برای ارسال پیامک از طریق وب سرویس استفاده خواهد شد 

پارامتر ها : 

 - username : نام کاربری مورد استفاده در سامانه پیامک  [اجباری]

 - password : رمز عبور مورد استفاده در سامانه پیامک [اجباری]

 - sender_number : شماره ارسال کننده در سامانه پیامک  [اجباری]

 - reciever_number : شماره دریافت کننده پیامک  [اجباری]

- note : متن پیامک ارسالی  [اجباری]

- date : تاریخ ارسال پیامک ( ارسال در آینده ) [ اختیاری ] - این متغیر به صورت آرایه ارسال میشود و میتواند شامل یک یا بیش از یک تاریخ باشد . 

- request_uniqueid : جهت جلوگیری از ارسال پیامک تکراری از منبع کد , میتوانید این متغیر را با یک عدد یا متن منحصر به فرد مقداردهی کنید . در صورت ارسال درخواست تکراری در پاسخ این متد smsid های قبلی ارسال خواهند شد 

 - ersal_flash : آیا پیامک به صورت فلش ارسال شود یا خیر ( مقدار true یا false دریافت میکند ) [اختیاری]

- onlysend : جهت ارسال سریع بدون وقفه در زمان ارسال پیامک ( ارسال پیامک با تاخیر 15 ثانیه به مشترک انجام خواهد شد) [اختیاری]

- date : تاریخ ارسال پیامک ( مورد استفاده جهت پیامک های ارسال در آینده ) [اختیاری]

پاسخ : پاسخ این متد به طور معمول شامل آرایه ای از اعداد هستند که به آنها smsid و یا شناسه پیامک در سیستم گفته میشوند . 

نام متد get_number  : این متد برای دریافت لیست شماره های ارسال کننده ( اعم از عمومی یا اختصاصی ) کاربر استفاده میشود 

پارامتر ها : 

 - username : نام کاربری مورد استفاده در سامانه پیامک  [اجباری]

 - password : رمز عبور مورد استفاده در سامانه پیامک [اجباری]

پاسخ :  پاسخ این متد به صورت یک آرایه دو بعدی ارسال خواهد شد که شامل شماره های ارسال کننده و در بعد دوم شامل نوع و ترتیب این شماره ها است . نوع شماره ها ( kind ) میتوانید حاوی مقدار user یعنی خط اختصاصی و public یعنی خط عمومی باشد . 

نام متد  sms_deliver : استعلام وضعیت پیامک با شناسه ارسال شده 

پارامترها : 

 -  smsid_arr : یک ارایه شامل شناسه های یکتای پیامک های ارسال شده جهت استعلام وضعیت [اجباری]

 -  dargah :  درگاه مربوط به پیامک ارسال شده - مقادیر قابل استفاده : 1000-2000-3000-9821-50001-50002-50004  [اجباری]

پاسخ : پاسخ این متد به صورت یک ارایه به ترتیب آرایه درخواستی خواهد بود . آرایه بازگشتی شامل اعداد  خواهد بود که هر عدد برابر با یک وضعیت پیامک است . ( لیست اعداد و وضعیت پیامک های ارسالی ) 

نام متد  is_number_in_blacklist : استعلام وضعیت  لیست سیاه برای هر شماره موبایل 

پارامترها : 

 -  number : شماره موبایل موردنظر جهت استعلام بلک لیست . این متغیر به صورت آرایه باید ارسال شود .   [اجباری]

پاسخ : پاسخ این متد به صورت آرایه به ترتیب مقادیرارسالی خواهد بود . مقدار 0  : شماره بلک لیست نیست . مقدار 1 : شماره بلک لیست است . ( جهت اطلاعات بیشتر در مورد : بلک لیست چیست ؟ ) 

نام متد add_user  : این متد جهت افزودن یک کاربر جدید به سیستم مورد استفاده قرار میگیرد . 

پارامترها : 

 - admin_username :نام کاربری پنل مدیریت   [اجباری]

 - admin_password : رمز عبور پنل مدیریت    [اجباری]

 - username : یوزرنیم درخواستی برای کاربر   [اجباری]

 - password : رمز عبور درخواستی برای کاربر   [اجباری]

 - email : ایمیل کاربر    [اجباری]

 - fullname : نام و نام خانوادگی کاربر    [اجباری]

 - mobile : موبایل کاربر    [اجباری]

 - catid : شناسه مربوط به گروه کاربری    [اختیاری [

پاسخ : پاسخ این متد به صورت متن بازگشت داده خواهد شد . در صورتی که خطایی در زمان ایجاد کاربر بروز نماید متن خطا در پاسخ درخواست ارسال خواهد شد . مثل نام کاربری تکراری یا موبایل تکراری 

نام متد sms_user_info  : این متد برای دریافت اطلاعات یک کاربر استفاده میشود . 

پارامترها : 

 -  username : نام کاربری که با آن در سامانه وارد میشوید    [اجباری]

 -  password :رمز عبور که با آن در سامانه وارد میشوید    [اجباری]

پاسخ : پاسخ این متد به صورت آرایه شامل اطلاعات کاربر درخواستی مثل شناسه کاربر / نام / ایمیل / موبایل / موجودی / تاریخ ایجاد و تاریخ انقضا خواهد بود . 

نام متد sms_credit : این متد برای استعلام میزان موجودی کاربر موردنظر استفاده میشود . مقدار بازگشتی به ریال خواهد بود . 

پارامتر ها : 

- username : نام کاربری موردنظر در سامانه پیامک [اجباری]

- password : رمزعبور موردنظر در سامانه پیامک [اجباری]

پاسخ : پاسخ این متد به صورت یک عدد ساده و براساس ریال ارسال خواهد شد . 

نام متد  sms_add_number : این متد برای افزودن شماره جدید به دفتر تلفن کاربر استفاده میگردد . 

پارامترها : 

 - username : نام کاربری مورد استفاده در سامانه پیامک [اجباری]

- password : رمزعبور مورداستفاده در سامانه پیامک[اجباری]

- fullname : نام کامل مربوط به شخص [اجباری]

- number : شماره همراه شخص[اجباری]

- catid : شناسه دسته بندی هدف که شخص در آن قرار خواهد گرفت .[اجباری]

- gender : جنسیت شخص ( خانم / آقا ) 

- fullname_en : نام شخص به انگلیسی

- gender_en : جنسیت شخص به انگلیسی ( Mr/Miss) 

پاسخ :  پاسخ این متد به صورت یک متن ساده که در صورت موفقیت آمیز بودن عملیات شامل کلمه ok و در صورتی که خطایی رخ دهد شامل متن خطای پیش آمده خواهد بود . 

نام متد  sms_receive : دریافت لیست پیامک های دریافتی کاربر از طریق وب سرویس 

پارامترها : 

 - username : نام کاربری مورد استفاده در سامانه[اجباری]

- password : رمز عبور مورداستفاده در سامانه[اجباری]

- number : شماره خط اختصاصی کاربر مورد استفاده در سامانه [اجباری]

- catid : شناسه دسته بندی پیامک های دریافتی

- start : شناسه شروع لیست پیامک ها 

- perpage : تعداد پیامک های دریافتی در هر صفحه

- read : نشانه گذاری پیامک ها به صورت خوانده شده ( true یا false) 

پاسخ : این متد در پاسخ یک آرایه دو بعدی شامل پیامک های دریافتی در بازه تعیین شده را ارسال خواهد کرد . 

نام متد  user_add_cat : این متد برای افزودن یک گروه جدید در قسمت مخاطبین استفاده میشود .

پارامترها : 

 - username : نام کاربری مورد استفاده در سامانه [اجباری]

- password : رمز عبور مورداستفاده در سامانه [اجباری]

- title : شماره خط اختصاصی کاربر مورد استفاده در سامانه [اجباری]

پاسخ : این متد در پاسخ یک آرایه ارسال خواهد کرد که شامل شناسه گروه های ایجاد شده خواهد بود . این متد تکراری بودن نام گروههای کاربری را بررسی نمیکند . 

نام متد convert_unixtime_to_jalali  : این تابع برای تبدیل timestamp لینوکس به تاریخ جلالی - شمسی استفاده میشود . 

پارامترها : 

 - date : نام کاربری مورد استفاده در سامانه [اجباری]

پاسخ : این متد در پاسخ یک متن ساده ارسال خواهد کرد که شامل تاریخ و ساعت و دقیقه به شمسی و فقط اعداد خواهد بود . 

 نام متد  number_query  : این تابع برای استعلام یک شماره از نظر این که در سیستم ثبت شده یا خیر استفاده میشود . 

پارامترها : 

 - number:  شماره استعلامی جهت بررسی . شماره باید به صورت کامل ارایه شود . مثل : 30005970 یا 10009131101212  [اجباری]

پاسخ : این متد در پاسخ یک متن ساده ارسال خواهد کرد که اگر شماره در سیستم موجود باشد متن با عدد 0 شروع و در ادامه خطای سیستم را نمایش میدهد و در صورتی که شماره موجود نباشد عدد 1 برگشت داده میشود