Sinch 0.1.8-alpha

.NET SDK

Welcome to Sinch's .NET SDK.

Here you'll find documentation to start developing C# code using Sinch services.

To use this SDK you'll need a Sinch account and API keys. Please sign up at sinch.com

For more in depth version of the Sinch APIs, please refer to the official developer portal - developers.sinch.com

[!WARNING] This SDK is currently available as a technical preview. It is being provided for the purpose of collecting feedback, and should not be used in production environments.

• Installation
• Getting started
• Products
• Handling Exceptions
• Client customization options

Installation

SinchSDK can be installed using the Nuget package manager or the dotnet CLI.

dotnet add package Sinch

Getting started

Client initialization

To initialize communication with Sinch backed, credentials obtained from Sinch portal have to be provided to the main client class of this SDK.

[!NOTE] Always store your credentials securely as an environment variables or with a secret manager

using Sinch;

var sinch = new SinchClient(configuration["Sinch:KeyId"], configuration["Sinch:KeySecret"], configuration["Sinch:ProjectId"]);

To configure Conversation and SMS regions, use options:

var sinch = new SinchClient(
    configuration["Sinch:KeyId"],
    configuration["Sinch:KeySecret"], 
    configuration["Sinch:ProjectId"],
    options =>
    {
        options.SmsRegion = Sinch.SMS.SmsRegion.Eu;
        options.ConversationRegion = Sinch.Conversation.ConversationRegion.Eu;
    });

With ASP.NET dependency injection:

// SinchClient is thread safe so it's okay to add it as a singleton
builder.Services.AddSingleton<ISinch>(x => new SinchClient(
    builder.Configuration["Sinch:KeyId"],
    builder.Configuration["Sinch:KeySecret"],
    builder.Configuration["Sinch:ProjectId"]));

Products

Sinch client provides access to the following Sinch products:

• Numbers
• SMS
• Work-in-Progress Conversation API

Usage example of the numbers product:

Sinch.Numbers.Active.List.Response response = await sinch.Numbers.Active.List(new Sinch.Numbers.Active.List.Request
{
    RegionCode = "US",
    Type = Types.Mobile
});

Handling exceptions

For an unsuccessful API calls ApiException will be thrown.

using Sinch;

try {
    var batch = await sinch.Sms.Batches.Send(new Sinch.SMS.Batches.Send.Request
    {
        Body = "Hello, World!",
        DeliveryReport = DeliveryReport.None,
        To = new List<string>()
        {
            123456789
        }
    });
}
catch(ApiException e) 
{
    logger.LogError("Api Exception. Status: {status}. Detailed message: {message}", e.Status, e.DetailedMessage);
}

Logging, HttpClient, and additional options

To configure logger, provide own HttpClient, and additional options utilize SinchOptions within constructor:

var sinch = new SinchClient(
    configuration["Sinch:KeyId"],
    configuration["Sinch:KeySecret"], 
    configuration["Sinch:ProjectId"],
    options =>
    {
        // provde any logger factory which satisfies Microsoft.Extensions.Logging.ILoggerFactory
        options.LoggerFactory = LoggerFactory.Create(config => { 
            // add log output to console
            config.AddConsole();
        });
        // Provide your http client here
        options.HttpClient = new HttpClient();
        // Set a region for SMS product
        options.SmsRegion = Sinch.SMS.SmsRegion.Eu;
    });