مستندات API ها و پلاگین های ارسال پیامک در سرویس آسانک
در این صفحه شما می‌توانید مستندات API ارسال پیامک و پلاگین ارسال پیامک آسانک را دریافت کنید. در ادامه دربارۀ افزونه‌های فروشگاهی، افزونۀ ارسال پیامک وردپرس، متدهای گوناگون، اتصال پنل پیامک به وردپرس، پلاگین پیامک وردپرس و روش‌های ارتباط با API صحبت کرده‌ایم. فایل مستندات وب سرویس آسانک را از اینجاد دانلود کنید.
دانلود فایل مستندات
افزونه‌ها
افزونه های پیامکی وردپرس به شما کمک می‌کنند تا مواردی مانند اطلاع‌رسانی وضعیت سفارش‌ها، ارسال خبرنامه پیامکی، ارسال کد تایید، ثبت‌نام از طریق شماره تلفن و... را به راحتی در سایت خود پیاده‌سازی کنید. این افزونه‌ها به سادگی قابلیت اتصال به سامانه آسانک را دارند.
افزونه asanak-wc-plugin
با نصب این افزونه روی فروشگاه اینترنتی خود از امکان ارسال پیامک در ووکامرس بهره‌مند می‌شوید. با افزونه ارسال پیامک ووکامرس فارسی می‌توانید در تمام مراحل خرید برای مشتری‌تان پیامک ارسال کنید به این ترتیب می‌توانید مواردی مانند وضعیت سفارش، خرید محصول، لغو خرید، و اتمام موجودی را به‌صورت اتوماتیک به مشتری و مدیر اطلاع دهید.
اگر به افزونه ارسال پیامک بعد از خرید نیاز دارید، این پلاگین را دانلود کنید.
API ها
متد Sendsms
متد Msgstatus
متد getcredit
این متد به منظور ارسال پیامک با استفاده از وب‌سرویس ارسال پیامک استفاده می‌شود.
این متد به منظور آگاهی از وضعیت پیامک‌های ارسال‌شده به‌کار می‌رود. به همین منظور، کدهایی را که پس از ارسال پیامک از سوی وب سرویس برگردانده می‌شوند با متد msgstatus ارسال کرده و کد وضعیت آنها را می‌توان مشاهده کرد.
این متد ماندۀ اعتبار پیامکی کاربر را برمی‌گرداند.
روش‌های ارتباط با API ها
REST
متد REST را می‌توان محبوب‌ترین و کاربردی‌ترین روش برای استفاده از API پنل پیامک دانست. این روش ساده به کاربر امکان می‌دهد که از هر کلاینت و پلتفرمی درخواست خود را ارسال کرده، پاسخش را دریافت کند.
SOAP
متد SOAP پروتکلی برای دست‌یابی به سرویس ارائه‌شده در وب‌سرویس است. پروتکل Simple Object Access Protocol برای ردوبدل‌کردن اطلاعات بین برنامه‌ها استفاده می‌شود و در حیطه وب‌سرویس‌ها یکی از پرکاربردترین استانداردهاست. در این متد اطلاعات به‌صورت Message و از راه پروتکل‌هایی مانند HTTP منتقل می‌شود.
دریافت پیامک از طریق وب سرویس آسانک
تمام دریافتی‌ها از طریق وب سرویس آسانک به شکل Push است و ضروری است که در سمت سرویس‌گیرنده یک آدرس URL برای دریافت پیام‌ها تعریف شده، در تنظیمات وب‌سرویس آسانک ثبت شود. این آدرس با توجه به شیوه و زبان برنامه‌نویسی کاربر می‌تواند – به‌عنوان مثال – به‌صورت زیر باشد: Http://YourSite.com/Getsmsالبته به‌جای Getsms می‌توان به‌دلخواه نام فایل یا تابع دریافت پیامک را وارد کرد.
در مرحلۀ بعد وب سرویس پیامک خدماتی آسانک یک Query String در انتهای این آدرس قرار داده، برای کاربر ارسال می‌کند تا وی بتواند پیام‌های دریافتی را در قالب پارامترهایی مشخص دریافت کند. کاربر می‌تواند از طریق متد GET مقدار این پارامترها را دریافت کند.
توجه داشته باشید که هنگام ثبت نشانی دریافت در پنل، نیازی به تعیین پارامترها از سوی کاربر نیست، و آسانک پارامترها را به نشانی کاربر ارسال خواهد کرد. همچنین لازم است که در آدرس ثبت‌شده توسط کاربر، سرویسی فعال باشد که Query String را دریافت کرده، پارامترهای ارسالی را Parse کند.
در صورت نیاز به راهنمایی بیشتر در زمینۀ ارسال پیامک از طریق وب سایت و آموزش استفاده از API ارسال پیامک با واحد پشتیبانی آسانک تماس بگیرید.
الگوها یا پترن ها
دو روش عمده برای ارسال پیامک انبوه از طریق وب‌سرویس در سامانه ارسال و دریافت پیامک وجود دارد: استفاده از URL و استفاده از الگو یا پترن. معمولاً تایید پیامک از سوی واحد کنترل و سپس ارسال آن به مخاطب حدود 1 تا 2 دقیقه طول می‌کشد؛ پس جایی که نیاز به ارسال سریع (مانند پیامک تایید، کد ثبت‌نام و…) است چه باید کرد؟ در چنین شرایطی استفاده از الگوها پیشنهاد می‌شود. در این روش الگوی درخواستی کاربر یک‌بار تایید می‌شود و در مراحل بعدی ارسال تنها پارامترهای آن تغییر می‌کنند. با این راهکار، سرعت ارسال پیامک به 5 تا 10 ثانیه می‌رسد و مخاطب می‌تواند به‌سرعت پیامک مدنظر کاربر وب‌سرویس را دریافت کند.
فواید استفاده از پترن
ارسال پیامک به بلک لیست
بسیاری از مخاطبان گزینۀ دریافت پیامک تبلیغاتی را غیرفعال کرده‌اند. استفاده از پترن کمک می‌کند که 100درصد مخاطبان پیامک‌های مهم را دریافت کنند.
افزایش سرعت ارسال پیامک‌ها
به‌جای نگارش مکرر متن پیامک و گرفتن تایید برای هر پیام، این کار یک بار انجام می‌شود و از آن به‌بعد فقط لازم است متغیرهای پیامک جایگزین شوند. وب سرویس ارسال سریع پیامک و الگوها امکانی است که آسانک در اختیار شما قرار می‌دهد.
ارتباط بهتر با مشتریان
سرعت بالای ارسال پیام، و دریافت به‌موقع پیامک‌های اطلاع‌رسانی، کدهای فعال‌سازی، تبریک و... باعث افزایش رضایت مشتریان است که با انتخاب بهترین وب سرویس پیامک و استفاده از الگوها محقق خواهد شد.
نمونه پترن‌های غلط و درست
کد فعال‌سازی شما *** است. سایت آسانک.
آپارتمان 120 متری، فقط 800 میلیون تومان
{{***}} گرامی، کد ورود شما به سامانه: {{***}}
برای ورود به سایت از کد {{***}} استفاده کنید.
پارامترهای ارسالی حتماً باید داخل {{ }} نوشته شوند. کد فعال‌سازی شما {{***}} است. سایت آسانک.
قالب‌هایی که دارای محتوای تبلیغاتی، نیازمندی، املاک و پزشکی باشند تایید نخواهند شد.
پارامتر ارسالی شما نمی‌تواند آخرین جزء از متن باشد و بعد از آن حتماً باید کلمه‌ای بیاید. {{***}} گرامی، کد تایید شما {{***}} است. سایت آسانک.
در انتهای پیام حتماً باید آدرس سایت یا اسم اپلیکیشن قید شود.
برای ورود به سایت از کد {{***}} استفاده کنید. سایت آسانک.
نمونه پترن‌های غلط و درست
پارامترهای ارسالی حتماً باید داخل {{ }} نوشته شوند. کد فعال‌سازی شما {{***}} است. سایت آسانک.
کد فعال‌سازی شما *** است. سایت آسانک.
قالب‌هایی که دارای محتوای تبلیغاتی، نیازمندی، املاک و پزشکی باشند تایید نخواهند شد.
آپارتمان 120 متری، فقط 800 میلیون تومان
پارامتر ارسالی شما نمی‌تواند آخرین جزء از متن باشد و بعد از آن حتماً باید کلمه‌ای بیاید. {{***}} گرامی، کد تایید شما {{***}} است. سایت آسانک.
{{***}} گرامی، کد ورود شما به سامانه: {{***}}
در انتهای پیام حتماً باید آدرس سایت یا اسم اپلیکیشن قید شود.
برای ورود به سایت از کد {{***}} استفاده کنید. سایت آسانک.
برای ورود به سایت از کد {{***}} استفاده کنید.