وب سرویس چیست

• | پرينت |

نسخه جدید API وب سرویس ویژه استفاده برنامه نویسان

این روش از روشهای پیشرفته در انتقال پیامک به شمار می رود . این متد، ارسال و دریافت پیامک های فارسی ، لاتین و باینری با اندازه های متفاوت را دارا می باشد . برای برقراری ارتباط با API   می توانید از دو پروتکل HTTP بر روی پورت 80 ، و یا استفاده از پروتکل امن HTTPS   بر روی پورت 443 استفاده نمایید. با استفاده از این امکان شما قادر خواهید بود در سایت و یا نرم افزار خود از طریق ارتباط با سرورهای پیام کوتاه، پیامک با تنظیمات دلخواه خود ارسال نمایید .

برخی از امکانات به کار رفته در نسخه جدید در زیر آمده است :

1-      ارسال پیامک تکی

2-      ارسال پیامک گروهی

3-      ارسال پیامک تکی در آینده

4-      ارسال پیامک گروهی در آینده

5-      ارسال اس ام اس به صورت منطقه ای از طریق کد پستی

6-      ارسال اس ام اس به شماره های فعال شهر و یا استان مورد نظر خود

7-      ارسال اس ام اس به شماره های فعال پیش شماره دلخواه

8-      دریافت پیامک به صورت تکی

9-      دریافت پیامک به صورت بازه ای

10-   دریاف پیامک های نخوانده شده

11-   آگاهی از تعداد پیام های دریافتی

12-   آگاه از تعداد پیام های ارسالی

13-   آگاهی از وضعیت پیام های ارسالی (Delivery)

14-   مشاهده وضعیت پیامک های ارسالی در آینده

15-   دریافت موجودی پنل پیام کوتاه

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

شروع کار

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

 گام اول – ایجاد یک حساب کاربری

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

پس از فعال شدن حساب کاربری ، شما یک نام کاربری (username) و کلمه عبور (password) و نام دامنه (domain) و یک یا چند شماره خواهید داشت  . هم اکنون با در اختیار داشتن اطلاعات ذکر شده شما می توانید به صفحه اختصاصی خود در سایت با آدرس فوق وارد شوید.

 گام دوم – شروع به کار با سرویس SOAP

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

API وب سرویس ارسال اس ام اس

• | پرينت |

متد SendSms :برای ارسال پیامک باید از این متد استفاده نمود . پارامترهای مربوط به این متد در جدول ذیل آورده شده اند. مقدار بازگشتی این متد رشته ای است که مقادیر آن نشانگر شرایط پیامک می باشد. بدین ترتیب که اگر پارامترها صحیح باشند و پیامک به صورت موفقیت آمیز در سیستم پیام دهی قرار می گیرد به ازای هر پیامک به صورت موفقیت آمیز در سیستم پیام دهی قرار گیرد به ازای هر پیامک یک شناسه پیام (SmsId) و در غیر اینصورت کد خطای مربوطه در خروجی قرار می گیرد .

توجه: لیست انواع خطاها و توضیحات مربوط به هر کدام در انتهای این راهنما آورده شده است :

درهنگام ست کردن پارامتر متن به نکات زیر توجه فرمایید :

به طور کلی طول استاندارد هر پیامک 140 بایت است . در نتیجه طول استاندارد یک پیامک فارسی 70 کاراکتر (هر کاراکتر برابر 2 بایت است )، اندازه استاندارد پیامک باینری 140 بایت و طول استاندارد یک پیامک لاتین 160کاراکتر (160کاراکتر 7 برابر 2 بیتی) می باشد. باید به این نکته توجه داشته باشید که حتی وجود یک کاراکتر فارسی در پیامک باعث تغییر رمز نگاری آن پیامک شده و در نتیجه پیامک به طور کلی فارسی محاسبه می شود و طول آن بر اساس طول پیامک فارسی (70کاراکتر)در نظر گرفته خواهد شد.

جهت ایجاد سهولت برای مشترکین امکان ارسال پیامک های بزرگتر از طول استاندارد فراهم گشته است و مشترکین می توانند بدون نیاز به شکستن متن های طولانی،آن ها را به صورت یکپارچه ارسال نمایند.فقط در هنگام استفاده باید توجه داشته باشید که به ازای هر بخش از یک پیامک فارسی طولانی،3 کاراکتر و به ازای هر بخش از یک پیامک لاتین طولانی،7 کاراکتر از فضای استاندارد متن پیامک به کد UDH اختصاصی پیدا می کند. یعنی در واقع هر بخش از پیامک چند قسمتی فارسی حداکثر 67 کاراکتر و هر بخش از پیامک چند قسمتی لاتین حداکثر 153 کاراکتر را در خود جای می دهد.

 1. شماره گیرنده یا شماره موبایل که باید به طور مثال به صورت زیر در متد تعریف شوند: 0912XXXXXXXX

2. شماره فرستنده در هنگام ارسال می تواند به صورت زیر در متد تعریف شود: 3000XXXX

 توضیح :برای ارسال پیامک هایی که طول آنها از طول استاندارد بیشتر است ، سیستم به صورت خودکار پیامک را به تعداد بخش لازم تقسیم کرده و ارسال می نماید. لازم به توضیح است که میزان اعتبار کسر شده ز کاربر بر اساس تعداد بخش های متن پیام می باشد.

 3. با تنظیم پارامتر SmsMode می توان نحوه دریافت و نمایش پیامک ارسالی بر روی گوشی گیرنده را به دلخواه تغییر داد، مقادیر قابل قبول برای این پارامتر سه مقدار Alert,SaveInPhone,SaveInSim می باشد.

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

SaveInPhone : پیامک در حافظه موبایل شخص گیرنده ذخیره می شود(پیامک عادی )

 SaveInSim : پیامک بر روی حافظه سیم کارت شخص گیرنده ذخیره می شود.

 چند نکته مهم:

 طول استاندارد پیامک:سایز استاندارد پیامک 140بایت می باشد. در صورتیکه در متن پیامک از کاراکترهای Adphanumeric استفاده شود طول یک پیامک حداکثر می تواند 160 کاراکتر و در صورتی که از Unicode دوبایتی (کاراکترهای فارسی ) استفاده شود طول یک پیامک حداکثر 70 کاراکتر می تواند باشد.

 انواع حالتهای ممکن ارسال پیامک از طریق متد SendSms :

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

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

API وب سرویس دریافت اس ام اس

• | پرينت |

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

متد GetReceiveSMS : روش کار این متد مشابه متد فوق (GetReceiveSMSWithNumber) است با این تفاوت که در این متد ، کاربر(درصورت داشتن چندین شماره اختصاصی) می تواند پیام های همه خطوط را دریافت نماید.

API وب سرویس ارسال اس ام اس در آینده

• | پرينت |

متد  SendFutureSms: با استفاده از این تابع کاربر می تواند در تاریخ و زمان خاصی اقدام به ارسال پیامک نماید.خروجی این تابع  یک عدد است که در واقع شناسه این پیامک است که با ارسال آن به تابع CheckSendFuture می توان از وضعیت ارسال پیامک اطلاع حاصل کرد. مقادیر منفی خروجی تابع،نشان دهنده شماره خطای رخ داده است.

API مشاهده وضعیت پیامک های ارسالی در آینده

• | پرينت |

متد  CheckSendFuture: با ارسال شناسه پیامک از وضعیت ارسال آن مطلع می شویم.شناسه پیامک، خروجی تابع  SendFutureSmsاست.خروجی این تابع  یک رشته است که نشان دهنده وضعیت پیامک ارسالی است.

API مشاهده پیام های دریافتی شماره ای خاص

• | پرينت |

متد GetReceiveSMSWithNumber : با استفاده از این متد کاربر می تواند پیامهای ورودی خود  را دریافت نماید. مقادیر ارسالی به این متد شامل نوع فراخوانی ، شماره اختصاصی گیرنده، تعداد پیام ها،تاریخ شروع و تاریخ پایان است.درصورت انتخاب نوع فراخوانی All  از مقدار تعریف شده  ReceiveType  ، نیازی به پرکردن مقادیر اختیاری نیست و خروجی تابع شامل کل پیامک های دریافتی می باشد. با انتخاب نوع فراخوانی Top و با وارد کردن مقدار Count  تعداد مشخصی از پیام ها از  ابتدا به صورت صعودی دریافت میشود.در این نوع فراخوانی مقدار  Count  به طور پیش فرض یک در نظر گرفته میشود. نوع فراخوانی Down مشابه فراخوانی Topاست با این تفاوت که تعداد مشخصی از پیام ها را از آخر دریافت میکند.در صورت انتخاب نوع فراخوانی     WithDate می توان پیام های دریافتی را برحسب تاریخ شروع و پایان به دست آورد.

توضیح: نوع خروجی ReceiveSms  شامل :

ReceiveNumber : شماره گیرنده

SmsText : متن پیامک

Date  : تاریخ ارسال

FromNumber : شماره ارسال کننده

Error  : شماره خطا

مشاهده تعداد کل پیام های دریافتی

• | پرينت |

 متد   GetCountAll : با فراخوانی این تابع کاربر می تواند تعداد کل پیامک های دریافتی از تمام شماره های  اختصاصی خود را دریافت نماید.

مشاهده تعداد پیام های دریافتی شماره ای خاص

• | پرينت |

متد  GetCount: با فراخوانی این تابع کاربر با وارد نمودن یک شماره اختصاصی می تواند تعداد کل پیامک های دریافتی از آن شماره  را دریافت نماید.

مشاهده مانده اعتبار پنل اس ام اس

• | پرينت |

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

مشاهده وضعیت پیامک های ارسالی API

• | پرينت |

متد GetDelivery: این متد برای گرفتن وضعیت واقعی پیامکهای ارسال شده توسط کاربر مورد استفاده قرار می گیرد. مقدار بازگشتی این متد یک مقدار صحیح شامل یکی از اعداد 1و2و8و0و16 و در غیر اینصورت عدد خروجی نشاندهنده نوع خطای صورت گرفته می باشد.

مقادیر خروجی این متد به صورت زیر می باشد:

1:رسیده به گوشی

2:نرسیده به گوشی

8:رسیده به مخابرات

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

0:وضعیتی دریافت نشده است (یا پیامک در صف ارسال قرار دارد.).

توضیح:شناسه پیامک از روش زیر به دست می آید:پس از اجرای دستور SendSms و درصورتیکه درخواست ارسال پیامک به صورت صحیح ارسال شود شناسه پیامک در خروجی این متد ظاهر خواهد شد.

ارسال و دریافت پیامک از طریق آدرس

• | پرينت |

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

آدرس صفحه: http://tourismsms.ir/sendSmsViaURL.aspx

مثال:

 http://tourismsms.ir/sendSmsViaURL.aspx?userName=myUserName&;;;password=myPassword&domainName=mydomain&smsText=myText&reciverNumber=myMobileNumber&senderNumber=mySenderNumber

دریافت پیامک از طریق آدرس

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