Blog

وب سرویس ارسال و دریافت پیامک ترز ( ویژه برنامه نویسان )

توسط در وب سرویس ۵ شهریور ۱۳۹۸

وب سرویس ارسال و دریافت پیامک ترز ( ویژه برنامه نویسان )

( SMS WebService /SMS API)

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

با استفاده از این وب سرویس با امکانات فوق العاده قابلیت ارسال پیامک ، دریافت، زمانبندی بدون نیاز به سیستم  و …. می باشد که توسط شرکت جهت سهولت کار کاربران در نظر گرفته شده است.

لازم به ذکر است وب سرویس حاضر برای برنامه نویسان بصورت کاملا رایگان بوده و نیاز به هیچ هزینه ای نخواهد بود

در صورت نیاز به مشاوره در امور برنامه نویسی و وب سرویس می توانید با کارشناسان پشتیبانی شرکت در تماس باشید

تلفن تماس: ۰۱۱- ۳۲۲۹۰۱۳۴

۱- دانلود راهنمای استفاده از وب سرویس ( SMS WebService /SMS API)  ارسال و دریافت پیامک

۲- دانلود نمونه کد ( Sample Source Code For SMS ) وب سرویس سامانه پیامک برای ASP .NET

۳- دانلود نمونه کد برای PHP

شروع کار با وب سرویس

وب سرویس از یک سری متد تشکیل شده است که هر یک به منظوری خاص (ارسال پیامک ، دریافت پیامک ، دریافت وضعیت پیامک ، …..) طراحی شده است. برای استفده از وب سرویس کافی است یکی از متد های مورد نظر را انتخاب و پارامترهای مورد نظر را ست کنید.

نکته : خروجی هایی که در “” قرار می گیرند بدین معنا می باشند که مقدار بازگردانده شده از نوع string‌می باشد.

افزودن متد ها به برنامه :

برای فراخوانی متدهای وب سرویس ابتدا در قسمت Add Reference  ادرس زیر را وارد کنید .

http://Sms.trez.ir/TrezSmsService.asmx

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

  1. GetCredit
  2. GetMessageStatus
  3. GetReciveMessage
  4. SendCourseMessage
  5. SendMessage
  6. SendSchaduleMessage

معرفی متدها :

۱-    متد SendMessage  :

این متد برای ارسال پیامک می باشد .پارامترهای مورد نیاز این متد در جدول زیر آورده شده است. مقدار بازگشتی این متد آرایه ای از اعداد صحیح می باشد که به منظور دریافت وضعیت پیام مورد استفاده قرار می گیرد. در صورتی که ارسال پیامک موفقیت آمیز باشد به ازای هر پیامک یک شناسه پیام (MessageId)  و در صورت بروز خطا کد خطا در خروجی قرار می گیرد.

نام متد SendMessage
ورودی
نام پارامترها نوع پارامترها توضیح
Username String نام کاربری که در اختیار شما قرار گرفته است
Password String رمز عبوری که در اختیار شما قرار گرفته است
SenderNumber String شماره فرستنده مثال : ۹۸۳۰۰۰۶۸۵۹۱۲۳۴۵۶
MessageBody String متن پیامک
ReciptionNumbers Long[] شماره موبایل های مقصد
Class int نوع پیام (معمولی و یا خبری) *
UserMessageId Long[] شناسه پیامک کاربر (اختیاری)
خروجی
نوع پارامتر توضیح
Long[] آرایه ای از شناسه پیامک

* پارامتر Class

با تنظیم این پارامتر می توانید نوع پیام و نحوه نمایش پیامک ارسالی بر روی گوشی گیرنده را تنظیم نمایید

v      پیامک خبری : اگر مقدار این پارامتر را ۰ (صفر) قرار دهید این پیام در گوشی و سیم کارت شخص گیرنده بصورت اتوماتیک ذخیره نمی شود.

v       پیامک عادی : اگر مقدار این پارامتر را ۱ (یک) قرار دهید این پیام در گوشی و سیم کارت شخص گیرنده بصورت اتوماتیک ذخیره می شود..

برای مشخص کردن خروجی اولین مقدار آرایه را گرفته و بررسی نمایید.

مثال :   long result = MessageId[0];

مقدار خروجی متد بصورت زیر می باشد.

  • Result > 1000 : ارسال بدون خطا
  •  ۰ ، ۳ : خطا در ارسال
  • ۲ : ارسال موفق بدون ذخیره پیام در سایت
  • ۴ : اعتبار ناکافی
  • ۵ : بیش از ۴ پیام (طول پیام از مجاز بیشتر است)
  • ۶ : اطلاعات کاربری شما دستکاری شده است
  • ۷ : تعداد پیام (گیرندگان) بیش از حد مجاز می باشد
  • ۸ : اطلاعات کاربری نادرست می باشد.

۲-   متد GetReciveMessage  :

این متد برای دریافت پیامک می باشد .پارامترهای مورد نیاز این متد در جدول زیر آورده شده است. مقدار بازگشتی این متد یک رشته (string) می باشد که به منظور دریافت پیامکی که برای شماره اختصاصی شما ارسال شده است مورد استفاده قرار می گیرد

نکته : این رشته ممکن است شامل چند پیامک دریافتی باشد.

نام متد GetReciveMessage
ورودی
نام پارامترها نوع پارامترها توضیح
Username String نام کاربری که در اختیار شما قرار گرفته است
Password String رمز عبوری که در اختیار شما قرار گرفته است
SenderNumber String شماره فرستنده مثال : ۹۸۳۰۰۰۶۸۵۹۱۲۳۴۵۶
خروجی
نوع پارامتر توضیح
String رشته ای از پیام های دریافتی

خروجی متد GetReciveMessage می تواند یکی از حالت های زیر باشد

“۱” : اطلاعات کاربری شما معتبر نمی باشد

“۲”: شما مجاز به دریافت پیامک نمی باشید برای تهیه نسخه دریافت کننده با شرکت ترزرایان افزار تماس حاصل نمایید . نسخه فقط ارسال

“۳”: پیام جدیدی وجود ندارد

در صورتی که یکی از حالتها بالا نباشد

مطابق مثال زیر می باشد

MessageBody-From-To- ReciveDate$MessageBody-From-To-rec.ReciveDate$

 

نمونه بالا شامل ۲ پیام دریافتی می باشد که با $ از هم تفکیک می شوند. و هر پیام شامل: متن پیام ، فرستنده ، گیرنده ، زمان دریافت پیامک می باشد که با – از هم تفکیک می شوند.

۳-  متد GetCredit  :

این متد برای دریافت میزان اعتبار کاربر می باشد .پارامترهای مورد نیاز این متد در جدول زیر آورده شده است. مقدار بازگشتی این متد یک مقدار صحیح می باشد

نام متد GetCredit
ورودی
نام پارامترها نوع پارامترها توضیح
Username String نام کاربری که در اختیار شما قرار گرفته است
Password String رمز عبوری که در اختیار شما قرار گرفته است
SenderNumber String شماره فرستنده مثال : ۹۸۳۰۰۰۶۸۵۹۱۲۳۴۵۶
خروجی
نوع پارامتر توضیح
Long مقدار موجودی حساب

مثال :

ir.trez.sms.TrezSmsWebService getcredit = newir.trez.sms.TrezSmsWebService();

long credit = getcredit.GetCredit(UserName, PassWord, Number);

۴-  متد GetMessageStatus  :

این متد برای دریافت وضعیت پیامک ها می باشد .پارامترهای مورد نیاز این متد در جدول زیر آورده شده است. مقدار بازگشتی این متد یک مقدار صحیح می باشد

نام متد GetMessageStatus
ورودی
نام پارامترها نوع پارامترها توضیح
Username String نام کاربری که در اختیار شما قرار گرفته است
Password String رمز عبوری که در اختیار شما قرار گرفته است
SenderNumber String شماره فرستنده مثال : ۹۸۳۰۰۰۶۸۵۹۱۲۳۴۵۶
MessageId Long[] شناسه پیامک های ارسالی که هنگام ارسال دریافت شد.
خروجی
نوع پارامتر توضیح
Int[] آرایه ای از وضعیت پیام ها

مقدار خروجی متد بصورت زیر می باشد.

  • ۱ : رسیده به گوشی
  • ۲ : نرسیده به گوشی
  • ۸ : رسیده به مخابرات
  • ۱۶ : نرسیده به مخابرات
  • ۰ : وضعیتی دریافت نشد
  • -۱ : شناسه ارسال شده اشتباه است

۵-  متد SendSchaduleMessage  :

این متد برای ارسال پیامک در زمان خاص می باشد .پارامترهای مورد نیاز این متد در جدول زیر آورده شده است. مقدار بازگشتی این متد آرایه ای از اعداد صحیح می باشد که به منظور دریافت وضعیت پیام مورد استفاده قرار می گیرد. در صورتی که ارسال پیامک موفقیت آمیز باشد به ازای هر پیامک یک شناسه پیام (MessageId)  و در صورت بروز خطا کد خطا در خروجی قرار می گیرد.

نام متد SendSchaduleMessage
ورودی
نام پارامترها نوع پارامترها توضیح
Username String نام کاربری که در اختیار شما قرار گرفته است
Password String رمز عبوری که در اختیار شما قرار گرفته است
SenderNumber String شماره فرستنده مثال : ۹۸۳۰۰۰۶۸۵۹۱۲۳۴۵۶
MessageBody String متن پیامک
ReciptionNumbers Long[] شماره موبایل های مقصد
SendDate DateTime زمان ارسال پیامک
Class int نوع پیام (معمولی و یا خبری)
خروجی
نوع پارامتر توضیح
string رشته ای به عنوان نتیجه ارسال پیامک زما نبندی

مقدار خروجی متد بصورت زیر می باشد.

  • “۱” : ارسال بدون خطا
  • “۲” : ارسال بدون خطا بدون ذخیره شدن در سایت
  • “۳” : خطای کلی
  • “۴” : اعتبار ناکافی
  • “۵” : بیش از ۴ پیام (طول پیام از مجاز بیشتر است)
  • “۶” : اطلاعات کاربری شما دستکاری شده است
  • “۷” : تعداد پیام (گیرندگان) بیش از حد مجاز می باشد
  • “۸” : اطلاعات کاربری نادرست می باشد.

۶-  متد SendCourseMessage  :

این متد برای ارسال پیامک در زمان خاص می باشد .پارامترهای مورد نیاز این متد در جدول زیر آورده شده است. مقدار بازگشتی این متد آرایه ای از اعداد صحیح می باشد که به منظور دریافت وضعیت پیام مورد استفاده قرار می گیرد. در صورتی که ارسال پیامک موفقیت آمیز باشد به ازای هر پیامک یک شناسه پیام (MessageId)  و در صورت بروز خطا کد خطا در خروجی قرار می گیرد.

نام متد SendCourseMessage
ورودی
نام پارامترها نوع پارامترها توضیح
Username String نام کاربری که در اختیار شما قرار گرفته است
Password String رمز عبوری که در اختیار شما قرار گرفته است
SenderNumber String شماره فرستنده مثال : ۹۸۳۰۰۰۶۸۵۹۱۲۳۴۵۶
Topic String عنوان پیامک
MessageBody String متن پیامک
ReciptionNumbers Long[] شماره موبایل های مقصد
StartDate DateTime تاریخ شروع ارسال پیامک دوره ای
EndDate DateTime تاریخ پایان ارسال پیامک دوره ای
Period Int فاصله زمانی ارسال پیامک
Class int نوع پیام (معمولی و یا خبری)
خروجی
نوع پارامتر توضیح
string رشته ای به عنوان نتیجه ارسال پیامک زما نبندی

مقدار خروجی متد بصورت زیر می باشد.

  • “۱” : ارسال بدون خطا
  • “۲” : ارسال بدون خطا بدون ذخیره شدن در سایت
  • “۳” : خطای کلی
  • “۴” : اعتبار ناکافی
  • “۵” : بیش از ۴ پیام (طول پیام از مجاز بیشتر است)
  • “۶” : اطلاعات کاربری شما دستکاری شده است
  • “۷” : تعداد پیام (گیرندگان) بیش از حد مجاز می باشد
  • “۸” : اطلاعات کاربری نادرست می باشد.

 

مشاوره شما افتخار❤️ماست

برای دریافت ازاطلاعات بیشتر و یا راهنمایی بابت ثبت نام می توانید با شماره ۰۱۱۳۲۲۹۰۱۳۴ تماس حاصل نمایید.

دیدگاه خود را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *