This SDK has moved! The Nexmo.Csharp.Client NuGet package is now listed as Vonage in NuGet. The source code is located at vonage/vonage-dotnet-sdk. We will continue to support this repository and it's NuGet package for 12 months, ending October 2021, with any needed bug or security fixes for the last release of v5.2.0. New features will be released under the Vonage NuGet package. To take advantage of those new features, please make sure to switch to the Vonage package as soon as possible!
You can use this C# client library to integrate Nexmo's APIs to your application. To use this, you'll need a Nexmo account. Sign up for free at nexmo.com.
To use the client library you'll need to have created a Nexmo account.
To install the C# client library using NuGet:
- Run the following command in the Package Manager Console:
Install-Package Nexmo.Csharp.ClientAlternatively:
- Download or build (see developer instructions) the
Nexmo.Api.dll. - If you have downloaded a release, ensure you are referencing the required dependencies by either including them with your project's NuGet dependencies or manually referencing them.
- Reference the assembly in your code.
- 4.5.2
NOTE: for 4.5.2 frameworks you will need to enable TLS 1.2 either via registry or by setting it globablly -
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
- 4.6
- .NET Standard 2.0 - supports everything 4.6.1 and above
To setup the configuration of the Nexmo Client you can do one of the following.
- Create a Nexmo 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)
var credentials = Credentials.FromApiKeyAndSecret(
NEXMO_API_KEY,
NEXMO_API_SECRET
);
var nexmoClient = new NexmoClient(credentials);var results = client.SMS.Send(request: new SMS.SMSRequest
var response = nexmoClient.SmsClient.SendAnSms(new Nexmo.Api.Messaging.SendSmsRequest()
{
To = TO_NUMBER,
From = NEXMO_BRAND_NAME,
Text = "A text message sent using the Nexmo SMS API"
});Or
- Provide the nexmo URLs, API key, secret, and application credentials (for JWT) in
appsettings.json:
{
"appSettings": {
"Nexmo.UserAgent": "myApp/1.0",
"Nexmo.Url.Rest": "https://rest.nexmo.com",
"Nexmo.Url.Api": "https://api.nexmo.com",
"Nexmo.api_key": "NEXMO-API-KEY",
"Nexmo.api_secret": "NEXMO-API-SECRET",
"Nexmo.Application.Id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"Nexmo.Application.Key": "NEXMO_APPLICATION_PRIVATE_KEY"
}
}Note: In the event multiple configuration files are found, the order of precedence is as follows:
* ```appsettings.json``` which overrides
* ```settings.json```
Or
- Access the Configuration instance and set the appropriate key in your code for example:
Configuration.Instance.Settings["appSettings:Nexmo.Url.Api"] = "https://www.example.com/api";
Configuration.Instance.Settings["appSettings:Nexmo.Url.Rest"] = "https://www.example.com/rest";
NOTE: Private Key is the literal key - not a path to the file containing the key
| Key | Description |
|---|---|
| Nexmo.api_key | Your API key from the dashboard |
| Nexmo.api_secret | Your API secret from the dashboard |
| Nexmo.Application.Id | Your application ID |
| Nexmo.Application.Key | Your application's private key |
| Nexmo.security_secret | Optional. This is the signing secret that's used for signing SMS |
| Nexmo.signing_method | Optional. This is the method used for signing SMS messages |
| Nexmo.Url.Rest | Optional. Nexmo REST API base URL. Defaults to https://rest.nexmo.com |
| Nexmo.Url.Api | Optional. Nexmo API base URL. Defaults to https://api.nexmo.com |
| Nexmo.Api.RequestsPerSecond | Optional. Throttle to specified requests per second. |
| Nexmo.UserAgent | Optional. Your app-specific usage identifier in the format of name/version. Example: "myApp/1.0" |
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 Nexmo library how to log. For example, to log to the console with serilog you can do the following:
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Configuration;
using Nexmo.Api.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);The library makes use of LibLog to facilitate logging.
Your application controls if and how logging occurs. Example using Serilog and Serilog.Sinks.Console v3.x:
using Nexmo.Api.Request;
using Serilog;
// set up logging at startup
var log = new LoggerConfiguration()
.MinimumLevel.Debug()
.WriteTo.Console(outputTemplate: "{Timestamp:HH:mm} [{Level}] ({Name:l}) {Message}")
.CreateLogger();
Log.Logger = log;
Log.Logger.Debug("start");
var client = new Nexmo.Api.Client(new Credentials("example", "password"));
client.Account.GetBalance();
Log.Logger.Debug("end");You can request console logging by placing a logging.json file alongside your appsettings.json configuration.
Note that logging Nexmo.Api messages will very likely expose your key and secret to the console as they can be part of the query string.
Example logging.json contents that would log all requests as well as major configuration and authentication errors:
{
"IncludeScopes": "true",
"LogLevel": {
"Default": "Debug",
"Nexmo.Api": "Debug",
"Nexmo.Api.Authentication": "Error",
"Nexmo.Api.Configuration": "Error"
}
}You may specify other types of logging (file, etc.). The Nexmo.Samples.Coverage project contains an example that logs to a file with the assistance of Serilog.Extensions.Logging.File.
We are working on a separate repository for .NET examples. Check it out here!
The following examples show how to:
- Send a message
- Receive a message
- Receive a message delivery receipt
- Redact a message
- Initiate a call
- Receive a call
- Send 2FA code
- Check 2FA code
Use Nexmo's SMS API to send an SMS message.
var credentials = Credentials.FromApiKeyAndSecret(
NEXMO_API_KEY,
NEXMO_API_SECRET
);
var nexmoClient = new NexmoClient(credentials);
var response = nexmoClient.SmsClient.SendAnSms(new Nexmo.Api.Messaging.SendSmsRequest()
{
To = TO_NUMBER,
From = NEXMO_BRAND_NAME,
Text = "A text message sent using the Nexmo SMS API"
});Use Nexmo's SMS API to receive an SMS message. Assumes your Nexmo 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.
[HttpGet("webhooks/inbound-sms")]
public async Task<IActionResult> InboundSmsGet()
{
var inbound = Nexmo.Api.Utility.WebhookParser.ParseQuery<InboundSms>(Request.Query);
return NoContent();
}[HttpPost("webhooks/inbound-sms")]
public async Task<IActionResult> InboundSms()
{
var inbound = await Nexmo.Api.Utility.WebhookParser.ParseWebhookAsync<InboundSms>(Request.Body, Request.ContentType);
return NoContent();
}[HttpGet]
[Route("webhooks/inbound-sms")]
public async Task<HttpResponseMessage> GetInbound()
{
var inboundSms = WebhookParser.ParseQueryNameValuePairs<InboundSms>(Request.GetQueryNameValuePairs());
return new HttpResponseMessage(HttpStatusCode.NoContent);
}[HttpPost]
[Route("webhooks/inbound-sms")]
public async Task<HttpResponseMessage> PostInbound()
{
var inboundSms = WebhookParser.ParseWebhook<InboundSms>(Request);
return new HttpResponseMessage(HttpStatusCode.NoContent);
}Use Nexmo's SMS API to receive an SMS delivery receipt. Assumes your Nexmo 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.
[HttpGet("webhooks/dlr")]
public async Task<IActionResult> InboundSmsGet()
{
var dlr = Nexmo.Api.Utility.WebhookParser.ParseQuery<DeliveryReceipt>(Request.Query);
return NoContent();
}[HttpPost("webhooks/dlr")]
public async Task<IActionResult> InboundSms()
{
var dlr = await Nexmo.Api.Utility.WebhookParser.ParseWebhookAsync<DeliveryReceipt>(Request.Body, Request.ContentType);
return NoContent();
}[HttpGet]
[Route("webhooks/dlr")]
public async Task<HttpResponseMessage> GetInbound()
{
var dlr = WebhookParser.ParseQueryNameValuePairs<DeliveryReceipt>(Request.GetQueryNameValuePairs());
return new HttpResponseMessage(HttpStatusCode.NoContent);
}[HttpPost]
[Route("webhooks/dlr")]
public async Task<HttpResponseMessage> PostInbound()
{
var dlr = WebhookParser.ParseWebhook<DeliveryReceipt>(Request);
return new HttpResponseMessage(HttpStatusCode.NoContent);
}Use Nexmo's Redact API to redact a SMS message.
var credentials = Credentials.FromApiKeyAndSecret(NEXMO_API_KEY, NEXMO_API_SECRET);
var client = new NexmoClient(credentials);
var request = new RedactRequest() { Id = NEXMO_REDACT_ID, Type = NEXMO_REDACT_TYPE, Product = NEXMO_REDACT_PRODUCT };
var response = client.RedactClient.Redact(request);Use Nexmo's Voice API to initiate a voice call.
NOTE: You must have a valid Application ID and private key in order to make voice calls. Use either Nexmo.Api.Application or Nexmo's Node.js-based CLI tool to register. See the Application API documentation for details.
var creds = Credentials.FromAppIdAndPrivateKeyPath(NEXMO_APPLICATION_ID, NEXMO_PRIVATE_KEY_PATH);
var client = new NexmoClient(creds);
var command = new CallCommand() { To = new Endpoint[] { toEndpoint }, From = fromEndpoint, AnswerUrl=new[] { ANSWER_URL}};
var response = client.VoiceClient.CreateCall(command);Use Nexmo's Voice API to receive a voice call.
[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();
}var credentials = Credentials.FromAppIdAndPrivateKeyPath(NEXMO_APPLICATION_ID, NEXMO_PRIVATE_KEY_PATH);
var client = new NexmoClient(credentials);
var response = client.VoiceClient.GetCall(UUID);Use Nexmo's Verify API to send 2FA pin code.
var credentials = Credentials.FromApiKeyAndSecret(NEXMO_API_KEY, NEXMO_API_SECRET);
var client = new NexmoClient(credentials);
var request = new VerifyRequest() { Brand = BRAND_NAME, Number = RECIPIENT_NUMBER };
var response = client.VerifyClient.VerifyRequest(request);Use Nexmo's Verify API to check 2FA pin code.
var credentials = Credentials.FromApiKeyAndSecret(NEXMO_API_KEY, NEXMO_API_SECRET);
var client = new NexmoClient(credentials);
var request = new VerifyCheckRequest() { Code = CODE, RequestId = REQUEST_ID };
var response = client.VerifyClient.VerifyCheck(request);- Check out the sample MVC application and tests for more examples. Make sure to copy appsettings.json.example to appsettings.json and enter your key/secret.
- Account
- Balance
- Pricing
- Settings
- Top Up
- Numbers
- Search
- Buy
- Cancel
- Update
- Number Insight
- Basic
- Standard
- Advanced
- Webhook Notification
- Verify
- Verify
- Check
- Search
- Control
- Search
- Message
- Messages
- Rejections
- Messaging
- Send
- Delivery Receipt
- Inbound Messages
- Search
- Message
- Messages
- Rejections
- US Short Codes
- Two-Factor Authentication
- Event Based Alerts
- Sending Alerts
- Campaign Subscription Management
- Application
- Create
- List
- Update
- Delete
- Call
- Outbound
- Get
- List
- Edit
- TTS
- Stream
- DTMF
Visual Studio 2017 is required (Community is fine). v15.5+ is recommended.
- Get the latest code either by cloning the repository or downloading a snapshot of the source.
- Open "Nexmo.Api.sln"
- Build! NuGet dependencies should be brought down automatically; check your settings if they are not.
Pull requests are welcome!
Special thanks to our contributors:
This library is released under the MIT License.