短信服务 SDK
C# / .NET SDK 接入指南
提供针对 .NET 平台的 Luosimao 短信 SDK。支持 .NET Standard 2.0+,完美兼容 .NET Core 3.1、.NET 5/6/7/8 以及 .NET Framework 4.6.1+。
环境要求: .NET Standard 2.0 及以上版本。
1. 安装
你可以通过 NuGet 包管理器安装此 SDK,详细信息可访问 NuGet 项目主页 查看:
.NET CLI
Terminal
dotnet add package Luosimao.Sms
Package Manager
Package Manager Console
Install-Package Luosimao.Sms
2. 快速开始
2.1 初始化客户端
Program.cs
using Luosimao.Sms;
// 初始化客户端,填入你的 API KEY
// 建议在应用启动时作为单例(Singleton)注入
var client = new LuosimaoClient("YOUR_API_KEY");
2.2 发送单条短信
SendSms.cs
try
{
// 短信内容末尾务必增加签名信息,例如:【公司名称】
var response = await client.SendAsync("13761428268", "验证码:123456【公司签名】");
if (response.Error == 0)
{
Console.WriteLine($"发送成功,批次号: {response.BatchId}");
}
else
{
Console.WriteLine($"发送失败,错误码: {response.Error}, 信息: {response.Msg}");
}
}
catch (LuosimaoException ex)
{
Console.WriteLine($"发生 SDK 异常: {ex.Message}");
}
2.3 批量发送短信
SendBatch.cs
var mobiles = new List { "13761428268", "18521513391" };
var message = "提醒:您的账号即将到期,请及时充值【公司签名】";
// 可选参数:time (定时发送时间)
var response = await client.SendBatchAsync(mobiles, message);
if (response.Error == 0)
{
Console.WriteLine($"批量任务提交成功,批次号: {response.BatchId}");
}
2.4 查询账户余额
GetBalance.cs
var response = await client.GetStatusAsync();
if (response.Error == 0)
{
Console.WriteLine($"当前账户短信余额: {response.Deposit} 条");
}
3. 异常处理
SDK 抛出的 LuosimaoException 包含了 API 返回的原始错误信息。你可以通过捕获该异常来处理网络超时或鉴权失败等全局问题。
注意: 生产环境下建议对 client 对象进行复用,避免频繁创建 HttpClient 导致的 Socket 耗尽问题。