Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 2.57 KB

README.md

File metadata and controls

78 lines (54 loc) · 2.57 KB

MoceanAPI Client Library for C#/.NET

Latest Stable Version Build Status codecov codacy License Total Downloads

This is the C# client library for use Mocean's API. To use this, you'll need a Mocean account. Sign up for free at moceanapi.com.

Installation

To use the client library you'll need to have created a Mocean account.

To install the C# client library using NuGet:

  • Run the following command in the Package Manager Console:
Install-Package Mocean.Csharp.Client

Usage

You need to create a Client object containing your API key and secret to work with all function:

using Mocean;
using Mocean.Auth;

var credentials = new Basic("API_KEY_HERE", "API_SECRET_HERE");
var client = new Client(credentials);

Example

To use Mocean's SMS API to send an SMS message, call the client.Sms.Send() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

var res = client.Sms.Send(new Mocean.Message.SmsRequest
{
    mocean_to = "60123456789",
    mocean_from = "MOCEAN",
    mocean_text = "Hello World"
});

Console.WriteLine(res);

Responses

For your convenient, the API response has been parse to specified object.

Console.WriteLine(res);         //show full response string
Console.WriteLine(res.status);  //show response status, "0" in this case

Documentation

Kindly visit MoceanApi Docs for more usage

License

This library is released under the MIT License