از آنجا که سرویس وب پیام کوتاه نت کا به آدرس ( NETK.IR ) در حال تکمیل و افزایش امکانات است، این مستند دستخوش تغییراتی خواهد شد. لذا مراجعه مجدد به این مستند به برنامه نویسان محترم، پیشنهاد می شود. این مستند بعنوان راهنمای استفاده از سرویس وب پیام کوتاه نت کا می باشد و مخاطب آن برنامه نویسانی هستند که آشنا به مفاهیم تکنولوژی SOAP بوده و نحوه ایجاد یک SOAP Client را با زبانی که مسلط به آن هستند بدانند. البته مثالهای کاربردی با زبان PHP در انتهای مستند ارائه شده است. نت کا ( NETK.IR ) خود را موظف به ارائه صحیح سرویس وب می داند و هیچ تعهدی برای نصب، پیکربندی و راه اندازی SOAP Client بر روی سرویس دهنده های دیگر ندارد و در صورت نیاز مشتری طبق قرارداد جداگانه قابل انجام است.
جهت استفاده از این سرویس وب ابتدا باید درخواست خود را از طریق صفحه مربوطه در وب سایت netk.ir تنظیم و ارسال کنید. بر اساس درخواست شما یک یا چند شماره به حساب شما تخصیص داده می شود که از میان آنها یکی بصورت شماره پیش فرض (Default) انتخاب می شود. با استفاده از شناسه کاربری و رمز عبوری که در فرم ثبت نام وارد می کنید، پس از شارژ اعتبار و فعالسازی حساب شما توسط مدیر سیستم، اجازه استفاده از سرویس وب را خواهید داشت که در ادامه به معرفی متدهای سرویس وب، پارامترهای ورودی و خروجی آنها، کدهای خطا و کدهای وضعیت پیام کوتاه می پردازیم.
متد send
جهت ارسال یک پیام کوتاه از این متد استفاده می شود. در جدول زیر پارامترهای ورودی این متد آورده شده است. مقدار بازگشتی این متد “کد پیگیری پیام کوتاه” می باشد که از نوع عدد صحیح و بزرگتر مساوی ١٠٠٠ است. در صورت بروز هر گونه خطایی یک Fault بازگشت داده می شود که در بخش تعاریف به توضیح آن پرداختیم.
متد sendToMany
جهت ارسال یک پیام کوتاه به چندین مخاطب از این متد استفاده می شود. در جدول زیر پارامترهای ورودی این متد آورده شده است. مقدار بازگشتی این متد آرایهای است که کلید هر عنصر آن «شماره موبایل مخاطب» و مقدار آن کلید، “کد پیگیری پیام کوتاه” می باشد که از نوع عدد صحیح و بزرگتر مساوی ١٠٠٠ است. در صورت بروز خطا در حین ارسال به هر مخاطب، کد خطا بعنوان مقدار کلید برای همان شماره بازگشت داده میشود و در صورت بروز خطاهای کلیتر یک Fault بازگشت داده می شود که در بخش تعاریف به توضیح آن پرداختیم. بنابراین برنامهنویس محترم میبایست پس از دریافت پاسخ این متد، آرایه را پیمونده و مقدار هر کلید(شماره موبایل) را از نظر بروز خطا بررسی کند. مجددا تاکید میکنیم خطا در ارسال به یک مخاطب فقط برای همان مخاطب گزارش میشود و سایر شمارهها پردازش خواهند شد.
متد sendOneToOne
جهت ارسال یک پیام کوتاه به یک مخاطب بصورت نظیر به نظیر از این متد استفاده می شود. در جدول زیر پارامترهای ورودی این متد آورده شده است. مقدار بازگشتی این متد آرایهای است عددی که مقدار هر عنصر آن شامل “کد پیگیری پیام کوتاه” می باشد که از نوع عدد صحیح و بزرگتر مساوی ١٠٠٠ است. در صورت بروز خطا در حین ارسال به هر مخاطب، کد خطابازگشت داده میشود و در صورت بروز خطاهای کلیتر یک Fault بازگشت داده می شود که در بخش تعاریف به توضیح آن پرداختیم. بنابراین برنامهنویس محترم میبایست پس از دریافت پاسخ این متد، آرایه را پیمونده و مقدار هر عنصر را از نظر بروز خطا بررسی کند. کلیدهای این آرایه نیز عددی بوده و دقیقا متناظر با ترتیب پارامترهای ارسالی میباشد. مجددا تاکید میکنیم خطا در ارسال به یک مخاطب فقط برای همان مخاطب گزارش میشود و سایر شمارهها پردازش خواهند شد. در حال حاضر در هر بار فراخوانی این متد حداکثر ۲۰۰ شماره قابل قبول میباشد.
متد deliveryStatus
جهت بررسی وضعیت تحویل یک پیام کوتاه از این متد استفاده می شود. تنها ورودی آن “کد پیگیری پیام کوتاه” است. مقدار بازگشتی این متد “کد وضعیت تحویل پیام کوتاه” می باشد که از نوع عدد صحیح بوده و شرح هر یک در جدول ٢ آمده است
متد verifyReceive
جهت بررسی صحت پیام کوتاه دریافتی از سرویس دهنده نت کا ( NETK.IR ) از این متد استفاده می شود. تنها ورودی آن “کد امنیتی پیام کوتاه” است که همراه با سایر اطلاعات پیام کوتاه به آدرس اینترنتی انتقال ترافیک شما ارسال می شود. مقدار بازگشتی این متد نوع Boolean می باشد که True به معنای صحت پیام دریافتی و False به معنای عدم صحت پیام دریافتی است.
متد accountInfo
برای دریافت اطلاعات حساب در نت کا ( NETK.IR ) از این متد استفاده می شود. این متد هیچ ورودی ندارد. خروجی آن یک آبجکت است که شرح خصیصه های (Property) آن در جدول زیر آمده است.
متد changePassword
برای تغییر رمز عبور حساب از این متد استفاده می شود. ورودی آن رمز عبور جدید است و در صورت انجام صحیح عملیات هیچ خروجی تولید نمی شود. در صورت بروز هر گونه خطایی یک Fault بازگشت داده می شود و عملیات انجام نمی پذیرد.
متد changeTrafficRelay
برای تغییر آدرس اینترنتی انتقال ترافیک از این متد استفاده می شود. ورودی آن URL جدید است که باید بصورت کامل وارد شود نظیر (http://example.com/smsreceiver.php) و در صورت انجام صحیح عملیات هیچ خروجی تولید نمی شود. در صورت بروز هر گونه خطایی یک Fault بازگشت داده می شود و عملیات انجام نمی پذیرد.
در صورتی که از php۵ استفاده می کنید به راحتی با فعالسازی افزودنی (Extension) به نام SOAP و استفاده از کلاس SoapClient سرویس وب پیام کوتاه نت کا ( NETK.IR ) را مصرف کنید. نحوه ارسال یک پیام کوتاه، بررسی وضعیت تحویل پیام کوتاه و مشاهده اطلاعات حساب:
$options = array(
‘login’ => ‘yourusername’,
‘password’ => ‘yourpassword’
);
$client = new SoapClient(‘http://smscenter.netk.ir/webservice//?WSDL’, $options);
try
{
$messageId = $client->send(‘٠٩١٢١١١١١١١’, ‘تست پیام کوتاه!’);
sleep(٣);
print ($client->deliveryStatus($messageId));
var_dump($client->accountInfo());
}
catch (SoapFault $sf)
{
print $sf->faultcode.”n”;
print $sf->faultstring.”n”;
}