/nexmo-dotnet

Nexmo REST API client for .NET, ASP.NET, ASP.NET MVC written in C#. API support for SMS, Voice, Text-to-Speech, Numbers, Verify (2FA) and more.

Primary LanguageC#MIT LicenseMIT

Nexmo Client Library for C#/.NET

If you are looking for VS2017, .NET Standard 2.0, or ASP.NET Core 2 support, please try the latest v3.0.0-pre release.

If you are having trouble with file-based configuration (weird errors, config not found), the v3.0.0-pre release allows for configuration via code and instance methods.

v3.0 is a work in progress and subject to breaking changes. Please look at the 3.0 milestones or the branch for more info.

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.

Installation:

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.Client

Alternatively:

  • 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.

Configuration:

  • 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": "<YOUR KEY>",
    "Nexmo.api_secret": "<YOUR SECRET>",
    
    "Nexmo.Application.Id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
    "Nexmo.Application.Key": "c:\\path\\to\\your\\application\\private.key"
  }
}
  • In v2.1.0+, you may also continue to use web.config for configuration:
<appSettings>
  <add key="Nexmo.UserAgent" value="myApp/1.0" />
  <add key="Nexmo.Url.Rest" value="https://rest.nexmo.com" />
  <add key="Nexmo.Url.Api" value="https://api.nexmo.com" />
  <add key="Nexmo.api_key" value="<YOUR KEY>" />
  <add key="Nexmo.api_secret" value="<YOUR SECRET>" />
</appSettings>

  • In the event multiple configuration files are found, the order of precedence is as follows:

    • appsettings.json which overrides
    • settings.json which overrides
    • <executing process name>.config which overrides
    • app.config which overrides
    • web.config

  • As you are able, please move your project to JSON configuration as XML configuration will be going away in a future release.

Configuration Reference

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 Path to your application key
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.Api.EnsureSuccessStatusCode Optional. Defaults to false. If true, EnsureSuccessStatusCode will be called against each response. If the response has a failure HTTP status code, a HttpRequestException will be thrown.
Nexmo.UserAgent Optional. Your app-specific usage identifier in the format of name/version. Example: "myApp/1.0"

Logging

From 2.2.0 onward, 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.

Examples

We are working on a separate repository for .NET examples. Check it out here!

The following examples show how to:

Sending a Message

Use Nexmo's SMS API to send a SMS message.

var results = SMS.Send(new SMS.SMSRequest
{
    from = "15555551212",
    to = "17775551212",
    text = "this is a test"
});

Receiving a Message

Use Nexmo's SMS API to receive a SMS message. Assumes your Nexmo endpoint is configured.

public ActionResult Get([FromUri]SMS.SMSInbound response)
{
    return new HttpStatusCodeResult(HttpStatusCode.OK);
}

Receiving a Message Delivery Receipt

Use Nexmo's SMS API to receive a SMS delivery receipt. Assumes your Nexmo endpoint is configured.

public ActionResult DLR([FromUri]SMS.SMSDeliveryReceipt response)
{
    Debug.WriteLine("-------------------------------------------------------------------------");
    Debug.WriteLine("DELIVERY RECEIPT");
    Debug.WriteLine("Message ID: " + response.messageId);
    Debug.WriteLine("From: " + response.msisdn);
    Debug.WriteLine("To: " + response.to);
    Debug.WriteLine("Status: " + response.status);
    Debug.WriteLine("-------------------------------------------------------------------------");

    return new HttpStatusCodeResult(HttpStatusCode.OK);
}

NOTE: [FromUri] is deprecated in .NET Core; [FromQuery] works in this case.

Initiating a Call

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.

using Nexmo.Api.Voice;

Call.Do(new Call.CallCommand
{
    to = new[]
    {
        new Call.Endpoint {
            type = "phone",
            number = "15555551212"
        }
    },
    from = new Call.Endpoint
    {
        type = "phone",
        number = "15557772424"
    },
    answer_url = new[]
    {
        "https://nexmo-community.github.io/ncco-examples/first_call_talk.json"
    }
});

Receiving a Call

Use Nexmo's Voice API to receive a voice call.

using Nexmo.Api.Voice;

public ActionResult GetCall(string id)
{
    var call = Call.Get(id);
    // Do something with call.
}

Sending 2FA Code

Use Nexmo's Verify API to send 2FA pin code.

public ActionResult Start(string to)
{
    var start = NumberVerify.Verify(new NumberVerify.VerifyRequest
    {
        number = to,
        brand = "NexmoQS"
    });
    Session["requestID"] = start.request_id;

    return View();
}

Checking 2FA Code

Use Nexmo's Verify API to check 2FA pin code.

public ActionResult Check(string code)
{
    var result = NumberVerify.Check(new NumberVerify.CheckRequest
    {
        request_id = Session["requestID"].ToString(),
        code = code
    });
   
    if (result.status == "0")
    {
        ViewBag.Message = "Verification Sucessful";
    }
    else
    {
        ViewBag.Message = result.error_text;
    }
    return View();
}

Additional Examples

  • Check out the sample MVC application and tests for more examples. Make sure to copy appsettings.json.example/web.config.example to appsettings.json/web.config and enter your key/secret.

API Coverage

  • 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

Contributing

Targeted frameworks:

  • 4.5.2
  • 4.6, 4.6.1, 4.6.2
  • .NET Standard 1.6

Visual Studio 2015 is required (Community should be fine). Update 3 is recommended.

As VS2015 support for .NET Core has evolved, the user experience has changed. If you would like to compile from source straight from a git clone, The solution currently targets v1.0.1 (1.0.0-preview2-003131) and requires that version of the SDK to be present.

Please note that the 3.0 branch has been upgraded to Visual Studio 2017 which is a much smoother dev experience and highly recommended.

  1. Get latest code either by cloning the repository or downloading a snapshot of the source.
  2. Open "Nexmo.Api.sln"
  3. Build! NuGet dependencies should be brought down automatically; check your settings if they are not.

Pull requests are welcome!

Thanks

Special thanks to our contributors:

License

This library is released under the MIT License