Sinch 0.1.15-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 --prerelease

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 hosting regions, use options:

var sinch = new SinchClient(
    configuration["Sinch:KeyId"],
    configuration["Sinch:KeySecret"], 
    configuration["Sinch:ProjectId"],
    options =>
    {
        options.SmsHostingRegion = Sinch.SMS.SmsHostingRegion.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
• Verification
• Voice
• Work-in-Progress Conversation

Usage example of the numbers product, assuming sinch is a type of ISinchClient:

using Sinch.Numbers.Active.List;

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

Handling exceptions

For an unsuccessful API calls SinchApiException will be thrown.

using Sinch;
using Sinch.SMS.Batches.Send;

try {
    var batch = await sinch.Sms.Batches.Send(new SendBatchRequest
    {
        Body = "Hello, World!",
        DeliveryReport = DeliveryReport.None,
        To = new List<string>()
        {
            123456789
        }
    });
}
catch(SinchApiException 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:

using Sinch;
using Sinch.SMS;

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 hosting region for Sms
        options.SmsHostingRegion = SmsHostingRegion.Eu;
    });