فیلم آمورشی ثبت نام
011-322 90 134 - 011-322 90 174       Info@Trez.Ir
ثبت نام رایگان در سامانه پیامک ترز   ورود به سامانه پیامک ترز

 

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

( SMS WebService /SMS API)


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

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

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

 

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

تلفن تماس: 011- 32290134


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


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

 

3- دانلود نمونه کد براي PHP

 

شروع كار با وب سرويس

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

نكته : خروجي هايي كه در "" قرار مي گيرند بدين معنا مي باشند كه مقدار بازگردانده شده از نوع string‌مي باشد.

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

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

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

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

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

معرفي متدها :

1-    متد SendMessage  :

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

نام متد

SendMessage  

ورودي

نام پارامترها

نوع پارامترها

توضيح

Username

String

نام كاربري كه در اختيار شما قرار گرفته است

Password

String

رمز عبوري كه در اختيار شما قرار گرفته است

SenderNumber

String

شماره فرستنده مثال : 9830006859123456

MessageBody

String

متن پيامك

ReciptionNumbers

Long[]

شماره موبايل هاي مقصد

Class

int

نوع پيام (معمولي و يا خبري) *

UserMessageId

Long[]

شناسه پيامك كاربر (اختياري)

خروجي

نوع پارامتر

توضيح

Long[]

آرايه اي از شناسه پيامك

 

* پارامتر Class

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

v      پيامك خبري : اگر مقدار اين پارامتر را 0 (صفر) قرار دهيد اين پيام در گوشي و سيم كارت شخص گيرنده بصورت اتوماتيك ذخيره نمي شود.

v       پيامك عادي : اگر مقدار اين پارامتر را 1 (يك) قرار دهيد اين پيام در گوشي و سيم كارت شخص گيرنده بصورت اتوماتيك ذخيره مي شود..

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

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

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

·         Result > 1000 : ارسال بدون خطا

·          0 ، 3 : خطا در ارسال

·         2 : ارسال موفق بدون ذخيره پيام در سايت

·         4 : اعتبار ناكافي

·         5 : بيش از 4 پيام (طول پيام از مجاز بيشتر است)

·         6 : اطلاعات كاربري شما دستكاري شده است

·         7 : تعداد پيام (گيرندگان) بيش از حد مجاز مي باشد

·         8 : اطلاعات كاربري نادرست مي باشد.

 

 

2-   متد GetReciveMessage  :

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

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

 

نام متد

GetReciveMessage

ورودي

نام پارامترها

نوع پارامترها

توضيح

Username

String

نام كاربري كه در اختيار شما قرار گرفته است

Password

String

رمز عبوري كه در اختيار شما قرار گرفته است

SenderNumber

String

شماره فرستنده مثال : 9830006859123456

خروجي

نوع پارامتر

توضيح

String

رشته اي از پيام هاي دريافتي

 

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

 

"1" : اطلاعات کاربري شما معتبر نمي باشد

"2": شما مجاز به دريافت پيامک نمي باشيد براي تهيه نسخه دريافت کننده با شرکت ترز رايان افزار تماس حاصل نماييد . نسخه فقط ارسال

"3": پيام جديدي وجود ندارد

در صورتي كه يكي از حالتها بالا نباشد

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

 

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

 

نمونه بالا شامل 2 پيام دريافتي مي باشد كه با $ از هم تفكيك مي شوند. و هر پيام شامل: متن پيام ، فرستنده ، گيرنده ، زمان دريافت پيامك مي باشد كه با از هم تفكيك مي شوند.

 

3-  متد GetCredit  :

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

نام متد

GetCredit

ورودي

نام پارامترها

نوع پارامترها

توضيح

Username

String

نام كاربري كه در اختيار شما قرار گرفته است

Password

String

رمز عبوري كه در اختيار شما قرار گرفته است

SenderNumber

String

شماره فرستنده مثال : 9830006859123456

خروجي

نوع پارامتر

توضيح

Long

مقدار موجودي حساب

مثال :

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

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

 

4-  متد GetMessageStatus  :

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

نام متد

GetMessageStatus

ورودي

نام پارامترها

نوع پارامترها

توضيح

Username

String

نام كاربري كه در اختيار شما قرار گرفته است

Password

String

رمز عبوري كه در اختيار شما قرار گرفته است

SenderNumber

String

شماره فرستنده مثال : 9830006859123456

MessageId

Long[]

شناسه پيامك هاي ارسالي كه هنگام ارسال دريافت شد.

خروجي

نوع پارامتر

توضيح

Int[]

آرايه اي از وضعيت پيام ها

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

·         1 : رسيده به گوشي

·         2 : نرسيده به گوشي

·         8 : رسيده به مخابرات

·         16 : نرسيده به مخابرات

·         0 : وضعيتي دريافت نشد

·         -1 : شناسه ارسال شده اشتباه است

 

5-  متد SendSchaduleMessage  :

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

نام متد

SendSchaduleMessage  

ورودي

نام پارامترها

نوع پارامترها

توضيح

Username

String

نام كاربري كه در اختيار شما قرار گرفته است

Password

String

رمز عبوري كه در اختيار شما قرار گرفته است

SenderNumber

String

شماره فرستنده مثال : 9830006859123456

MessageBody

String

متن پيامك

ReciptionNumbers

Long[]

شماره موبايل هاي مقصد

SendDate

DateTime

زمان ارسال پيامك

Class

int

نوع پيام (معمولي و يا خبري)

خروجي

نوع پارامتر

توضيح

string

رشته اي به عنوان نتيجه ارسال پيامك زما نبندي

 

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

·         "1" : ارسال بدون خطا

·         "2" : ارسال بدون خطا بدون ذخيره شدن در سايت

·         "3" : خطاي كلي

·         "4" : اعتبار ناكافي

·         "5" : بيش از 4 پيام (طول پيام از مجاز بيشتر است)

·         "6" : اطلاعات كاربري شما دستكاري شده است

·         "7" : تعداد پيام (گيرندگان) بيش از حد مجاز مي باشد

·         "8" : اطلاعات كاربري نادرست مي باشد.

6-  متد SendCourseMessage  :

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

نام متد

SendCourseMessage  

ورودي

نام پارامترها

نوع پارامترها

توضيح

Username

String

نام كاربري كه در اختيار شما قرار گرفته است

Password

String

رمز عبوري كه در اختيار شما قرار گرفته است

SenderNumber

String

شماره فرستنده مثال : 9830006859123456

Topic

String

عنوان پيامك

MessageBody

String

متن پيامك

ReciptionNumbers

Long[]

شماره موبايل هاي مقصد

StartDate

DateTime

تاريخ شروع ارسال پيامك دوره اي

EndDate

DateTime

تاريخ پايان ارسال پيامك دوره اي

Period

Int

فاصله زماني ارسال پيامك

Class

int

نوع پيام (معمولي و يا خبري)

خروجي

نوع پارامتر

توضيح

string

رشته اي به عنوان نتيجه ارسال پيامك زما نبندي

 

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

·         "1" : ارسال بدون خطا

·         "2" : ارسال بدون خطا بدون ذخيره شدن در سايت

·         "3" : خطاي كلي

·         "4" : اعتبار ناكافي

·         "5" : بيش از 4 پيام (طول پيام از مجاز بيشتر است)

·         "6" : اطلاعات كاربري شما دستكاري شده است

·         "7" : تعداد پيام (گيرندگان) بيش از حد مجاز مي باشد

·         "8" : اطلاعات كاربري نادرست مي باشد.