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

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

آخرین به روز رسانی: 14 مهر 1403

آدرس وب سرویس

متد SendByBaseNumber3

این متد برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی (ارسال به لیست سیاه مخابرات) استفاده می‌شود. این متد جهت سهولت استفاده برای کاربرانی است که توانایی تغییر وبسرویس ساده به وبسرویس خدماتی را ندارند و قصد دارند از قابلیت ارسال پیامک از پترن سامانه استفاده کنند.
فقط کافی است که در متغیر text، یک الگوی مشخص مانند زیر وارد کنید. منظور از مقدار bodyId در الگوی زیر، همان کد متن وبسرویس خدماتی می‌باشد:

@bodyId@arg1;arg2;arg3

پارامتر های ورودی

نام پارامترنوع پارامترتوضیحات
username String نام کاربری شما در سامانه
password String کلمه عبور شما در سامانه
text String ابتدا کد متن را بین دو علامت @ و سپس متغیرهایی که در متن پیشفرض تنظیم کرده‌اید را به ترتیب با ; از هم جدا کنید.
نمونه متن: @bodyId@test1;test2;test3
to String تنها یک شماره موبایل میتوانید وارد کنید.

مقدار بازگشتی

نام پارامترنوع پارامترتوضیحات
ReturnValue String recId : یک عدد یکتا به معنای ارسال موفق پیامک

-8 : متن ارسالی، طبق راهنمای مستندات، باید با @ شروع شود

-7 : خطای داخلی رخ داده است با پشتیبانی تماس بگیرید

-6 : متن ارسالی باتوجه به متغیرهای مشخص شده در متن پیشفرض همخوانی ندارد

-5 : کد متن ارسالی صحیح نمی‌باشد و یا توسط مدیر سامانه تأیید نشده است

-4 و -9 : خط ارسالی در سیستم تعریف نشده است، با پشتیبانی تماس بگیرید

-3 : محدودیت تعداد شماره، محدودیت هربار ارسال یک شماره موبایل می‌باشد

-2 : طبق راهنمای مستندات، در متن ارسالی، مقدار bodyId درج نشده است

-1 : دسترسی برای استفاده از این وبسرویس غیرفعال است. با پشتیبانی تماس بگیرید

0 : نام کاربری یا رمزعبور صحیح نمی‌باشد

2 : اعتبار کافی نمی‌باشد

6 : سامانه درحال بروزرسانی می‌باشد

7 : متن حاوی کلمه فیلتر شده می‌باشد، با واحد اداری تماس بگیرید

10: کاربر موردنظر فعال نمی‌باشد

11: ارسال نشده

12: مدارک کاربر کامل نمی‌باشد

در صورت دریافت (recId) یک عدد بیش از 15 رقم به معنای ارسال موفق بوده و برای دریافت گزارش میتوانید از متد دریافت گزارش نظیر GetDeliveries استفاده نمایید.

URL ارسال پیامک با استفاده از متد SendByBaseNumber3:

http://api.payamak-panel.com/post/Send.asmx/SendByBaseNumber3?username=&password=&text=@bodyId@&to=

SendByBaseNumber3
//بدون نیاز به پکیج گیت هاب Procedural 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;
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendByBaseNumber3Response xmlns="http://tempuri.org/">
      <SendByBaseNumber3Result>string</SendByBaseNumber3Result>
    </SendByBaseNumber3Response>
  </soap:Body>
</soap:Envelope>