api پلاگین افزونه های ارسال پیامک در سرویس ارسالک

در این صفحه شما می‌توانید مستندات API ارسال پیامک و پلاگین ارسال پیامک اسالک را دریافت کنید. در ادامه درباره افزونه‌های فروشگاهی، افزونه ارسال پیامک وردپرس، متدهای گوناگون، اتصال پنل پیامک به وردپرس، پلاگین پیامک وردپرس و روش‌های ارتباط با API صحبت کرده‌ایم. فایل مستندات وب سرویس ارسالک را از اینجاد دانلود کنید.

دانلود فایل مستندات

افزونه ها

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

افزونه پیامک ووکامرس

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

دانلود افزونه

api ها

 این متد به منظور ارسال پیامک با استفاده از وب‌سرویس ارسال پیامک استفاده می‌شود.

دریافت کد پایتون

Python

import requests
url = “https://panel.asanak.com/webservice/v1rest/sendsms”

payload = {
‘username’: ‘YOUR_USERNAME’,
‘password’: ‘YOUR_PASSWORD’,
‘Source’: ‘9821XXXXXXXX’,
‘Message’: ‘YOUR_MESSAGE’,
‘destination’: ‘989XXXXXXXXX’
}

response = requests.request(“POST”, url, data=payload, timeout=5)

دریافت کد php

php

بزودی….

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

دریافت کد پایتون

Python

import requests
url = “https://panel.asanak.com/webservice/v1rest/msgstatus”

payload = {
‘username’: ‘YOUR_USERNAME’,
‘password’: ‘YOUR_PASSWORD’,
‘msgid’: ‘YOUR_MESSAGE_ID’
}

response = requests.request(“POST”, url, data=payload, timeout=5)
print(response.text.encode(‘utf8’))

دریافت کد php

php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => “https://panel.asanak.com/webservice/v1rest/msgstatus”,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_CUSTOMREQUEST => “POST”,
CURLOPT_POSTFIELDS => array(
‘username’ => ‘YOUR_USERNAME’,
‘password’ => ‘YOUR_PASSWORD’,
‘msgid’ => ‘YOUR_MESSAGE_ID’
),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>

 

دریافت کد جاوا

java

OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse(“application/x-www-form-urlencoded”);
RequestBody body = RequestBody.create(mediaType,
“username=YOUR_USERNAME&password=YOUR_PASSWORD&msgid=YOUR_MESSAGE_ID”);
Request request = new Request.Builder()
.url(“https://panel.asanak.com/webservice/v1rest/msgstatus%22)
.post(body)
.build();

Response response = client.newCall(request).execute();

 

این متد مانده اعتبار پیامکی کاربر را برمی‌گرداند.

دریافت کد php

php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://panel.asanak.com/webservice/v1rest/getcredit’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_HTTPHEADER => array(
‘username: YOUR_USERNAME’,
‘password: YOUR_PASSWORD’,
‘Cookie: asanak=gut3ps5tldh3nnvbvm2hnr6i75’
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

دریافت کد جاوا

java

OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse(“text/plain”);
RequestBody body = RequestBody.create(mediaType, “”);
Request request = new Request.Builder()
.url(“https://panel.asanak.com/webservice/v1rest/getcredit”)
.method(“POST”, body)
.addHeader(“username”, “YOUR_USERNAME”)
.addHeader(“password”, “YOUR_PASSWORD”)
.addHeader(“Cookie”, “asanak=gut3ps5tldh3nnvbvm2hnr6i75”)
.build();
Response response = client.newCall(request).execute();

روش‌های ارتباط با 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 و استفاده از الگو یا پترن. معمولاً تایید پیامک از سوی واحد کنترل و سپس ارسال آن به مخاطب حدود ۱ تا ۲ دقیقه طول می‌کشد؛ پس جایی که نیاز به ارسال سریع (مانند پیامک تایید، کد ثبت‌نام و…) است چه باید کرد؟ در چنین شرایطی استفاده از الگوها پیشنهاد می‌شود. در این روش الگوی درخواستی کاربر یک‌بار تایید می‌شود و در مراحل بعدی ارسال تنها پارامترهای آن تغییر می‌کنند. با این راهکار، سرعت ارسال پیامک به ۵ تا ۱۰ ثانیه می‌رسد و مخاطب می‌تواند به‌سرعت پیامک مدنظر کاربر وب‌سرویس را دریافت کند.

الگوها یا پترن ها

ارسال پیامک به بلک لیست

بسیاری از مخاطبان گزینه دریافت پیامک تبلیغاتی را غیرفعال کرده‌اند. استفاده از پترن کمک می‌کند که ۱۰۰درصد مخاطبان پیامک‌های مهم را دریافت کنند.

افزایش سرعت ارسال پیامک‌ها

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

ارتباط بهتر با مشتریان

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

نمونه پترن‌های غلط و درست

کد فعال‌سازی شما *** است. سایت ارسالک.

آپارتمان ۱۲۰ متری، فقط ۸۰۰ میلیون تومان

{{***}} گرامی، کد ورود شما به سامانه: {{***}}

برای ورود به سایت از کد {{***}} استفاده کنید.

پارامترهای ارسالی حتماً باید داخل {{ }} نوشته شوند. کد فعال‌سازی شما {{***}} است. سایت ارسالک.

قالب‌هایی که دارای محتوای تبلیغاتی، نیازمندی، املاک و پزشکی باشند تایید نخواهند شد.

پارامتر ارسالی شما نمی‌تواند آخرین جزء از متن باشد و بعد از آن حتماً باید کلمه‌ای بیاید. {{***}} گرامی، کد تایید شما {{***}} است. سایت ارسالک.

در انتهای پیام حتماً باید آدرس سایت یا اسم اپلیکیشن قید شود. برای ورود به سایت از کد {{***}} استفاده کنید. سایت ارسالک.

نمونه پترن‌های غلط و درست

زبان PHP

دانلود

زبان Curl

دانلود