Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vonage/vonage-dotnet-sdk
Vonage REST API client for .NET, written in C#. API support for SMS, Voice, Text-to-Speech, Numbers, Verify (2FA) and more.
https://github.com/vonage/vonage-dotnet-sdk
c-sharp developer-destination dotnet meetings phone proactive-connect server-sdk sms sms-api two-factor-authentication verify video voice voice-api vonage
Last synced: about 1 month ago
JSON representation
Vonage REST API client for .NET, written in C#. API support for SMS, Voice, Text-to-Speech, Numbers, Verify (2FA) and more.
- Host: GitHub
- URL: https://github.com/vonage/vonage-dotnet-sdk
- Owner: Vonage
- License: apache-2.0
- Created: 2015-03-27T18:32:22.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T18:43:55.000Z (10 months ago)
- Last Synced: 2024-04-12T17:58:28.208Z (10 months ago)
- Topics: c-sharp, developer-destination, dotnet, meetings, phone, proactive-connect, server-sdk, sms, sms-api, two-factor-authentication, verify, video, voice, voice-api, vonage
- Language: C#
- Homepage: https://developer.vonage.com/
- Size: 3.43 MB
- Stars: 104
- Watchers: 31
- Forks: 80
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Vonage Client Library for .NET
===================================
[](https://www.nuget.org/packages/Vonage/)
[](https://github.com/Vonage/vonage-dotnet-sdk/actions/workflows/net-build.yml/badge.svg)
[](https://github.com/Vonage/vonage-dotnet-sdk/actions/workflows/multiframework-build.yml/badge.svg)
[](https://sonarcloud.io/summary/new_code?id=Vonage_vonage-dotnet-sdk)
[](https://sonarcloud.io/summary/new_code?id=Vonage_vonage-dotnet-sdk)
[](https://codescene.io/projects/29782)
[](https://dashboard.stryker-mutator.io/reports/github.com/Vonage/vonage-dotnet-sdk/Vonage/main)
[](CODE_OF_CONDUCT.md)
This library allows you to integrate feature from [Vonage's APIs](#supported-apis) to your application.
It requires you to create
a [Vonage account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library)
first.
* [Installation](#installation)
* [Migration guides](#migration-guides)
* [Upgrading from v6.x.x to v7.0.0](#upgrading-from-v6xx-to-v700)
* [Upgrading from v5.x.x to v6.0.0](#upgrading-from-v5xx-to-v600)
* [Migrating from OpenTok for Video API](#migrating-from-opentok-for-video-api)
* [Targeted frameworks](#targeted-frameworks)
* [Tested frameworks](#tested-frameworks)
* [Configuration](#configuration)
* [Setup](#setup)
* [Lazy registration (recommended for .NET Core and above)](#lazy-registration-recommended-for-net-core-and-above)
* [Manual initialization (recommended for .NET Framework)](#manual-initialization-recommended-for-net-framework)
* [Configuration reference](#configuration-reference)
* [Logging](#logging)
* [Monads](#monads)
* [Result](#result)
* [Maybe](#maybe)
* [What if you don't want to use Monads?](#what-if-you-dont-want-to-use-monads)
* [Examples](#examples)
* [Supported APIs](#supported-apis)
* [FAQ](#faq)
* [Contributing](#contributing)
* [Thanks](#thanks)
* [Licence](#license)
## Installation
### Migration guides
#### Upgrading from v6.x.x to v7.0.0
Please see the dedicated [migration guide](MIGRATION_v7.0.0.md).
#### Upgrading from v5.x.x to v6.0.0
Changes in version 6.0.0
* Enum values are now capitalised in alignment with accepted coding practices and are Pascal Case
* All classes that were marked as deprecated in 5.x are now removed
* NCCO now inherits from List, it no longer has the `Actions` property, to add an action use `ncco.Add(action);`
* Strings with values "true" or "false" are now represented as `bool` in code
### Migrating from OpenTok for Video API
If you are migrating from the OpenTok .NET SDK to the Vonage .NET SDK, please see the
dedicated [migration guide](OPENTOK_TO_VONAGE_MIGRATION.md).
### Targeted frameworks
The SDK targets towards `netstandard2.0`.
It is compatible with any .NET projects targeting
a [supported version](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0).
### Tested frameworks
* .NET 6.0
* .NET 7.0
* .NET 8.0
For accessibility reasons, we removed all `.NET Framework` versions from our target frameworks.
we don't want to discourage people from contributing as Windows isn't the only development environment for .NET anymore.
Also, targeting older frameworks prevents us from using features from recent .NET and C# releases in our test project.
Nonetheless, it doesn't compromise our test results nor the compatibility with `.NET Framework` versions.
## Configuration
### Setup
There are various ways to initialize a `VonageClient` with your custom values.
Overall, we encourage you to specify your configuration (Vonage URLs, credentials, etc.) in `appsettings.json`, in
an `appsettings` section:
```json
{
"vonage": {
"UserAgent": "myApp/1.0",
"Url.Rest": "https://rest.nexmo.com",
"Url.Api": "https://api.nexmo.com",
"Url.Api.EMEA": "https://api-eu.vonage.com",
"Url.Api.AMER": "https://api-us.vonage.com",
"Url.Api.APAC": "https://api-ap.vonage.com",
"Url.Api.Video": "https://video.api.vonage.com",
"Api.Key": "VONAGE-API-KEY",
"Api.Secret": "VONAGE-API-SECRET",
"Application.Id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"Application.Key": "VONAGE_APPLICATION_PRIVATE_KEY",
"PooledConnectionIdleTimeout": "60",
"PooledConnectionLifetime": "600",
"Proxy": "https://example.com"
}
}
```
The configuration is automatically loaded in the `Configuration` singleton.
#### Lazy registration (recommended for .NET Core and above)
> Note: This implementation is not available for .NET Framework usages, given IConfiguration has been introduced in .NET
> Core.
You can register a client in your `IServiceCollection` using the following extension methods:
- `AddVonageClientScoped`: registers using Scoped registration.
- `AddVonageClientTransient`: registers using Transient registration.
``` csharp
// For 'Scoped' lifecycle
builder.Services.AddVonageClientScoped(builder.Configuration);
// Foor 'Transient' lifecycle
builder.Services.AddVonageClientTransient(builder.Configuration);
```
> Note: Using `builder.Configuration` allow us to use settings you decided to load at runtime, including
> environment-specific settings.
``` csharp
var credentials = ...
// For 'Scoped' lifecycle
builder.Services.AddVonageClientScoped(credentials);
// Foor 'Transient' lifecycle
builder.Services.AddVonageClientTransient(credentials);
```
It will register the main `VonageClient`, but also all sub client interfaces:
- IMessagesClient
- IVerifyV2Client
- IMeetingsClient
- IVoiceClient
- etc.
Finally, you can inject them in any of your components.
#### Manual initialization (recommended for .NET Framework)
Create a Vonage Client instance and pass in credentials in the constructor;
this will only affect the security credentials (Api Key, Api Secret, Signing Secret, Signing Method Private Key, App
Id).
```csharp
var credentials = Credentials.FromApiKeyAndSecret(
VONAGE_API_KEY,
VONAGE_API_SECRET
);
var vonageClient = new VonageClient(credentials);
```
If required, you can override values directly in the `Configuration` singleton:
```cshap
Configuration.Instance.Settings["vonage:Url.Api"] = "https://www.example.com/api";
Configuration.Instance.Settings["vonage:Url.Rest"] = "https://www.example.com/rest";
```
> Note: Private Key is the literal key - not a path to the file containing the key
> Note: Modifying the Configuration instance will be deprecated in the upcoming release, to keep the configuration
> immutable.
### Configuration Reference
| Key | Description |
|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Api.Key | Your API key from the [dashboard](https://dashboard.nexmo.com/settings) |
| Api.Secret | Your API secret from the [dashboard](https://dashboard.nexmo.com/settings) |
| Application.Id | Your application ID |
| Application.Key | Your application's private key |
| Security_secret | Optional. This is the signing secret that's used for [signing SMS](https://developer.nexmo.com/concepts/guides/signing-messages) |
| Signing_method | Optional. This is the method used for signing SMS messages |
| Url.Rest | Optional. Vonage REST API base URL. Defaults to https://rest.nexmo.com |
| Url.Api | Optional. Vonage API base URL. Defaults to https://api.nexmo.com |
| Url.Api.EMEA | Optional. Vonage API base URL for Europe, Middle East and Africa. Defaults to https://api-eu.vonage.com |
| Url.Api.AMER | Optional. Vonage API base URL for North, Central and South America. Defaults to https://api-us.vonage.com |
| Url.Api.APAC | Optional. Vonage API base URL for Asia and Pacific. Defaults to https://api-ap.vonage.com |
| Url.Api.Video | Optional. Vonage API base URL for Video. Defaults to https://video.api.vonage.com |
| RequestsPerSecond | Optional. Throttle to specified requests per second. |
| RequestTimeout | Optional. The timeout (in seconds) applied to every request. If not provided, the default timeout will be applied. |
| UserAgent | Optional. Your app-specific usage identifier in the format of `name/version`. Example: `"myApp/1.0"` |
| PooledConnectionIdleTimeout | Optional. The time (in seconds) that a connection can be idle before it is closed. Defaults to 60 seconds. |
| PooledConnectionLifetime | Optional. The time (in seconds) that a connection can be alive before it is closed. Defaults to 600 seconds. |
| Proxy | Optional. Sets a custom proxy URL for all HTTP requests |
### Logging
The Library uses Microsoft.Extensions.Logging to preform all of it's logging tasks. To configure logging for you app
simply create a new `ILoggerFactory` and call the `LogProvider.SetLogFactory()` method to tell the Vonage library how to
log. For example, to log to the console with serilog you can do the following:
```csharp
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Configuration;
using Vonage.Logger;
using Serilog;
var log = new LoggerConfiguration()
.MinimumLevel.Debug()
.WriteTo.Console(outputTemplate: "{Timestamp:HH:mm} [{Level}]: {Message}\n")
.CreateLogger();
var factory = new LoggerFactory();
factory.AddSerilog(log);
LogProvider.SetLogFactory(factory);
```
## Monads
Most recent features expose responses/results
using [Monads](https://www.adit.io/posts/2013-04-17-functors,_applicatives,_and_monads_in_pictures.html#just-what-is-a-functor,-really?).
While the name may be scary at first, this is just another data structure that offers various benefits.
We can picture them as a `box` containing our value, and we manipulate the box instead of manipulating a value.
Their purpose is to provide a value that can have multiple states, and deal with each state using a similar workflow.
This is a alternative to exception handling -
see [Railway Oriented Programming](https://fsharpforfunandprofit.com/posts/recipe-part2/).
### Result
The `Result` monad represents a value that can have one of the following states:
- `Success` - indicates the process was a success
- `Failure` - indicates the process failed
The goal is to provide an `exception-free` process.
- Transparency - the signature is fully transparent about the possible outputs (aka. a method **can** fail)
- Less intrusive - no `try-catch` required
```csharp
// This method allows to Divide a number
private static Result Divide(decimal value, decimal divider) =>
divider == 0
// If divider is 0, failure is returned
? Result.FromFailure(ResultFailure.FromErrorMessage("Cannot divide by 0."))
// If divider is allowed, success is returned
: Result.FromSuccess(value / divider);
```
### Maybe
The `Maybe` monad represents a value that can have one of the following states:
- `Some` - indicates the presence of a value
- `None` - indicates the absence of a value
The goal is to mitigate the 'billion-dollar mistake': `null`.
```csharp
// This method allows to retrieve phone number
private static Maybe Find(string number) =>
this.numbers.FirstOrDefault(phoneNumber => phoneNumber.Number.Equals(number))
?? Maybe.None;
```
### How to extract a value from a Monad?
Given we cannot predict the state at build-time, we need to provide an operation for **each** scenario.
The following methods are all available for both `Result` and `Maybe`, but examples will focus on `Result`.
#### Match
`.Match()` expects two operations, and will evaluate the one corresponding to the current state.
It supports transformation, and can be used with both `Actions` and `Functions`.
```csharp
Result monad = ...
// Supports transformation
string result = monad.Match(
// Will be executed if Result.IsSuccess
some => $"The process is a success: {some}.",
// Will be executed if Result.IsFailure
failure => $"The process is a failure: {failure.GetFailureMessage()}");
// Using Actions
monad.Match(
some => Console.WriteLine($"The process is a success: {some}."),
failure => Console.WriteLine($"The process is a failure: {failure.GetFailureMessage()}"));
```
#### IfFailure / IfNone
If you want to retrieve the value without transforming it, you can use `.IfFailure()` which expects a fallback value in
case the state is `Failure`.
```csharp
Result monad = ...
// Using the failure reason (recommended)
string result = monad.IfFailure(failure => $"The process is a failure: {failure.GetFailureMessage()}");
// Using a default value
string result = monad.IfFailure("Something failed.");
// Using an Action
monad.IfFailure(failure => Console.WriteLine($"The process is a failure: {failure.GetFailureMessage()}"));
```
### Features
Both `Result` and `Maybe` also exposes more capabilities:
- `Map`: transforms the value (if success/some) that will wrap the result into a new Monad.
- `Bind`: transforms the value (if success/some) that will return a new Monad.
- `Merge`: merges (or flatten) two monads.
- `IfSuccess` / `IfSome`: provide an operation that will be executed if the Monad is in the expected state.
- `IfFailure` / `IfNone`: provide an operation that will be executed if the Monad is in the expected state.
- Implicit operators
- Async support
- etc.
You can see how to benefit from these capabilities
in [our Tests](https://github.com/Vonage/vonage-dotnet-sdk/tree/main/Vonage.Common.Test/Monads).
### What if you don't want to use Monads?
You can use `GetUnsafe()` if you prefer having an exception thrown when a Monad is not in the desired state.
```csharp
Result result = ...
try
{
int output = result.GetSuccessUnsafe();
}
// The exception type cannot be defined at build-time
// It depends of the failure reason:
// - Authentication failure
// - Serialization/Deserialization failure
// - Http failure
// - Validation failure
// - etc.
catch (Exception exception)
{
...
}
```
```csharp
Maybe maybe = ...
try
{
int output = maybe.GetUnsafe();
}
catch (NoneStateException exception)
{
...
}
```
## Examples
All snippets are available in a separate [repository](https://github.com/Vonage/vonage-dotnet-code-snippets).
The following examples show how to:
* [Send a message](#sending-a-message)
* [Receive a message](#receiving-a-message)
* [Receive a message delivery receipt](#receiving-a-message-delivery-receipt)
* [Redact a message](#redacting-a-message)
* [Initiate a call](#initiating-a-call)
* [Receive a call](#receiving-a-call)
* [Send 2FA code](#sending-2fa-code)
* [Check 2FA code](#checking-2fa-code)
### Sending a Message
Use [Vonage's SMS API][doc_sms] to send an SMS message.
```csharp
var credentials = Credentials.FromApiKeyAndSecret(
VONAGE_API_KEY,
VONAGE_API_SECRET
);
var vonageClient = new VonageClient(credentials);
var response = await vonageClient.SmsClient.SendAnSmsAsync(new Vonage.Messaging.SendSmsRequest()
{
To = TO_NUMBER,
From = VONAGE_BRAND_NAME,
Text = "A text message sent using the Vonage SMS API"
});
```
### Receiving a Message
Use [Vonage's SMS API][doc_sms] to receive an SMS message. Assumes your Vonage webhook endpoint is configured.
The best method for receiving an SMS will vary depending on whether you configure your webhooks to be GET or POST. Will
Also Vary between ASP.NET MVC and ASP.NET MVC Core.
#### ASP.NET MVC Core
##### GET
```csharp
[HttpGet("webhooks/inbound-sms")]
public async Task InboundSmsGet()
{
var inbound = Vonage.Utility.WebhookParser.ParseQuery(Request.Query);
return NoContent();
}
```
##### POST
```csharp
[HttpPost("webhooks/inbound-sms")]
public async Task InboundSms()
{
var inbound = await Vonage.Utility.WebhookParser.ParseWebhookAsync(Request.Body, Request.ContentType);
return NoContent();
}
```
#### ASP.NET MVC
##### GET
```csharp
[HttpGet]
[Route("webhooks/inbound-sms")]
public async Task GetInbound()
{
var inboundSms = WebhookParser.ParseQueryNameValuePairs(Request.GetQueryNameValuePairs());
return new HttpResponseMessage(HttpStatusCode.NoContent);
}
```
##### POST
```csharp
[HttpPost]
[Route("webhooks/inbound-sms")]
public async Task PostInbound()
{
var inboundSms = WebhookParser.ParseWebhook(Request);
return new HttpResponseMessage(HttpStatusCode.NoContent);
}
```
### Receiving a Message Delivery Receipt
Use [Vonage's SMS API][doc_sms] to receive an SMS delivery receipt. Assumes your Vonage webhook endpoint is configured.
The best method for receiving an SMS will vary depending on whether you configure your webhooks to be GET or POST. Will
Also Vary between ASP.NET MVC and ASP.NET MVC Core.
#### ASP.NET MVC Core
##### GET
```csharp
[HttpGet("webhooks/dlr")]
public async Task InboundSmsGet()
{
var dlr = Vonage.Utility.WebhookParser.ParseQuery(Request.Query);
return NoContent();
}
```
##### POST
```csharp
[HttpPost("webhooks/dlr")]
public async Task InboundSms()
{
var dlr = await Vonage.Utility.WebhookParser.ParseWebhookAsync(Request.Body, Request.ContentType);
return NoContent();
}
```
#### ASP.NET MVC
##### GET
```csharp
[HttpGet]
[Route("webhooks/dlr")]
public async Task GetInbound()
{
var dlr = WebhookParser.ParseQueryNameValuePairs(Request.GetQueryNameValuePairs());
return new HttpResponseMessage(HttpStatusCode.NoContent);
}
```
##### POST
```csharp
[HttpPost]
[Route("webhooks/dlr")]
public async Task PostInbound()
{
var dlr = WebhookParser.ParseWebhook(Request);
return new HttpResponseMessage(HttpStatusCode.NoContent);
}
```
### Redacting a message
Use [Vonage's Redact API][doc_redact] to redact a SMS message.
```csharp
var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);
var request = new RedactRequest() { Id = VONAGE_REDACT_ID, Type = VONAGE_REDACT_TYPE, Product = VONAGE_REDACT_PRODUCT };
var response = await client.RedactClient.RedactAsync(request);
```
### Initiating a Call
Use [Vonage's Voice API][doc_voice] to initiate a voice call.
__NOTE:__ You must have a valid Application ID and private key in order to make voice calls. Use
either ```Vonage.Application``` or Vonage's Node.js-based [CLI tool](https://github.com/nexmo/nexmo-cli) to register.
See the [Application API][doc_app] documentation for details.
```csharp
var creds = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var client = new VonageClient(creds);
var command = new CallCommand() { To = new Endpoint[] { toEndpoint }, From = fromEndpoint, AnswerUrl=new[] { ANSWER_URL}};
var response = await client.VoiceClient.CreateCallAsync(command);
```
### Receiving a Call
Use [Vonage's Voice API][doc_voice] to receive a voice call.
```csharp
[HttpGet("webhooks/answer")]
public string Answer()
{
var talkAction = new TalkAction()
{
Text = $"Thank you for calling from " +
$"{string.Join(" ", Request.Query["from"].ToString().ToCharArray())}"
};
var ncco = new Ncco(talkAction);
return ncco.ToString();
}
```
### Get Details About a Call
```csharp
var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);
var response = await client.VoiceClient.GetCallAsync(UUID);
```
### Sending 2FA Code
Use [Vonage's Verify API][doc_verify] to send 2FA pin code.
```csharp
var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);
var request = new VerifyRequest() { Brand = BRAND_NAME, Number = RECIPIENT_NUMBER };
var response = await client.VerifyClient.VerifyRequestAsync(request);
```
### Checking 2FA Code
Use [Vonage's Verify API][doc_verify] to check 2FA pin code.
```C#
var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);
var request = new VerifyCheckRequest() { Code = CODE, RequestId = REQUEST_ID };
var response = await client.VerifyClient.VerifyCheckAsync(request);
```
## Supported APIs
The following is a list of Vonage APIs and whether the Vonage .NET SDK provides support for them:
| API | API Release Status | Supported? |
|-------------------------|:--------------------:|:----------:|
| Account API | General Availability | ✅ |
| Alerts API | General Availability | ✅ |
| Application API | General Availability | ✅ |
| Audit API | Beta | ❌ |
| Conversations API | General Availability | ✅ |
| Dispatch API | Beta | ❌ |
| External Accounts API | Beta | ❌ |
| Media API | Beta | ❌ |
| Meetings API | Sunset (Obsolete) | ❌ |
| Messages API | General Availability | ✅ |
| Number Insight API | General Availability | ✅ |
| Number Insight V2 API | General Availability | ✅ |
| Number Management API | General Availability | ✅ |
| Number Verification API | General Availability | ✅ |
| Pricing API | General Availability | ✅ |
| Proactive Connect API | Sunset (Obsolete) | ❌ |
| Redact API | Developer Preview | ✅ |
| Reports API | Beta | ❌ |
| SimSwap API | General Availability | ✅ |
| SMS API | General Availability | ✅ |
| SubAccounts API | General Availability | ✅ |
| Users API | General Availability | ✅ |
| Verify API | General Availability | ✅ |
| Verify V2 API | General Availability | ✅ |
| Video API | General Availability | ✅ |
| Voice API | General Availability | ✅ |
## Contributing
Pick your preferred IDE:
- Visual Studio (Community is fine)
- Visual Studio Code
- Jetbrains Rider
Keep in mind the SDK is built on `netstandard2.0` and tested against several framework versions (.NET6.0 and above).
Therefore, they should be installed on your machine for tests to run.
1. Get the latest code either by cloning the repository or downloading a snapshot of the source.
2. Open "Vonage.sln"
3. Build! NuGet dependencies should be brought down automatically; check your settings if they are not.
4. Tests! Run all the tests to verify everything's fine.
Pull requests are welcome!
## License
This library is released under [the MIT License][license].
[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library
[doc_sms]: https://developer.nexmo.com/api/sms?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library
[doc_voice]: https://developer.nexmo.com/voice/voice-api/overview?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library
[doc_verify]: https://developer.nexmo.com/verify/overview?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library
[doc_app]: https://developer.nexmo.com/concepts/guides/applications?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library
[doc_redact]: https://developer.nexmo.com/api/redact?utm_source=DEV_REL&utm_medium=github&utm_campaign=csharp-client-library
[license]: LICENSE.md