وب سرویس و API

معرفی وب سرویس های رستاک

وب‌سرویس پیامک رستاک اس‌ام‌اس

ارسال پیامک، پیگیری وضعیت تحویل و مدیریت مخاطبان، مستقیم از نرم‌افزار شما

با وب‌سرویس رستاک اس‌ام‌اس می‌توانید سایت، فروشگاه اینترنتی یا نرم‌افزار سازمانی خود را به پنل پیامکی رستاک متصل کنید. برای مثال، بعد از ثبت سفارش پیام تأیید بفرستید، پیش از موعد نوبت یادآوری کنید یا وضعیت تحویل پیام را در همان نرم‌افزار بررسی کنید؛ بدون اینکه برای هر ارسال وارد پنل شوید.

ورود به پنل رستاک اس‌ام‌اس

با وب‌سرویس رستاک چه کارهایی می‌توانید انجام دهید؟

  • ارسال یک پیام به چند گیرنده: یک متن مشترک، مثل اطلاعیه تغییر ساعت کاری، برای فهرستی از شماره‌ها ارسال کنید.
  • ارسال پیام‌های شخصی‌سازی‌شده: در یک درخواست، برای هر گیرنده متن جداگانه بفرستید؛ مثلاً شماره سفارش یا زمان نوبت مخصوص همان مشتری.
  • استعلام وضعیت تحویل: در صورت موفقیت درخواست ارسال، شناسه پیامک را ذخیره کنید و بعداً با همان شناسه وضعیت تحویل را بگیرید. دریافت شناسه ارسال به‌معنای رسیدن پیامک به گوشی نیست.
  • مشاهده اعتبار پنل: اعتبار حساب را از داخل نرم‌افزار خود استعلام کنید.
  • مدیریت دفترچه تلفن: دفترچه بسازید، شماره‌ها را اضافه یا حذف کنید و فهرست مخاطبان هر دفترچه را بگیرید.
  • ثبت‌نام کاربر: نمایندگان می‌توانند با توجه به دسترسی و بسته‌های مجاز، فرایند ثبت‌نام کاربران را به سایت خود متصل کنند.

روش‌های اتصال به وب‌سرویس

۱. وب‌سرویس URL

اگر می‌خواهید از سمت سرور با درخواست HTTP به رستاک متصل شوید، از وب‌سرویس URL استفاده کنید. این سرویس درخواست‌های GET و POST را می‌پذیرد. پارامتر method عملیات را مشخص می‌کند و پارامتر format قالب پاسخ را: json، xml یا html.

نشانی سرویس:
http://212.33.201.227/webservice/url/send.php

  • عملیات    مقدار method    توضیحات
    ارسال پیامک    sendsms    ارسال یک متن مشترک به حداکثر ۱۵۰ گیرنده در هر درخواست
    ارسال چندگانه    sendmultisms    ارسال پیام‌های جداگانه به حداکثر ۶۰ گیرنده در هر درخواست
    استعلام اعتبار    getcredit    دریافت اعتبار حساب پنل
    استعلام وضعیت تحویل    getstatus    بررسی حداکثر ۵۰ شناسه ارسال در هر درخواست

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

۲. وب‌سرویس SOAP / WSDL

اگر نرم‌افزار شما از SOAP استفاده می‌کند، می‌توانید تعریف متدها را از نشانی WSDL دریافت کنید. این روش علاوه بر ارسال پیامک، استعلام اعتبار و گزارش تحویل، برای مدیریت دفترچه تلفن و ثبت‌نام کاربر نیز به کار می‌رود.

نشانی WSDL:

http://212.33.201.227/webservice/send.php?wsdl
 

متدهای اصلی پیامک در این سرویس SendSMS، SendMultiSMS، GetCredit و GetStatus هستند. برای پیاده‌سازی، پارامترها و کدهای پاسخ را بر اساس راهنمای همان سرویس بررسی کنید؛ قالب ورودی‌ها و کدهای پاسخ SOAP و URL لزوماً یکسان نیستند.

وب‌سرویس دفترچه تلفن

اگر شماره مشتریان در فروشگاه یا نرم‌افزار CRM شما ثبت می‌شود، می‌توانید از طریق SOAP آن‌ها را به دفترچه‌های پنل رستاک اضافه کنید یا شماره‌های قبلی را به‌روزرسانی کنید؛ بدون اینکه فهرست‌ها را دستی بین دو سامانه جابه‌جا کنید.

عملیات    متد مستند
ساخت دفترچه تلفن    addPhonebook
دریافت فهرست دفترچه‌ها    listPhonebook
افزودن شماره به دفترچه    addToPhonebook
دریافت شماره‌های یک دفترچه    numbersPhonebook
حذف شماره‌های مشخص از دفترچه    deleteNumbersOfPhonebook
حذف یک دفترچه    deletePhonebook

 

وب‌سرویس ثبت‌نام کاربران

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

راه‌اندازی را از کجا شروع کنیم؟

  1. برای ارسال پیامک، از حساب فعال، خط فرستنده مجاز و اعتبار کافی استفاده کنید.
  2. برای چهار عملیات اصلی پیامک، بسته به ساختار نرم‌افزارتان URL یا SOAP را انتخاب کنید. برای دفترچه تلفن و ثبت‌نام کاربران، از SOAP استفاده کنید.
  3. ابتدا یک پیام آزمایشی به شماره خودتان بفرستید. شناسه ارسال را ذخیره کنید و با متد استعلام وضعیت، نتیجه تحویل را بررسی کنید.

نکته امنیتی: درخواست‌ها را از سمت سرور ارسال کنید و نام کاربری و رمز عبور را در جاوااسکریپت سایت، نشانی درخواست یا لاگ‌ها قرار ندهید. نشانی‌های بالا با HTTP ارائه شده‌اند و ترافیک را رمزنگاری نمی‌کنند. پیش از ارسال رمز عبور یا اطلاعات هویتی واقعی، نشانی رسمی HTTPS را از پشتیبانی دریافت و تأیید کنید. استفاده از POST یا MD5 جایگزین HTTPS نیست.

ورود به پنل رستاک اس‌ام‌اس

عنوان پیشنهادی سئو: وب‌سرویس پیامک رستاک اس‌ام‌اس | راهنمای API و SOAP

توضیحات متا: راهنمای اتصال سایت و نرم‌افزار به وب‌سرویس رستاک اس‌ام‌اس برای ارسال پیامک، استعلام تحویل و اعتبار، مدیریت دفترچه تلفن و ثبت‌نام کاربران.

یادداشت پیش از انتشار: نشانی‌های این متن از مسیرهای مستند و IP اعلام‌شده شما ساخته شده‌اند و اتصال زنده به آن‌ها بررسی نشده است. اگر چهار PDF را هم برای دانلود می‌گذارید، آدرس‌های قدیمی داخل متن و تصاویر نمونه‌کد را پیش از بارگذاری به‌روزرسانی کنید.