👁 Image
LiteX.Sms.Core 7.0.0

LiteXSms

LiteXSms is simple yet powerful and very high-performance sms mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending sms more easier! Provide Sms service for any type of application (.NET Core, .NET Standard).

Abstract interface to implement any kind of basic sms message services (e.g. Twilio, Plivo, Nexmo, Sinch). Wrapper library is just written for the purpose to bring a new level of ease to the developers who deal with sms integration with your system.

It supports various sms providers and implements many advanced features. You can also write your own and extend it also extend existing providers.

Easily migrate or switch between one to another provider with no code breaking changes.

Having a default/generic implementation to wrap the Twilio, Plivo, Nexmo, Sinch and independed on the underlying provider SDK(s).

The Core library contains all base interfaces and tools. One should install at least one other LiteXSms package to get sms handle implementations.

This is the ASP.NET Core configuration integration package (Built-in).

Cache Providers

Features

• Async compatible
• Thread safe, concurrency ready
• Interface based API to support the test-driven development and dependency injection
• Leverages a provider model on top of ILiteXSmsSender under the hood and can be extended with your own implementation

Basic Usage

Step 1 : Install the package

Choose one kinds of sms provider type that you needs and install it via Nuget. To install LiteXSms, run the following command in the Package Manager Console

PM> Install-Package LiteX.Sms.Twilio
PM> Install-Package LiteX.Sms.Plivo
PM> Install-Package LiteX.Sms.Nexmo
PM> Install-Package LiteX.Sms.Sinch

Step 2 : Configuration 🔨

Different types of sms provider have their own way to config. Here are samples that show you how to config.

2.1 : AppSettings

2.2 : Configure Startup Class

public class Startup
{
 public void ConfigureServices(IServiceCollection services)
 {
 #region LiteX Sms (Twilio)

 // 1. Use default configuration from appsettings.json's 'TwilioConfig'
 services.AddLiteXTwilioSms();

 //OR
 // 2. Load configuration settings using options.
 services.AddLiteXTwilioSms(option =>
 {
 option.AccountSid = "";
 option.AuthToken = "";
 option.FromNumber = "";
 option.EnableLogging = true;
 });

 //OR
 // 3. Load configuration settings on your own.
 // (e.g. appsettings, database, hardcoded)
 var twilioConfig = new TwilioConfig()
 {
 AccountSid = "",
 AuthToken = "",
 FromNumber = "",
 EnableLogging = true
 };
 services.AddLiteXTwilioSms(twilioConfig);

 #endregion

 #region LiteX Sms (Plivo)

 // 1. Use default configuration from appsettings.json's 'PlivoConfig'
 services.AddLiteXPlivoSms();

 //OR
 // 2. Load configuration settings using options.
 services.AddLiteXPlivoSms(option =>
 {
 option.AuthId = "";
 option.AuthToken = "";
 option.FromNumber = "";
 option.EnableLogging = true;
 });

 //OR
 // 3. Load configuration settings on your own.
 // (e.g. appsettings, database, hardcoded)
 var plivoConfig = new PlivoConfig()
 {
 AuthId = "",
 AuthToken = "",
 FromNumber = "",
 EnableLogging = true
 };
 services.AddLiteXPlivoSms(plivoConfig);

 #endregion

 #region LiteX Sms (Nexmo)

 // 1. Use default configuration from appsettings.json's 'NexmoConfig'
 services.AddLiteXNexmoSms();

 //OR
 // 2. Load configuration settings using options.
 services.AddLiteXNexmoSms(option =>
 {
 option.ApiKey = "";
 option.ApiSecret = "";
 option.ApplicationId = "";
 option.ApplicationKey = "";
 option.FromNumber = "";
 option.EnableLogging = true;
 });

 //OR
 // 3. Load configuration settings on your own.
 // (e.g. appsettings, database, hardcoded)
 var nexmoConfig = new NexmoConfig()
 {
 ApiKey = "",
 ApiSecret = "",
 ApplicationId = "",
 ApplicationKey = "",
 FromNumber = "",
 EnableLogging = true
 };
 services.AddLiteXNexmoSms(nexmoConfig);

 #endregion

 #region LiteX Sms (Sinch)

 // 1. Use default configuration from appsettings.json's 'SinchConfig'
 services.AddLiteXSinchSms();

 //OR
 // 2. Load configuration settings using options.
 services.AddLiteXSinchSms(option =>
 {
 option.ApiKey = "";
 option.ApiSecret = "";
 option.FromNumber = "";
 option.EnableLogging = true;
 });

 //OR
 // 3. Load configuration settings on your own.
 // (e.g. appsettings, database, hardcoded)
 var sinchConfig = new SinchConfig()
 {
 ApiKey = "",
 ApiSecret = "",
 FromNumber = "",
 EnableLogging = true
 };
 services.AddLiteXSinchSms(sinchConfig);

 #endregion
 
 
 // add logging (optional)
 services.AddLiteXLogging();
 }
}

Step 3 : Use in Controller or Business layer

public class CustomerController : Controller
{
 private readonly ILiteXSmsSender _smsSender;

 public CustomerController(ILiteXSmsSender smsSender)
 {
 _smsSender = smsSender;
 }

 [Route("get-sms-provider-type")]
 public IActionResult GetSmsProviderType()
 {
 return Ok(_smsSender.SmsProviderType.ToString());
 }

 [Route("send-sms")]
 public async Task<IActionResult> SendSms(string toPhoneNumber, string messageText)
 {
 toPhoneNumber = toPhoneNumber ?? "+919426432254";
 messageText = messageText ?? "I am LiteX Sms!";

 // async
 var result = await _smsSender.SendSmsAsync(toPhoneNumber, messageText);

 // sync
 //var result = _smsSender.SendSms(toPhoneNumber, messageText);

 return Ok(result);
 }
}

Coming soon

• Bulk Sms