معرفی پکیج نوگت غیر رسمی ایده پردازان (sms.ir) برای دات نت

در این مطلب پکیج نوگت Riviera.IdehPardazan که برای دسترسی به سرویس پیام کوتاه ایده پردازان (sms.ir) در دات نت است را بررسی خواهیم کرد.

نحوه نصب

با استفاده از Package Manager Console در ویژوال استودیو می‌توانید پکیج نوگت Riviera.IdehPardazan را نصب کنید.

Install-Package Riviera.IdehPardazan

نحوه استفاده

برای شروع، ابتدا لازم است IdehPardazanService و تنظیمات آن را ریجستر کنید.

// using Riviera.IdehPardazan;

builder.Services.Configure<IdehPardazanOptions>(o => builder.Configuration.GetSection("IdehPardazan").Bind(o));
builder.Services.AddHttpClient<IdehPardazanService>();

در ادامه تنظیمات زیر را به فایل appsettings.Development.json خود اضافه کرده و سپس API Key خود را تنظیم کنید.

"IdehPardazan": {
  "ApiKey": "your-api-key"
}

پس از ریجستر کردن سرویس لازم است آن را به کنترلر خود اضافه کنید.

// using Riviera.IdehPardazan;

public class HomeController : Controller
{
    private readonly IdehPardazanService _service;

    public HomeController(IdehPardazanService service)
    {
        _service = service;
    }
}

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

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

[Route("send")]
public async Task<IActionResult> Send()
{
    var request = new NewBulkMessage
    {
        LineNumber = 1234567,
        MessageText = "This is a test message.",
    };

    request.Mobiles.Add("phone-number");

    var result = await _service.SendBulkMessageAsync(request);

    if (result.IsSuccess)
    {
        return Content($"Status: {result.Response?.Status}");
    }

    return Content($"Status: {result.Response?.Status}\nMessage: {result.Response?.Message}");
}

دریافت وضعیت

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

[Route("status")]
public async Task<IActionResult> Status()
{
    var result = await _service.GetMessageByIdAsync(1234567);

    if (result.IsSuccess)
    {
        return Content($"DeliveryState: {result.Response?.Data?.DeliveryState}");
    }

    return Content($"Status: {result.Response?.Status}\nMessage: {result.Response?.Message}");
}

متد های پشتیبانی شده

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

عنوان نام متد در کتابخانه
ارسال گروهی SendBulkMessageAsync
ارسال نظیر به نظیر SendLikeToLikeMessageAsync
حذف ارسال زمانبندی شده DeleteScheduledMessageAsync
ارسال VERIFY SendVerifyMessageAsync
گزارش پیامک دریافت وضعیت GetMessageByIdAsync
گزارش مجموعه ارسال های روز GetPacksSentTodayAsync
گزارش مجموعه ارسال GetPackMessagesByIdAsync
گزارش ارسال های روز GetMessagesSentTodayAsync
گزارش ارسال های آرشیو شده GetMessagesArchivedAsync
گزارش تازه ترین پیامک های دریافتی GetReceivedMessagesUnreadAsync
گزارش پیامک های دریافتی روز GetReceivedMessagesTodayAsync
گزارش پیامک های دریافتی آرشیو شده GetReceivedMessagesArchivedAsync
دریافت مقدار اعتبار فعلی GetCurrentCreditAsync
دریافت لیست خطوط GetLineNumbersAsync

اطلاعات بیشتر

  • سورس کامل این کتابخانه در صفحه گیت هاب آن قابل دسترسی است.
  • مستندات سرویس پیام کوتاه ایده پردازان را می‌توانید در این لینک مشاهده کنید.
نظرات (0)