NiazpardazSms 1.0.2

NiazpardazSms SDK for .NET

کتابخانه رسمی .NET برای کار با API پیامکی نیازپرداز

نصب

Package Manager

Install-Package NiazpardazSms

.NET CLI

dotnet add package NiazpardazSms

شروع سریع

using NiazpardazSms;

// ساخت کلاینت با API Key
var client = new NiazpardazSmsClient("YOUR_API_KEY");

// ارسال پیامک
var result = await client.SendAsync(
    fromNumber: "10001234",
    toNumber: "09123456789",
    message: "سلام از نیازپرداز!"
);

if (result.ResultCode == SendResultCode.SendWasSuccessful)
{
    Console.WriteLine($"BatchSmsId: {result.BatchSmsId}");
}

امکانات

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

var result = await client.SendAsync(
    fromNumber: "10001234",
    toNumber: "09123456789",
    message: "متن پیامک",
    isFlash: false,
    sendDelay: null
);

Console.WriteLine($"شناسه ارسال: {result.BatchSmsId}");
Console.WriteLine($"وضعیت: {result.ResultCode}");

ارسال گروهی (یک متن به چند شماره)

var result = await client.SendBulkAsync(
    fromNumber: "10001234",
    toNumbers: new[] { "09123456789", "09198765432" },
    message: "پیام گروهی",
    isFlash: false
);

Console.WriteLine($"شناسه ارسال: {result.BatchSmsId}");
Console.WriteLine($"وضعیت: {result.ResultCode}");

ارسال LikeToLike (هر شماره پیام مخصوص خودش)

var result = await client.SendSmsLikeToLikeAsync(
    fromNumber: "10001234",
    toNumbers: new[] { "09123456789", "09198765432" },
    messages: new[] { "سلام علی جان", "سلام رضا جان" }
);

Console.WriteLine($"SmsId: {result.SmsId}");

ارسال پیامک صوتی OTP

var result = await client.SendVoiceOtpAsync(
    fromNumber: "10001234",
    toNumber: "09123456789",
    otp: "12345"
);

Console.WriteLine($"شناسه ارسال: {result.BatchSmsId}");
Console.WriteLine($"وضعیت: {result.ResultCode}");

گزارش تحویل ارسال گروهی

var delivery = await client.GetBatchDeliveryAsync(
    batchSmsId: 123456,
    pageIndex: 1,
    pageSize: 100
);

if (delivery.ResultCode == DeliveryResultCode.Success)
{
    for (int i = 0; i < delivery.Numbers.Length; i++)
    {
        Console.WriteLine($"{delivery.Numbers[i]}: {delivery.DeliveryStatus[i]}");
    }
}

گزارش تحویل ارسال LikeToLike

var delivery = await client.GetDeliveryLikeToLikeAsync(smsId: 789);

if (delivery.ResultCode == DeliveryResultCode.Success)
{
    for (int i = 0; i < delivery.Numbers.Length; i++)
    {
        Console.WriteLine($"{delivery.Numbers[i]}: {delivery.DeliveryStatus[i]}");
    }
}

اعتبار

var credit = await client.GetCreditAsync();
if (credit.ResultCode == CreditResultCode.Success)
{
    Console.WriteLine($"اعتبار: {credit.Credit}");
}

شماره‌های فرستنده

var senders = await client.GetSenderNumbersAsync();
foreach (var sender in senders.Senders)
{
    Console.WriteLine(sender);
}

تعداد پیامک‌های دریافتی

var inboxCount = await client.GetInboxCountAsync(isRead: false);
Console.WriteLine($"تعداد: {inboxCount.InboxCount}");

لیست پیامک‌ها

var messageResult = await client.GetMessagesAsync(
    messageType: 1,
    fromNumbers: "10001234",
    pageIndex: 1,
    pageSize: 50
);

if (messageResult.ResultCode == 0)
{
    foreach (var message in messageResult.Messages)
    {
        Console.WriteLine($"متن پیامک: {message.Content}");
    }
}

دریافت پیامک‌ها

var messageResult = await client.GetMessagesByDateRangeAsync(
    messageType: 1,
    fromNumbers: "10001234",
    fromDate: DateTime.Today.AddDays(-1),
    toDate: DateTime.Today
);

if (messageResult.ResultCode == 0)
{
    foreach (var message in messageResult.Messages)
    {
        Console.WriteLine($"متن پیامک: {message.Content}");
    }
}

لیست سیاه مخابرات (بررسی یک شماره)

var isBlack = await client.NumberIsInTelecomBlacklistAsync("09123456789");
Console.WriteLine($"در لیست سیاه: {isBlack.IsBlack}");

لیست سیاه مخابرات (استخراج شماره‌های لیست سیاه از یک لیست)

var blacklist = await client.ExtractTelecomBlacklistNumbersAsync(
    new[] { "09123456789", "09198765432", "09351234567" }
);

if (blacklist.ResultCode == BlacklistResultCode.Success)
{
    foreach (var number in blacklist.BlackListNumbers)
    {
        Console.WriteLine(number);
    }
}

بررسی محتوای پیامک

var check = await client.CheckSmsContentAsync("متن پیامک تست");
Console.WriteLine($"متن معتبر است: {check.IsValid}");

کدهای نتیجه

کدهای نتیجه ارسال (SendResultCode)

کدهای نتیجه گزارش تحویل (DeliveryResultCode)

وضعیت تحویل پیامک (SmsDeliveryStatus)

کدهای نتیجه اعتبار (CreditResultCode)

کدهای نتیجه لیست سیاه (BlacklistResultCode)

مدیریت خطا

using NiazpardazSms.Exceptions;

try
{
    var result = await client.SendAsync("10001234", "09123456789", "تست");
    
    if (result.ResultCode != SendResultCode.SendWasSuccessful)
    {
        Console.WriteLine($"خطا: {result.ResultCode}");
    }
}
catch (NiazpardazApiException ex)
{
    Console.WriteLine($"خطای API: {ex.Message}");
    Console.WriteLine($"کد خطا: {ex.ErrorCode}");
}
catch (HttpRequestException ex)
{
    Console.WriteLine($"خطای شبکه: {ex.Message}");
}

تنظیمات پیشرفته

استفاده از HttpClient سفارشی

var httpClient = new HttpClient();
httpClient.Timeout = TimeSpan.FromSeconds(30);

var client = new NiazpardazSmsClient("YOUR_API_KEY", httpClient);

Dependency Injection

// Program.cs
services.AddHttpClient<NiazpardazSmsClient>();
services.AddSingleton(sp => 
{
    var httpClient = sp.GetRequiredService<IHttpClientFactory>()
        .CreateClient(nameof(NiazpardazSmsClient));
    return new NiazpardazSmsClient("YOUR_API_KEY", httpClient);
});

سازگاری

• .NET Framework 4.6.1+
• .NET Core 2.0+
• .NET 5/6/7/8/9/10+
• Xamarin
• Unity

مجوز

MIT License

پشتیبانی

• 📚 مستندات: https://niazpardaz-sms.com/webservice
• 🐛 گزارش باگ: GitHub Issues