پکیج های وب سرویس
در این بخش می توانید مجموعه ای از کتابخانه و توابع زبان های برنامه نویسی مختلف جهت آسان نمودن برنامه نویسی و توسعه را در اختیار داشته باشید. سامانه پیامکی ایده پردازان علاوه بر مستندات وب سرویس REST این بخش را نیز در اختیار برنامه نویسان قرارداده است تا به سادگی بتوانند کار توسعه و برنامه نویسی خود را دنبال نمایند. چنانچه در ارتباط با استفاده از بخش های مختلف پکیج ها مشکل و خللی صورت گرفت، با پشتیبانان ما در ارتباط باشید. همچنین برای دسترسی به پکیج ها می توانید به بخش گیت هاب ایده پردازان نیز مراجعه نمایید.
پکیج Node JS
NodeJS
برای نصب بایستی دستور زیر را وارد نمایید:
Installation:
import {Smsir} from 'smsir-js'
اگر npm نصب شده ندارید می توانید از طریق کلیک روی نصب npm اقدام به دانلود نمایید.
نمونه کد
const {Smsir} = require('smsir-js')
/**
*
* @param {string} api_key
* @param {int} line_number
*/
const smsir = new Smsir(api_key, line_number)
نمونه کد Vue.js و React.js
import {Smsir} from 'smsir-js'
/**
*
* @param {string} api_key
* @param {int} line_number
*/
const smsir = new Smsir(api_key, line_number)
برای مشاهده دستورات پکیج NodeJs می تواند به صفحه ایده پردازان در github مراجعه نمایید.
پکیج لاراول
Laravel
شما می توانید از طریق composer بسته لاراول را نصب نمایید.
Installation:
composer require ipe/smsir-php
برای دریافت کلید وب سرویس، وارد پنل کاربری SMS.ir خود شوید و از بخش “برنامه‌نویسان” اقدام به ایجاد کلید کنید. سپس از همان کلید در تنظیمات پکیج استفاده نمایید.
پس از تهیه کلید وب سرویس، فایل .env خودرابامقادیر زیر بروزرسانی کنید:
SMSIR_API_KEY= your_api_key_here
نحوه ارسال پیامک با متد verify
خط زیر را به هر کلاسی که می خواهید از توابع smsir استفاده نمایید اضافه کنید.
این متد به شما این امکان را می‌دهد تا پیامک‌های تأییدیه (مانند کدهای OTP) را به شماره موبایل ارسال کنید، با استفاده از یک الگوی از پیش تعریف شده. الگو شامل پارامترهای دینامیکی است که با مقادیر ارائه‌شده جایگزین می‌شوند.
use Ipe\Sdk\Facades\SmsIr;
$mobile = "09120000000"; // شماره موبایل گیرنده
$templateId = 100000; // شناسه الگو
$parameters = [
[
"name" => "Code",
"value" => "12345"
]
];
$response = SmsIr::verifySend($mobile, $templateId, $parameters);
برای مشاهده دستورات پکیج Laravel می تواند به صفحه این پکیج در github مراجعه نمایید.
پکیج تایپ اسکریپت
TypeScript
نصب پکیج TypeScript
Installation:
npm i sms-typescript
Angular, etc
import {Smsir} from 'sms-typescript/lib';
export class AppComponent implements OnInit{
smsWebService!: any;
constructor() {
this.smsWebService = new Smsir(
'Access_key', // string
'Line_number' // number
)
}
}
برای مشاهده دستورات پکیج TypeScript می تواند به صفحه این پکیج در github مراجعه نمایید.
پکیج NET.
NET.
نصب پکیج NET.:
برای نصب و راه اندازی ابتدا باید nugetرا دانلود و نصب نمایید.
سپس از بخش tools وارد Nuget package manager شوید و گزینه package manager Console را انتخاب نمایید.
حال باید دستور نصب را اجرا نمایید.
Installation:
Install-Package IPE.SmsIR
نمونه کد برای استفاده:
SmsIr smsIr = new SmsIr("YOUR API KEY");
var bulkSendResult = await smsIr.BulkSendAsync(95007079000006, "your text message", new string[] { "9120000000" });
var verificationSendResult = await smsIr.VerifySendAsync("9120000000", 100000, new VerifySendParameter[] { new("Code", "12345") });
برای مشاهده دستورات پکیج .NET می تواند به صفحه این پکیج در github مراجعه نمایید.
پکیج Net Framework.
NetFramework.
برای استفاده از این پکیج از طریق package Manager Console در Visual Stadio به عنوان ماژول NuGet نصب و راه اندازی می گردد.
برای دانلود این پکیج می توانید از طریق کلیک روی NetFramework. اقدام نمایید.
پکیج Python
Python
نصب پکیج Python:
Installation:
pip install smsir-python
نحوه استفاده
ایجاد نمونه :
from sms_ir import SmsIr sms_ir = SmsIr( api_key, linenumber, )
ارسال پیام به شماره موبایل خاص:
sms_ir.send_sms( number, message, linenumber, )
ارسال پیام به چند شماره موبایل:
sms_ir.send_bulk_sms( numbers, message, linenumber, )
ارسال پیام های متعدد به چند شماره تلفن همراه جفت به جفت
sms_ir.send_like_to_like( numbers, messages, linenumber, send_date_time, )
حذف پیام برنامه ریزی شده :
sms_ir.delete_scheduled( pack_id, )
ارسال کد تایید با الگوی از پیش تعریف شده
sms_ir.send_verify_code( number, template_id, parameters, )
دریافت گزارش پیام ارسال شده
sms_ir.report_message( message_id, )
دریافت گزارش بسته پیام ارسال شده
sms_ir.report_pack( pack_id, ))
دریافت گزارش پیام های ارسال شده امروز
sms_ir.report_today( page_size, page_number, ))
دریافت گزارش از پیام های آرشیو شده
sms_ir.report_archived( from_date, to_date, page_size, page_number, ))
دریافت گزارش آخرین پیام های دریافتی
sms_ir.report_latest_received( count, )
دریافت گزارش پیام های دریافتی امروز
sms_ir.report_today_received( page_size, page_number, )
دریافت گزارش پیام های دریافتی امروز
sms_ir.report_archived_received( from_date, to_date, page_size, page_number, )
دریافت اعتبار حساب
sms_ir.get_credit()
شماره خطوط حساب را دریافت کنید
sms_ir.get_line_numbers()
برای مشاهده دستورات پکیج Python می تواند به صفحه این پکیج در github مراجعه نمایید.