ContactWise.Shared.StatusCodes 2.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ContactWise.Shared.StatusCodes --version 2.0.0
                    


                    

                
NuGet\Install-Package ContactWise.Shared.StatusCodes -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ContactWise.Shared.StatusCodes" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ContactWise.Shared.StatusCodes" Version="2.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ContactWise.Shared.StatusCodes" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ContactWise.Shared.StatusCodes --version 2.0.0
                    


                    

                
#r "nuget: ContactWise.Shared.StatusCodes, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ContactWise.Shared.StatusCodes@2.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ContactWise.Shared.StatusCodes&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ContactWise.Shared.StatusCodes&version=2.0.0
                    


                            Install as a Cake Tool

ContactWise.Shared.StatusCodes

A shared .NET 8 library that translates operator-specific SMS status codes (from DLR events) into standardized internal ContactWise categories.

Installation

dotnet add package ContactWise.Shared.StatusCodes

Usage

1. Register services

The consuming service must already have IMongoDatabase registered in its DI container.

builder.Services.AddSmsStatusTranslator(builder.Configuration);

2. Configure

{
  "SmsStatusTranslator": {
    "CacheRefreshIntervalMinutes": 5
  }
}

3. Translate status codes

public class DlrProcessor
{
    private readonly ISmsStatusTranslator _translator;

    public DlrProcessor(ISmsStatusTranslator translator)
    {
        _translator = translator;
    }

    public void ProcessDlr(Guid operatorId, string rawStatusCode)
    {
        var result = _translator.Translate(operatorId, rawStatusCode);

        // result.Code          → "SUBSCRIBER_UNAVAILABLE"
        // result.Description   → "Subscriber Unavailable / Absent"
        // result.Status        → "Failed"
        // result.IsSuccess     → false
        // result.IsRetryable   → true
        // result.IsFallback    → false
    }
}

How It Works

  1. Looks up in-memory cache for exact match on (operatorId, operatorCode) — returns with IsFallback = false
  2. No match — uses operator's configured default code, logs WARNING — returns with IsFallback = true
  3. Unknown operator — logs ERROR — returns hardcoded UNKNOWN_ERROR with IsFallback = true

The cache loads from MongoDB on startup and refreshes periodically (default: every 5 minutes).

MongoDB Collections

The library reads from three MongoDB collections that must be seeded before use:

Collection Purpose
cfg_sms_status_codes Internal status categories (DELIVERED, INVALID_DESTINATION, etc.)
cfg_operators SMS gateway operators with default codes
cfg_operator_codes Maps operator-specific codes to internal categories

License

MIT License. See LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.0 124 2/23/2026
1.1.0 110 2/23/2026
1.0.0 110 2/23/2026