مستندات وب سرویس پیامون

وب سرویس

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

وب‌سرویس پیامون بر پایهٔ معماری REST طراحی شده و تمامی درخواست‌ها از طریق احراز هویت توکن (Auth Token) تأیید می‌شوند.

نمونه‌کدهای آماده در زبان‌های متداول—از جمله PHP، Python شما کمک می‌کند تا در کوتاه‌ترین زمان اتصال سرویس خود را عملیاتی کنید.

درج لیست سیاه برای پترن

آدرس وب سرویس

متد BlackListAdd

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

URL درج لیست ویژه سیاه با استفاده از متد BlackListAdd:

// نمونه کدهای  خام PHP
ini_set("soap.wsdl_cache_enabled", "0");
$client = new SoapClient("https://api.payamak-panel.com/post/blacklist.asmx?wsdl", array("encoding" => "UTF-8"));
$black_list_data = array(
    "username" => "username",
    "password" => "password",
    "title" => "test"
);
$blist_result = $client->BlackListAdd($black_list_data)->BlackListAddResult;

درج پترن (الگو)

آدرس وب سرویس

متد SharedServiceBodyAdd

متد SharedServiceBodyAdd برای اضافه‌کردن متن الگو (Pattern Body) استفاده می‌شود. با ثبت متن الگو در این متد، سامانه آن را ذخیره می‌کند تا در زمان ارسال پیامک الگویی، همین متن پایه همراه با مقادیر پارامترها استفاده شود.

آدرس درج الگو با متد SharedServiceBodyAdd

برای ثبت متن الگو (Pattern Body) در سرویس اشتراکی، از Endpoint زیر استفاده می‌شود:

// نمونه کدهای  خام PHP
ini_set("soap.wsdl_cache_enabled", "0");
$client = new SoapClient("https://api.payamak-panel.com/post/SharedService.asmx?wsdl",array("encoding"=>"UTF-8"));
$data = array(
	"username" => "",
	"password" => "",
	"title" => "",
	"body" => "",
	"blackListId" =>
);
$result = $client->SharedServiceBodyAdd($data)->SharedServiceBodyAddResult;
 

خط خدماتی اشتراکی – پیامک پترن (متد اول)

آدرس وب سرویس

متد SendByBaseNumber

ارسال پیامک با متن پیش‌فرض از خط اشتراکی

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

// نمونه کدهای  خام PHP
ini_set("soap.wsdl_cache_enabled","0");
$sms = new SoapClient("http://api.payamak-panel.com/post/Send.asmx?wsdl",array("encoding"=>"UTF-8"));
$data = array(
    "username"=>"",
    "password"=>"",
    "text"=>array("arg1","arg2"),
    "to"=>"",
    "bodyId"=>);
$send_Result = $sms->SendByBaseNumber($data)->SendByBaseNumberResult;
echo $send_Result;

خط خدماتی اشتراکی – پیامک پترن (متد دوم)

آدرس وب سرویس

متد SendByBaseNumber2

ارسال پیامک با متن پیش‌فرض از خط اشتراکی

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

آدرس ارسال پیامک با متد SendByBaseNumber2

برای ارسال پیامک با متن پیش‌فرض از خط خدماتی اشتراکی، از Endpoint زیر استفاده می‌شود:

// نمونه کدهای  خام PHP
$data = array('username' => "", 'password' => "",'text' => "arg1;arg2",'to' =>"" ,"bodyId"=>);
$post_data = http_build_query($data);
$handle = curl_init('https://rest.payamak-panel.com/api/SendSMS/BaseServiceNumber2');
curl_setopt($handle, CURLOPT_HTTPHEADER, array(
    'content-type' => 'application/x-www-form-urlencoded'
));
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
curl_setopt($handle, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_POST, true);
curl_setopt($handle, CURLOPT_POSTFIELDS, $post_data);
$response = curl_exec($handle);
var_dump($response);

خط خدماتی اشتراکی – پیامک پترن (متد سوم)

آدرس وب سرویس

متد SendByBaseNumber3

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

آدرس ارسال پیامک با متد SendByBaseNumber3

برای ارسال پیامک الگویی از خط خدماتی اشتراکی با فرمت ساده، از Endpoint زیر استفاده می‌شود:

// نمونه کدهای  خام PHP
ini_set("soap.wsdl_cache_enabled","0");
$sms = new SoapClient("http://api.payamak-panel.com/post/Send.asmx?wsdl",array("encoding"=>"UTF-8"));
$data = array(
    "username"=>"",
    "password"=>"",
    "text"=>"@bodyId@arg1;arg2;arg3",
    "to"=>""
);
$send_Result = $sms->SendByBaseNumber3($data)->SendByBaseNumber3Result;
echo $send_Result;