مستندات وب سرویس

وب سرویس برای  ﺁﻥ ﺩﺳﺘﻪ ﺍﺯ ﺑﺮﻧﺎﻣﻪ ﻧﻮﻳﺴﺎﻧﻲ ﻃﺮﺍﺣﻲ ﺷﺪﻩ ﺍﺳﺖ ﻛﻪ ﻣﻲ ﺧﻮﺍﻫﻨﺪ ﺑﺎ ﺍﺳﺘﻔﺎﺩﻩ ﺍﺯ ﻧﺮﻡ افزار ﺁﻣﺎﺩﻩ ﺧﻮﺩ ﺑﺮ ﺭﻭﻱ ﺑﺴﺘﺮ ﺳﻴﺴﺘﻤﻬﺎﻱ ﭘﻴﺎﻡ ﺩﻫﻲ سهندسامانه، ﺑﻪ ﺍﺭﺳﺎﻝ ﻭ ﺩﺭﻳﺎﻓﺖ ﭘﻴﺎﻣﻚ ﺑﭙﺮﺩﺍﺯﻧﺪ.این سرویس امکان ارسال پیامک  با استفاده از وب سرویس های شرکت سهند سامانه را دراختیار کاربران قرار میدهد.

متدSendQueue  : این متد جهت ارسال یک پیامک به یک یا چندین دریافت کننده به کار می رود . این متد به صورت غیر مستقیم  و توسط سرور شرکت عمل می نماید.

نام پارامتر نوع پارامتر توضیح
UserName String نام کاربری حساب در سیستم سهند سامانه
Password String رمز عبور حساب در سیستم سهند سامانه
Message String رشته ای که متن پیامک در آن قرار میگیرد
FromNumber String خط ارسال کننده پیامک
toNumber Array Of String شماره گیرندگان در این پارامتر قرار میگیرد
پارامتر خروجی
Array Of String کد پیامک ارسال شده ویا کد خطا

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

متد GetQueueMessageStatus این متد جهت اطلاع از وضعیت پیامک های ارسالی به صورت غیر مستقیم  و توسط متد SendQueue و ArraySendQeue از طریق سرور شرکت ارسال شده است.

نام پارامتر نوع پارامتر توضیح
UserName String نام کاربری حساب در سیستم سهند سامانه
Password String رمز عبور حساب در سیستم سهند سامانه
MessageIds Array Of Long Integer شناسه پیام که در اصل مقدار بازگشتی متد Send برای پیام‌های مورد نظر می‌باشد
پارامتر خروجی
Integer Array Of وضعیت پیام ها تا این لحظه ویا کد خطا

متد GetUserCredit: این متد برای گرفتن اعتبار باقیمانده توسط کاربر است مقدار برگشتی آن از نوع عدد صحیح می باشد.

متد RecieveSMS: این متد برای دریافت پیامک های است که از طرف مخاطبین به شماره خط ارسال می گردد. در واقع پس از ارسال پیامک توسط مخاطبین پیامک توسط سرویس های این شرکت دریافت گردید و شما با استفاده از این متد
می توانید پیامک های خود را استخراج نمائید. در واقع برای هر بار استفاده از این متد می بایست بازه زمانی مورد نظر خود را که قصد دریافت پیامک های آن را دارید در پارامترهای ورودی این متد منظور نمائید. مقدار برگشتی این متد یک DataTable حاوی اطلاعات مربوط به پیامک دریافتی می باشد.

متد GetUnreadMessagese  :

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

 

 

متد SendFormUrl  : این متد جهت ارسال پیامک  توسط url به کار می رود. نکته اینکه، لیست شماره موبایل های دریافت کننده پیامک می بایست توسط “,” جدا شده باشند و به پارامتر toNumber پاس داده شوند. این متد به صورت غیر مستقیم  و توسط سرور شرکت عمل می نماید. دقت کنید آرایه ای که بعنوان خروجی ارسال میگرد باید تعداد خانهای آرایه برابر با تعداد شماره باشد و عدد نباشد در غیر اینصورت ارسال با خطا صورت گرفته است.

مثال : در این مثال  از جاوا اسکریپت استفاده شده است :

<script type=”text/javascript”>

 

function send_with_ajax(the_url) {

var UserName = ‘username’;

        var Password = ‘password’;

        var Message = ‘TestMessage’;

        var FromNum = ‘3000xxxxxxxx’;

        var ToNums = ‘0919xxxxxxx’;

        var url = ” http://webservice.sahandsms.com/NewSmsWebservice.asmx/SendFromUrl?username=” + UserName + “&password=” + Password + “&message=” + encodeURIComponent(Message) + “&fromNumber=” + FromNum + “&toNumber=” + ToNums;

        var httpRequest = new XMLHttpRequest();

        var SendCount = 1;

        httpRequest.onreadystatechange = function () { if (httpRequest.readyState == 4) { if (httpRequest.responseXML.text.split(” “).length == SendCount) alert(‘ارسال با موفقیت انجام شد’); } };

        httpRequest.open(“GET”, url, true);

        httpRequest.send(null);

    }

        }

</script>

متد Send: این متد جهت ارسال یک پیامک به یک یا چندین دریافت کننده به کار می رود .این متد بطور مستقیم از وب سرویس مگفا 3000 استفاده میکند و دارای محدودیت ارسال پیامک (80 ارسال در هر مرتبه) میباشد.لازم به ذکر است که این متد به دلیل ارتباط مستقیم با وب سرویس شرکت مگفا برای خطوط سایر اپراتورها قابل استفاده نیست

ملاحظات لازم در ارتباط با متدها:

  1. ترتیب پارامترها دارای اهمیت است و جابه جایی مجاز نمی باشد.
  2. تمامی پارامتر ها می بایست به متد ارسال شود و در صورت عدم نیاز به یکی از آنها با مقداردهی اولیه آنها را به متد ارسال کنید.
  3. در بالک نظیر به نظیر می بایست ملاحظات لازم در مورد طول آرایه ها که در بخش های قبلی بیان گردید مدنظر قرار گیرد.

آدرس وب‌سرویس

اگر از پنل sahandsms استفاده میکنید:

http://webservice.sahandsms.com/NewSMSWebService.asmx

اگر از پنل smsshora استفاده میکنید:

http://webservice.smsshora.ir/NewSMSWebService.asmx

فهرست