وب سرویس سامانه ارسال پیامک
با استفاده از وب سرویس شما میتوانید بدون ورود به سامانه و از طریق وب سایت , پورتال و یا وبلاگ خود اقدام به ارسال پیامک نمایید
کلیه ماژولهای سامانه براساس وب سرویس نوشته و یا تنظیم شده اند . وب سرویس SMS-TNT.ir از 12 متد پشتیبانی می نماید . این متد ها جهت عملیات های ارسال پیامک , دریافت لیست پیامک های دریافتی , دریافت گزارش پیامک های ارسالی , افزودن شماره به دفترچه تلفن , بررسی شماره موبایل در بلک لیست مخابرات , میزان موجودی و دریافت اطلاعات یک کاربر مورد استفاده قرار میگیرد .
برای استفاده از وب سرویس باید ابتدا آدرس زیر را به عنوان فایل اصلی به برنامه معرفی نمایید :
آدرس وب سرویس : http://www.SMS-TNT.ir/webservice/smsService.php?wsdl
در زیر متد ها و نحوه استفاده از هر متد شرح داده شده است .
نام متد sms_send :
برای ارسال پیامک از طریق وب سرویس استفاده خواهد شد . این متد 8 پارامتر ورودی دریافت میکند که شامل : username , password , sender_number , reciever_number , note , ersal_flash, onlysend , date خواهد بود .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| sender_number |
String |
شماره ارسال کننده در سامانه پیامک [اجباری] |
| reciever_number |
String |
شماره دریافت کننده پیامک [اجباری] |
| note |
String |
متن پیامک ارسالی [اجباری] |
| ersal_flash |
String |
آیا پیامک به صورت فلش ارسال شود یا خیر ( مقدار true یا false دریافت می کند ) [اختیاری] |
| onlysend |
String |
جهت ارسال سریع بدون وقفه در زمان ارسال پیامک ( ارسال پیامک با تاخیر 15 ثانیه به مشترک انجام خواهد شد) [اختیاری] |
| date |
String |
تاریخ ارسال پیامک ( مورد استفاده جهت پیامک های ارسال در آینده ) [اختیاری] |
| پارامتر های بازگشتی |
| Return value |
String |
اگر String برگشتی با error شروع شود به معنی رخ دادن خطاست که علت خطا نیز در String موجود می باشد.
در صورت دریافت عدد به معنی ارسال موفق پیام بوده وباید این عدد را برای دریافت دلیوری ذخیره نمایید.
|
نام متد send_sms_array :
برای ارسال پیامک از طریق وب سرویس و دریافت اطلاعات به جای دریافت تک به تک به صورت آرایه دریافت می شوند . کلیه پارامتر های ورودی دقیقا مشابه متد send_sms خواهد بود .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| sender_number |
String |
شماره ارسال کننده در سامانه پیامک [اجباری] |
| reciever_number |
String |
شماره دریافت کننده پیامک [اجباری] |
| note |
array |
متن پیامک ارسالی [اجباری] |
| ersal_flash |
String |
آیا پیامک به صورت فلش ارسال شود یا خیر ( مقدار true یا false دریافت می کند ) [اختیاری] |
| onlysend |
String |
جهت ارسال سریع بدون وقفه در زمان ارسال پیامک ( ارسال پیامک با تاخیر 15 ثانیه به مشترک انجام خواهد شد) [اختیاری] |
| date |
String |
تاریخ ارسال پیامک ( مورد استفاده جهت پیامک های ارسال در آینده ) [اختیاری] |
| پارامتر های بازگشتی |
| Return value |
array |
Index اول state می باشد که اگر ok نباشد شامل متن خطا می باشد .
در اندیس smsid آرایه ای از ID پیامک های ارسالی می باشد که برای delivery باید ذخیره گردد.
|
نام متد sms_postalcode_count :
جهت دریافت تعداد شماره های موجود در یک کدپستی در یک استان مورد استفاده قرار می گیرد .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| postalcode |
int |
کدپستی مورد نظر شما (مثل 81896) [اجباری] |
| ostan |
String |
نام استان مورد نظر به انگلیسی مثل tehran - esfahan - shiraz , ... [اجباری] |
| پارامتر های بازگشتی |
| Return value |
int |
تعداد شماره های موبایل موجود در آن منطقه کدپستی
|
نام متد is_number_in_blacklist :
برای شناسایی یک شماره موبایل از نظر این که آیا این شماره در لیست سیاه مخابرات وجود دارد یا خیر استفاده می شود .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| number |
int |
شماره موبایل موردنظر شما [اجباری] |
| پارامتر های بازگشتی |
| Return value |
int |
0 : بلک لیست نیست
1 : بلک لیست هست
|
نام متد sms_credit :
جهت دریافت میزان اعتبار پنل استفاده می گردد. مقدار بازگشتی به ریال خواهد بود .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| پارامتر های بازگشتی |
| Return value |
int |
میزان اعتبار به ریال
|
نام متد sms_user_info :
برای دریافت اطلاعات کاربر موردنظر استفاده می گردد . مقداربازگشتی به صورت آرایه خواهد بود .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| پارامتر های بازگشتی |
| Return value |
int |
آرایه ای از اطلاعات کاربر
|
نام متد sms_deliver :
استعلام وضعیت پیامک با شناسه ارسال شده
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| smsid |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| پارامتر های بازگشتی |
| Return value |
int |
0 : ارسال شده به مخابرات
1 : رسیده به گوشی
2 : نرسیده به گوشی
3 : نرسیده به مخابرات
5 : لیست سیاه
6 : ارسال در آینده
8 : رسیده به مخابرات
9 : بازگشت هزینه به دلیل ترافیک مخابرات
|
نام متد sms_deliver_with_array_of_smsid :
جهت دریافت وضعیت پیامک ها به وسیله آرایه ای از smsid ها
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| smsid_arr |
array |
آرایه ای از smsid ها |
| Dargah |
String |
درگاه ارسال |
| پارامتر های بازگشتی |
| Return value |
array |
هر کدام از اندیس های آرایه مقادیر زیر را ممکن است شامل گردد :
0 : ارسال شده به مخابرات
1 : رسیده به گوشی
2 : نرسیده به گوشی
3 : نرسیده به مخابرات
5 : لیست سیاه
6 : ارسال در آینده
8 : رسیده به مخابرات
9 : بازگشت هزینه به دلیل ترافیک مخابرات
|
نام متد sms_add_number :
برای افزودن شماره جدید به دفتر تلفن کاربر استفاده می گردد .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| Number |
String |
شماره همراه شخص [اجباری] |
| fullname |
String |
نام کامل مربوط به شخص [اجباری] |
| catid |
int |
شناسه دسته بندی هدف که شخص در آن قرار خواهد گرفت .[اجباری] |
| gender |
String |
جنسیت شخص ( خانم / آقا ) |
| fullname_en |
String |
نام شخص به انگلیسی |
| gender_eng |
String |
جنسیت شخص به انگلیسی ( Mr/Miss) |
| پارامتر های بازگشتی |
| Return value |
String |
اگر خطا بدهد متن خطا را در یک String برمی گرداند وگرنه ok برمی گرداند.
|
نام متد sms_receive_list_array :
جهت دریافت پیامک های دریافتی
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| Number |
String |
شماره خط اختصاصی کاربر مورد استفاده در سامانه پیامک [اجباری] |
| catid |
int |
شناسه دسته بندی پیامک های دریافتی |
| start |
int |
شناسه شروع لیست پیامک ها |
| perpage |
int |
تعداد پیامک های دریافتی در هر صفحه |
| read |
int |
نشانه گذاری پیامک ها به صورت خوانده شده (0 خوانده نشده ، 1 خوانده شده ، 1- همه ) |
| پارامتر های بازگشتی |
| Return value |
array |
مقدار بازگشتی این متد آرایه ای از پیامک هاست که بعدهای این آرایه شامل موارد زیر می باشد :
Id
Send_number
Receive_number
Date
Catid
Note
|
نام متد sms_send_bulk_5000 :
برای ارسال پیامک به بانک تفکیک جنسیت و رده سنی همراه اول از طریق شماره های 5000 می باشد .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| username |
String |
نام کاربری مورد استفاده در سامانه پیامک [اجباری] |
| password |
String |
رمز عبور مورد استفاده در سامانه پیامک [اجباری] |
| sender_number |
String |
شماره ارسال کننده در سامانه پیامک [اجباری] |
| bankid |
String |
شماره بانک نهایی که از متد دیگری بدست می آید [اجباری] |
| note |
String |
متن پیامک [اجباری] |
| date |
int |
تاریخ ارسال پیامک ( مورد استفاده جهت پیامک های ارسال در آینده ) [اختیاری] |
| record_start |
String |
شماره رکورد شروع [اجباری] |
| receiver_number |
String |
تعداد دریافت کنندگان [اجباری] |
| gender |
String |
جنسیت |
| receiver_number_kind |
String |
دائمی یا اعتباری |
| age_start |
String |
شروع سن |
| age_end |
String |
پایان بازه ی سنی |
| receiver_number_prefix |
String |
پیش شماره موبایل تا 4 رقم مثل 9131 |
| request_uniqueid |
int |
شماره درخواست |
| پارامتر های بازگشتی |
| Return value |
String |
اگر خطا بدهد متن خطا را در یک String برمی گرداند وگرنه ok برمی گرداند.
|
نام متد sms_count_bulk_5000
برای مشخص کردن تعداد شماره های موجود در یک شهر با فیلترهای جنسیت ، سن ، دائمی یا اعتباری و پیش شماره می باشد .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| bankid |
String |
شماره بانک نهایی که از متد دیگری بدست می آید [اجباری] |
| gender |
String |
جنسیت |
| receiver_number_kind |
String |
دائمی یا اعتباری |
| age_start |
String |
شروع سن |
| age_end |
String |
پایان بازه ی سنی |
| receiver_number_prefix |
String |
پیش شماره موبایل تا 4 رقم مثل 9131 |
| پارامتر های بازگشتی |
| Return value |
String |
اگر ok بدهد در پارامتر number تعداد رابرمی گرداند اگر no باشد درپارامتر note متن پیغام خطا را برمی گرداند.
|
نام متد sms_count_bulk_5000
این متد برای برگرداندن نام شهرستان مقصد وبدست آوردن پارامتر bankid در 2 متد دیگر می باشد .
| پارامتر های ورودی |
| نام پارامتر |
نوع پارامتر |
توضیحات |
| parentid |
int |
مقدار 1 برای بانک تفکیک جنسیت ، 2 برای بانک تقسیمات کشوری دائمی ، 5 برای بانک کدپستی کشوری و id بدست آمده از اجرای همین متد برای بدست آوردن bankid. |
| پارامتر های بازگشتی |
| Return value |
String و array |
اگر ok ، state بود در بعد name از پارامتر bank نام استان را انتخاب و از بعد id همین پارامتر id استان را دوباره به عنوان parented به متد ارجاع داده و همین روال را برای انتخاب شهرستان طی می کنیم که در این مرحله id بدست آمده همان 2bankid متد دیگر می باشد.
|
