Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

MessageBird's REST API for C#

This repository contains the open source C# client for MessageBird's REST API. Documentation can be found at:

Build status NuGet version (MessageBird)


  • Sign up for a free MessageBird account
  • Create a new access_key in the developers sections
  • MessageBird API client for C# requires .NET Framework >= 4 or .NET Standard >= 2.0
  • It has a dependency on JSON.NET >= 4.5.6



The MessageBird project depends on JSON.NET, which can be installed using the NuGet package manager. For more information on how to achieve this, see 'Managing NuGet packages using the dialog'.


We have put some self-explanatory examples in the Examples project, but here is a quick breakdown on how it works. First, you need to set up a MessageBird.Client. Be sure to replace YOUR_ACCESS_KEY with something real.

using System;
using MessageBird;
using MessageBird.Objects;

class Example
  static void Main(string[] args)
    Client client = Client.CreateDefault("YOUR_ACCESS_KEY");

That's easy enough. Now we can query the server for information. Lets use getting your balance overview as an example:

// Get your balance
Balance balance = client.Balance();

Error handling

In case of an error the client throws an ErrorException. The ErrorException objects contains either:

  • an array of Error objects that encapsulates the errors in the response (see errors for more info),
  • a best effort description when no error information from the endpoint is available.

See the provided examples on how to access error information from the ErrorException.


Complete documentation, instructions, and examples are available at:


The MessageBird REST Client for C# is licensed under The ISC License. Copyright (c) 2014, Remco Vermeulen