با استفاده از وب سرویس شما میتوانید بدون ورود به سامانه و از طریق وبسایت,پرتال و یا وبلاگ خود اقدام به ارسال پیامک نمایید کلیه ماژولهای سامانه براساس وب سرویس نوشته و یا تنظیم شده اند . وب سرویس سامانه 31SMS.ir از 14 متد پشتیبانی مینماید . این متد ها جهت عملیات های ارسال پیامک , دریافت لیست پیامک های دریافتی , دریافت گزارش پیامک های ارسالی , افزودن شماره به دفترچه تلفن, بررسی شماره موبایل در بلک لیست مخابرات , میزان موجودی و دریافت اطلاعات یک کاربر مورد استفاده قرار میگیرد .
برای استفاده از وب سرویس باید ابتدا آدرس زیر را به عنوان فایل اصلی به برنامه معرفی نمایید :
آدرس وب سرویس : http://www.31sms.ir/webservice/smsService.php?wsdl
در زیر متد ها و نحوه استفاده از هر متد شرح داده شده است .
نام متد sms_send : این متد برای ارسال پیامک از طریق وب سرویس استفاده خواهد شد . این متد 8 پارامتر ورودی دریافت میکند که شامل : username,password,sender_number,reciever_number,note,ersal_flash,onlysend,date خواهد بود .
پارامتر ها :
- username : نام کاربری مورد استفاده در سامانه پیامک [اجباری]
- password : رمز عبور مورد استفاده در سامانه پیامک [اجباری]
- sender_number : شماره ارسال کننده در سامانه پیامک [اجباری]
- reciever_number : شماره دریافت کننده پیامک [اجباری]
- note : متن پیامک ارسالی [اجباری]
- ersal_flash : آیا پیامک به صورت فلش ارسال شود یا خیر ( مقدار true یا false دریافت میکند ) [اختیاری]
- onlysend : جهت ارسال سریع بدون وقفه در زمان ارسال پیامک ( ارسال پیامک با تاخیر 15 ثانیه به مشترک انجام خواهد شد) [اختیاری]
- date : تاریخ ارسال پیامک ( مورد استفاده جهت پیامک های ارسال در آینده ) [اختیاری]
نام متد send_sms_array : این متد برای ارسال پیامک از طریق وب سرویس و دریافت اطلاعات به جای دریافت تک به تک به صورت آرایه دریافت میشوند . کلیه پارامتر های ورودی دقیقا مشابه متد send_sms خواهد بود .
نام متد sms_postalcode_count : این متد جهت دریافت تعداد شماره های موجود در یک کدپستی در یک استان مورد استفاده قرار میگیرد .
پارامترها :
- postalcode : کدپستی مورد نظر شما ( مثل 81948) [اجباری]
- ostan : نام استان موردنظر به انگلیسی ( مثل tehran - esfahan - shiraz - ... ) [اجباری]
نام متد is_number_in_blacklist : این متد برای شناسایی یک شماره موبایل از نظر این که آیا این شماره در لیست سیاه مخابرات وجود دارد یا خیر استفاده میشود .
پارامترها :
- number : شماره موبایل موردنظر شما [اجباری]
نام متد sms_credit : این متد برای استعلام میزان موجودی کاربر موردنظر استفاده میشود . مقدار بازگشتی به ریال خواهد بود .
پارامتر ها :
- username : نام کاربری موردنظر در سامانه پیامک [اجباری]
- password : رمزعبور موردنظر در سامانه پیامک [اجباری]
نام متد sms_user_info : این متد برای دریافت اطلاعات کاربر موردنظر استفاده میگردد . مقداربازگشتی به صورت آرایه خواهد بود .
پارامترها :
- username : نام کاربری موردنظر در سامانه پیامک [اجباری]
- password : رمزعبور موردنظر در سامانه پیامک [اجباری]
نام متد sms_deliver : استعلام وضعیت پیامک با شناسه ارسال شده
پارامترها :
- smsid : شناسه یکتای پیامک ارسال شده جهت استعلام [اجباری]
نام متد sms_add_number : این متد برای افزودن شماره جدید به دفتر تلفن کاربر استفاده میگردد .
پارامترها :
- username : نام کاربری مورد استفاده در سامانه پیامک [اجباری]
- password : رمزعبور مورداستفاده در سامانه پیامک[اجباری]
- fullname : نام کامل مربوط به شخص [اجباری]
- number : شماره همراه شخص[اجباری]
- catid : شناسه دسته بندی هدف که شخص در آن قرار خواهد گرفت .[اجباری]
- gender : جنسیت شخص ( خانم / آقا )
- fullname_en : نام شخص به انگلیسی
- gender_eng : جنسیت شخص به انگلیسی ( Mr/Miss)
نام متد sms_receive_list : دریافت لیست پیامک های دریافتی کاربر از طریق وب سرویس
پارامترها :
- username : نام کاربری مورد استفاده در سامانه[اجباری]
- password : رمز عبور مورداستفاده در سامانه[اجباری]
- number : شماره خط اختصاصی کاربر مورد استفاده در سامانه [اجباری]
- catid : شناسه دسته بندی پیامک های دریافتی
- start : شناسه شروع لیست پیامک ها
- perpage : تعداد پیامک های دریافتی در هر صفحه
- read : نشانه گذاری پیامک ها به صورت خوانده شده ( true یا false)
