سرویس API

راهنمای استفاده از وب سرویس

مقدمه

این مستند بعنوان راهنمای استفاده از سرویس وب پیام کوتاه  می باشد و مخاطب آن برنامه نویسانی هستند که آشنا به مفاهیم تکنولوژی SOAP بوده و نحوه ایجاد یک SOAP Client را با زبانی که مسلط به آن هستند بدانند. البته مثالهای کاربردی با زبان PHP در انتهای مستند ارائه شده است. فناوران اطلاعات البرز خود را موظف به ارائه صحیح سرویس وب می داند و هیچ تعهدی برای نصب، پیکربندی و راه اندازی SOAP Client بر روی سرویس دهنده های دیگر ندارد و در صورت نیاز مشتری طبق قرارداد جداگانه قابل انجام است.

آدرس سرویس وب

با مراجعه به آدرس   api.it-a.ir شرح مختصری در مورد عملیات پشتیبانی شده توسط سرویس وب پیام کوتاه  و نوع پارامترهای ورودی و خروجی آنها مشاهده می کنید.

آدرس WSDL سرویس وب پیام کوتاه: http://api.it-a.ir/index.php?wsdl

پیش نیازها

  1. فعال سازی وب سرویس روی شماره خط اختصاصی و تنطیم نام کاربری و کلمه عبور
  2. اطمینان از باز بودن پورت ۸۰
  3. اطمینان از باز بودن Socket ها و فعال بودن توابع curl   روی هاست
  4. خاموش بودن   Firewall

نحوه استفاده از توابع Web Service

متد sendsms

برای ارسال sms تکی می توان از این متد استفاده نمود.پارامترهای مربوط به sendsms که در جدول ذیل آوره شده اند ، به عنوان ورودی به متد ارسال می گردند.

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

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

 

نام پارامترنوعتوضیح
usernamestringنام کاربری برای وصل شدن به وب سرویس
passwordstring/numberکلمه عبور برای وصل شدن به وب سرویس
recivernumberشماره دریافت کننده پیامک بدون صفر مانند 912xxxxxxx
texttext/numberمتن پیام
sendernumberشماره ارسال کننده پیام کوتاه