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 Storage service for ASP.NET Core (2.0 and later) applications.
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).
- 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
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.SinchDifferent types of sms provider have their own way to config. Here are samples that show you how to config.
{
//LiteX Twilio Sms settings
"TwilioConfig": {
"AccountSid": "--- REPLACE WITH YOUR Twilio SID ---",
"AuthToken": "--- REPLACE WITH YOUR Twilio Auth Token ---",
"FromNumber": "--- REPLACE WITH Twilio From Number ---",
"EnableLogging": true
},
//LiteX Plivo Sms settings
"PlivoConfig": {
"AuthId": "--- REPLACE WITH YOUR Plivo Account SID ---",
"AuthToken": "--- REPLACE WITH YOUR Plivo Auth Token ---",
"FromNumber": "--- REPLACE WITH Plivo From Number ---",
"EnableLogging": true
},
//LiteX Nexmo Sms settings
"NexmoConfig": {
"ApiKey": "--- REPLACE WITH YOUR Nexmo ApiKey ---",
"ApiSecret": "--- REPLACE WITH YOUR Nexmo ApiSecret ---",
"ApplicationId": "--- REPLACE WITH YOUR Nexmo ApplicationId ---",
"ApplicationKey": "--- REPLACE WITH YOUR Nexmo ApplicationKey ---",
"FromNumber": "--- REPLACE WITH Nexmo From Number ---",
"EnableLogging": true
},
//LiteX Sinch Sms settings
"SinchConfig": {
"ApiKey": "--- REPLACE WITH YOUR Sinch ApiKey ---",
"ApiSecret": "--- REPLACE WITH YOUR Sinch ApiSecret ---",
"FromNumber": "--- REPLACE WITH Sinch From Number ---",
"EnableLogging": true
}
}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();
}
}/// <summary>
/// Customer controller
/// </summary>
[Route("api/[controller]")]
public class CustomerController : Controller
{
#region Fields
private readonly ILiteXSmsSender _smsSender;
#endregion
#region Ctor
/// <summary>
/// Ctor
/// </summary>
/// <param name="smsSender"></param>
public CustomerController(ILiteXSmsSender smsSender)
{
_smsSender = smsSender;
}
#endregion
#region Methods
/// <summary>
/// Get Sms Provider Type
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("get-sms-provider-type")]
public IActionResult GetSmsProviderType()
{
return Ok(_smsSender.SmsProviderType.ToString());
}
/// <summary>
/// Send sms
/// </summary>
/// <param name="toPhoneNumber">To phone number</param>
/// <param name="messageText">message text</param>
/// <returns></returns>
[HttpPost]
[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);
}
#endregion
}- Twilio
- Plivo
- Nexmo
- Sinch
- Send Sms
- [] Voice Sms
- [] Send Bulk Sms
- Response Result
- Voice Sms
- Bulk Sms
Reach out to me at one of the following places!
- Email ✉️ at
toaashishpatel@gmail.com - NuGet 📦 at
@iamaashishpatel
- Ashish Patel - A-Patel
| GitHub | Tumblr | Website | ||||
|---|---|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
 |
This project is licensed under the MIT License - see the LICENSE file for details