ForEach.Sms.SmsBox 0.1.0

dotnet add package ForEach.Sms.SmsBox --version 0.1.0
                    
NuGet\Install-Package ForEach.Sms.SmsBox -Version 0.1.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="ForEach.Sms.SmsBox" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ForEach.Sms.SmsBox" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="ForEach.Sms.SmsBox" />
                    
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 ForEach.Sms.SmsBox --version 0.1.0
                    
#r "nuget: ForEach.Sms.SmsBox, 0.1.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 ForEach.Sms.SmsBox@0.1.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=ForEach.Sms.SmsBox&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=ForEach.Sms.SmsBox&version=0.1.0
                    
Install as a Cake Tool

ForEach.Sms.SmsBox

The SMSBOX implementation of ISmsSender and ISmsGateway (package ForEach.Sms.Abstractions): talks to the SMSBOX REST API through a Refit client generated from its OpenAPI document.

services.AddSmsBox(options =>
{
    options.BaseUrl = "https://core.smsbox.be/api";   // the default
    options.ApiKey = configuration["SmsBoxApi:ApiKey"];
});

// ...
SmsSendResult result = await sender.SendAsync(new SmsMessage("32496123456", "Anouk", "Hello", "5612", apiKey: "site-key"), ct);
Member What it does
AddSmsBox Registers ISmsSender and ISmsGateway (scoped) on a typed Refit client and returns its IHttpClientBuilder, so the host can add handlers.
SmsBoxOptions.BaseUrl The API root. Defaults to https://core.smsbox.be/api.
SmsBoxOptions.ApiKey Sent on every request as X-Api-Key, unless a message carries its own key.
SmsBoxOptions.Timeout Per-request timeout, 30 seconds by default.
  • Per-message key. SmsMessage.ApiKey (a site's own SMSBOX account) wins over SmsBoxOptions.ApiKey for that one call; a blank value falls back to the configured key.
  • No retry, on purpose. The POST endpoints (send, one-time password, voice) are not idempotent, so an automatic retry could send a message twice and burn credits. A host that adds resilience to the returned builder should keep retries off those calls.
  • Codes are the host's. SMSBOX answers HTTP 200 for everything and carries the verdict in code. ISmsSender reports IsAccepted for code 100; ISmsGateway returns every reply with its raw Code.
  • Failures throw. A transport failure, a non-success HTTP status or an unreadable body (for example the error answers whose message is a string where the contract says a list) throws; the host decides how to report it.

Targets net8.0 and net10.0. Dependencies: Microsoft.Extensions.Http, Refit and Refit.HttpClientFactory. Source and release notes: https://github.com/foreach-rs/nuget-releases/tree/main/packages/Sms

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 is compatible.  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
0.1.0 56 11/19/2026