Before you can get started, you need the following already set up:
Set all Conversation API configuration settings.
The latest version of .NET with Long Term Support and a familiarity with how to create a new console app.
Learn how to quickly send Conversation messages in a .NET application with the Sinch .NET SDK.
Create a new folder where you want your app project. Then, open a terminal or command prompt to that location.
Create a new .NET console app with the following command:
dotnet new console
The easiest way to install the SDK is using the
dotnet
CLI:- Open a command prompt or terminal to the local repository folder.
- Execute the following command:
dotnet add package Sinch
Open the
Program.cs
file in your project folder. Replace everything in the file with the "Send a Conversation message" code.
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
}));
The code provided includes placeholder parameters. You'll need to update the parameters detailed in the following subsections with your values.
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
These values can be found on the <b>Access Keys</b> page of the Sinch Build Dashboard. You can also create new access key IDs and Secrets, if required.
If you have trouble accessing the above link, ensure that you have gained access to the Conversation API by accepting the corresponding terms and conditions.
To start using the SDK, you need to initialize the main client class with your credentials from your Sinch dashboard.
For testing purposes on your local environment it's fine to use hardcoded values, but before deploying to production we strongly recommend using environment variables to store the credentials.
using Sinch;
var sinch = new SinchClient("YOUR_project_id",
"YOUR_access_key",
"YOUR_access_secret");
You can also implement the client using ASP.NET dependency injection. SinchClient
is thread safe, so it's fine to add it as a singleton:
builder.Services.AddSingleton<ISinchClient>(x => new SinchClient(
builder.Configuration["YOUR_project_id"],
builder.Configuration["YOUR_access_key"],
builder.Configuration["YOUR_access_secret"]));
Assign your values to the following parameters:
Placeholder value | Your value |
---|---|
YOUR_app_id | Find your app ID on your Sinch [dashboard](https://dashboard.sinch.com/convapi/apps). |
YOUR_channel | The channel you want to use to send the message. This guide presets this channel property to SMS , but you may update it to any channel that's already configured on your Conversation API app. You may add the following channels to your app from the [Sinch Build Dashboard](https://dashboard.sinch.com/settings/access-keys):
|
RECIPIENT_number | The channel identity of the recipient to which you want to send the message. When using the SMS channel, this will be a phone number. |
YOUR_sms_sender | Your Sinch virtual phone number, available on the [Sinch Build Dashboard](https://dashboard.sinch.com/numbers/your-numbers). This is only required if you are using the SMS channel. |
Ensure that you save the file.
Before executing your code, you must first compile your application. Execute the following command:
dotnet build
Now you can execute the code and send your test message. Run the following command:
dotnet run
You should receive a text to the phone number you entered and you'll see a response in your terminal or command prompt. Press Enter
to exit the application. You did it!
The code you used in the Program.cs
file sends a POST request to the Sinch API /Messages
endpoint to send the text message. Click here to read more about the messages endpoint.
- Explore the API specification to test more endpoints.