Sinch .NET SDK for Conversation

The Sinch Conversation .NET SDK allows you to quickly interact with the Conversation API from inside your .NET applications. The fastest way to get started with the SDK is to check out our getting started guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.

Syntax

When using the .NET SDK, the code representing requests and queries sent to and responses received from the Conversation API are structured similarly to those that are sent and received using the Conversation API itself.

The code sample on the side of this page is an example of how to use the .NET SDK to send a text message on the SMS channel of a Conversation API app. The SDK code and Conversation API call that accomplishes the same task are displayed below for reference and comparison (note that this REST API example uses Basic Authentication instead of OAuth2):

using System.Text.Json;
using Sinch;
using Sinch.Conversation;
using Sinch.Conversation.Messages.Send;
using Sinch.Conversation.Messages.Message;
using Sinch.Conversation.Common;

var sinch = new SinchClient("YOUR_project_id",
    "YOUR_access_key",
    "YOUR_access_secret",
    // ensure you set the Conversation region. 
    options => options.ConversationRegion = ConversationRegion.Us);

var response = await sinch.Conversation.Messages.Send(new SendMessageRequest
{
    Message = new AppMessage(new TextMessage("Hello! Thank you for using the Sinch .NET SDK to send an SMS.")),
    AppId = "YOUR_app_id",
    Recipient = new Identified
    {
        IdentifiedBy = new IdentifiedBy
        {
            ChannelIdentities = new List<ChannelIdentity>
            {
                new ChannelIdentity
                {
                    AppId = "YOUR_app_id",
                    Identity = "RECIPIENT_number",
                    Channel = new ConversationChannel("SMS")
                }
            }
        }
    },
    ChannelProperties = new Dictionary<string, string> { { "SMS_SENDER", "YOUR_sms_sender" } }
});

Console.WriteLine(JsonSerializer.Serialize(response, new JsonSerializerOptions()
{
    WriteIndented = true
}));

// Find your App ID at dashboard.sinch.com/convapi/apps
// Find your Project ID at dashboard.sinch.com/settings/project-management
// Get your Access Key and Access Secret at dashboard.sinch.com/settings/access-keys
using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
using System.Net.Http.Headers;

public class Program
{
  public static async Task Main()
  {
    System.Net.Http.HttpClient client = new();

    string base64String = Convert.ToBase64String(Encoding.ASCII.GetBytes("YOUR_access_key:YOUR_access_secret"));
    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(@"Basic", base64String);

    string json = JsonSerializer.Serialize(new
    {
      app_id = "YOUR_app_id",
      recipient = new {
        identified_by = new {
          channel_identities = new[] {
            new {
              channel = "SMS",
              identity = "RECIPIENT_number"
            }
          },
        }
      },
      message = new {
        text_message = new {
          text = "This is a text message."
        }
      },
      channel_properties =  new {
        SMS_SENDER = "YOUR_sms_sender"
      } 
    });

    using StringContent postData = new(json, Encoding.UTF8, "application/json");
      var ProjectId = "YOUR_project_id";
      var Region = "us";
    using HttpResponseMessage request = await client.PostAsync("https://" + Region + ".conversation.api.sinch.com/v1/projects/" + ProjectId + "/messages:send", postData);
    string response = await request.Content.ReadAsStringAsync();

    Console.WriteLine(response);
  }
}

This example highlights the following required to successfully make a Conversation API call using the Sinch .NET SDK:

• Client initialization
• Conversation domain access
• Endpoint usage
• Field population

Client

When using the Sinch .NET SDK, you initialize communication with the Sinch backend by initializing the .NET SDK's main client class. This client allows you to access the functionality of the Sinch .NET SDK.

Initialization

Before initializing a client using this SDK, you'll need three pieces of information:

• Your Project ID
• An access key ID
• An access key Secret

To start using the SDK, you need to initialize the main client class with your credentials from your Sinch dashboard.

using Sinch;

var sinch = new SinchClient("YOUR_project_id",
                            "YOUR_access_key", 
                            "YOUR_access_secret");

builder.Services.AddSingleton<ISinchClient>(x => new SinchClient(
    builder.Configuration["YOUR_project_id"],
    builder.Configuration["YOUR_access_key"],
    builder.Configuration["YOUR_access_secret"]));

Conversation domain

Endpoint categories

In the Sinch .NET SDK, Conversation API endpoints are accessible through the client (either a general client or a Conversation-specific client). The naming convention of the endpoint's representation in the SDK matches the API:

• Messages
• Apps
• Contacts
• Events
• Transcoding
• Capability
• TemplatesV2
• Webhooks
• Conversations

For example:

var response = await sinch.Conversation.Messages.Send(new SendMessageRequest
{
    Message = new AppMessage(new TextMessage("Hello! Thank you for using the Sinch .NET SDK to send an SMS.")),
    AppId = "YOUR_app_id",
    Recipient = new Identified
    {
        IdentifiedBy = new IdentifiedBy
        {
            ChannelIdentities = new List<ChannelIdentity>
            {
                new ChannelIdentity
                {
                    AppId = "YOUR_app_id",
                    Identity = "RECIPIENT_number",
                    Channel = new ConversationChannel("SMS")
                }
            }
        }
    },
    ChannelProperties = new Dictionary<string, string> { { "SMS_SENDER", "YOUR_sms_sender" } }
});

Messages endpoint category

Apps endpoint category

Contacts endpoint category

Conversations endpoint category

Events endpoint category

Transcoding endpoint category

Capability endpoint category

Webhooks endpoint category

TemplatesV2 endpoint category

Request and query parameters

Requests and queries made using the .NET SDK are similar to those made using the Conversation API. Many of the fields are named and structured similarly. When translating field names from the Conversation API to the .NET SDK, remember that many of the API field names are in camelCase. In the .NET SDK, field names are in PascalCase. This pattern change manages almost all field name translations between the API and the SDK. For example:

AppId = "YOUR_app_id"

"app_id": "{APP_ID}"

var response = await sinch.Conversation.Messages.Get(
    messageId = "YOUR_message_id",
    messagesSource = "CONVERSATION_SOURCE"
    )
    

url = "https://us.conversation.api.sinch.com/v1/projects/" + project_id + "/messages/" + YOUR_message_id

payload = {
    "messages_source": "CONVERSATION_SOURCE"
}

Responses

Response fields match the API responses. They are delivered as .NET objects.