Skip to content

smsglobal/smsglobal-dotnet

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

SMSGlobal Dotnet

.NET Core Nuget Coverage downloads

SMSGlobal REST API and Libraries for .NET

This is an SDK for SMSGlobal’s REST API that supports .NET applications written in C#, VB.Net, and F# to enable SMS and opt out functionality.

Sign up for a free SMSGlobal account today and get your API Key from our advanced SMS platform, MXT. Plus, enjoy unlimited free developer sandbox testing to try out your API in full!

Supported .NET versions

This library supports .NET applications written in C#, VB.Net, and F# that utilize .NET Standard 2.1 which supports .NET Core 3.0 and unavailable for .NET Framework. supported version

Installation

The best and easiest way to add the SMSGlobal libraries to your .NET project is to use the NuGet package manager.

With Visual Studio IDE

From within Visual Studio, you can use the NuGet GUI to search for and install the SMSGlobal NuGet package. Or, as a shortcut, simply type the following command into the Package Manager Console:

Install-Package SMSGlobal

With .NET Core Command Line Tools

If you are building with the .NET Core command line tools, then you can run the following command from within your project directory:

dotnet add package SMSGlobal

Azure functions

From within Visual Studio while creating azure function app, you can use the NuGet GUI to search for and install the SMSGlobal NuGet package. Or, as a shortcut, simply type the following command into the Package Manager Console:

Install-Package SMSGlobal

More information can be found here. Nuget Client Tools

Configuration

First import the package by using SMSGlobal api:

using SMSGlobal.api;

To setup the configuration of the SMSGlobal client you have to create following object with Rest and Secret API keys.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

And then consume the function like this:

var response = await client.SMS.SMSSend(new
{
    origin = "Test",
    destination = "DESTINATION-NUMBER",
    message = "This is a test message"
});

The response object will contain the result object and also two keys fields:

  1. statuscode: This code can be used to determine the outcome of the call. Based on data passed you can get different status codes such as 400, 404, 200 etc.

  2. statusmessages: This message can be used to determine the outcome of the call. Each status code has a status message linked.

Each api call have different status codes and messages, more info about status codes can be found here. Rest API

Configuration Reference

Key Description
SMSGLOBAL-API-KEY Your REST API key from the MXT
SMSGLOBAL-SECRET-KEY Your REST API secret from the MXT

Examples

The following examples show how to:

SMS

SMS-Incoming

Opt-Outs

OTP

More info can be found here. SMSGlobal Rest API

Sending a Message

This can be used to send a single message.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

var response = await client.SMS.SMSSend(new
{
    origin = "Test",
    destination = "DESTINATION-NUMBER",
    message = "This is a test message"
});

This can be used to send a multiple messages.

Object[] messages = new Object[2];

messages[0] = new {
origin = "Test",
destination = "DESTINATION-NUMBER-1",
message = "This is a test message"
};

messages[1] = new {
origin = "Test",
destination = "DESTINATION-NUMBER-2",
message = "This is a test message"
};

var response = await client.SMS.SMSSend(new { messages = messages });
			

The response object will contain collection of outgoing message objects.

This can be used to send to multiple destinations.

string[] destinations = new string[2];

destinations[0] = "DESTINATION-NUMBER-1";
destinations[1] = "DESTINATION-NUMBER-2";

var response = await client.SMS.SMSSend(new
{
   origin = "Test",
   destinations = destinations,
   message = "This is a test message"
});

The response object will contain collection of outgoing message objects.

Same way we can send mutiple messages of array having multiple destinations array in it.

Object[] messages = new Object[2];

string[] destinations1 = new string[2];

destinations[0] = "DESTINATION-NUMBER-1";
destinations[1] = "DESTINATION-NUMBER-2";

string[] destinations2 = new string[2];

destinations[0] = "DESTINATION-NUMBER-3";
destinations[1] = "DESTINATION-NUMBER-4";

messages[0] = new {
origin = "Test",
destinations = destinations1,
message = "This is a test message"
};

messages[1] = new {
origin = "Test",
destinations = destinations2,
message = "This is a test message"
};

var response = await client.SMS.SMSSend(new { messages = messages });

The response object will contain collection of outgoing message objects.

Given below is one example of how the response will look like:

{
 "id":"6019398301583935",
 "outgoing_id":"5922424533",
 "origin":"Test",
 "message":"This is a test message",
 "dateTime":"2021-02-17 23:40:56 +0000",
 "status":"sent"
}

Receive all Messages

This can be used to view list of all outgoing messages. The messages returned can be filtered based on different condition.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string filter = "limit=1";
var response = await client.SMS.SMSGetAll(filter);

The response object will contain all the sms sent messages objects such as:

{
{
 "id":"6019398301583935",
 "outgoing_id":"5922424533",
 "origin":"Test",
 "message":"This is a test message 1",
 "dateTime":"2021-02-18 10:40:56 +1100",
 "status":"delivered"
},
{
 "id":"6019398301583936",
 "outgoing_id":"5922424524",
 "origin":"Test",
 "message":"This is a test message 2",
 "dateTime":"2021-02-18 10:40:56 +1100",
 "status":"delivered"
}
}

Get Message By Id

This can be used to view details of an outgoing message.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string id = "SMSGLOBAL-OUTGOING-ID";
var response = await client.SMS.SMSGetId(id);

The response object will contain details of the message such as:

{
 "id":"6019398301583935",
 "outgoing_id":"5922424533",
 "origin":"Test",
 "message":"This is a test message",
 "dateTime":"2021-02-17 23:40:56 +0000",
 "status":"sent"
}

Delete Message

This can be used to delete outgoing message.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string id = "SMSGLOBAL-OUTGOING-ID";
var response = await client.SMS.SMSDeleteId(id);

The reponse of this request will return status code where 204 means message deleted successfully.

Get All Incoming Messages

This can be used to get all incoming messages. The messages returned can be filtered based on different condition.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

 string filter = "limit=1";
 var response = await client.SMS.SMSGetIncoming(filter);

The response object will contain all the incoming messages objects such as:

{
 "id":"490571921",
 "outgoing_id":null,
 "origin":"61450000000",
 "message":"Test",
 "dateTime":"2021-02-15 13:54:43 +1100",
 "status":null
}

Get Incoming Message By Id

This can be used to view details of an incoming message.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string id = "INCOMING-NUMBER";
var response = await client.SMS.SMSDeleteIncoming(id);

The response object will contain details of the incoming message such as:

{
 "id":"490571921",
 "outgoing_id":null,
 "origin":"61450000000",
 "message":"Test",
 "dateTime":"2021-02-15 13:54:43 +1100",
 "status":null
}

Delete Incoming Message

This can be used to delete an incoming message.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string id = "SMSGLOBAL-OUTGOING-ID";
var response = await client.SMS.SMSGetIncomingById(id);

The reponse of this request will return status code where 204 means message deleted successfully.

Get All Opted Out Numbers

This can be used to get all opted out numbers. The numbers returned can be filtered based on different condition.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string filter = "";
var response = await client.SMS.SMSGetOptOuts(filter);

The response object will contain all the opted number objects such as:

{
 "date":"2021-02-18",
 "number":"16789253159",
 "status":null
}

Opt Out Number

This can be used to opt out numbers.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

Object[] payload = new Object[2];
payload[0] = new
{
    number = "MOBILE-NUMBER"
};
payload[1] = new
{
    number = "MOBILE-NUMBER"
};

var response = await client.SMS.SMSPostOptOut(new { optouts = payload });

The response object will contain collection of Opt out number object. Optout object consist of number and status(exist, valid, and invalid) properties such as:

{
 "date":"2021-02-18",
 "number":"16789253159",
 "status":valid
}

Validate Opt Out

This can be used to validate mobile numbers for opt-out.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

Object[] payload = new Object[2];
payload[0] = new
{
    number = "MOBILE-NUMBER"
};
payload[1] = new
{
    number = "MOBILE-NUMBER"
};

var response = await client.SMS.SMSPostOptOutValidate(new { optouts = payload });

The response object will contain collection of Opt out number object. Optout object consist of number and status(exist, valid, and invalid) properties such as:

{
 "date":"2021-02-18",
 "number":"16789253159",
 "status":valid
}

Opt In Number

This can be used to opt in a number.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string number = "MOBILE-NUMBER";
var response = await client.SMS.SMSDeleteOptOut(number);

The reponse of this request will return status code where 204 means opted-in successfully.

Send OTP

This can be used for sending OTP.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

var response = await client.OTP.OTPSend(new
{
    message = "{*code*} is your SMSGlobal verification code.",
    destination = "DESTINATION-NUMBER",
});

The response object will contain OTP details such as request id, destination number such as:

{
 "requestId":"409261431691990777288109",
 "destination":"61450000000",
 "validUnitlTimestamp":"2021-02-18 11:39:07",
 "createdTimestamp":"2021-02-18 11:29:07",
 "lastEventTimestamp":"2021-02-18 11:29:08",
 "status":"Sent",
 "statuscode":200,
 "statusmessage":"OK"
}

Verify OTP

The OTP code entered by your user can be verified by either using requestId or destination number.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string requestid = "REQUEST-ID";
string code = "OTP-CODE";
var response = await client.OTP.OTPValidateRequest(requestid, new
{
   code = code,
});
var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string destinationid = "DESTINATION-NUMBER";
string code = "OTP-CODE";
var response = await client.OTP.OTPValidateDestination(destinationid, new
{
   code = code,
});

The response object will contain OTP details such as request id, destination number such as:

{
 "requestId":"409261431691990777288109",
 "destination":"61450000000",
 "validUnitlTimestamp":"2021-02-18 11:39:07",
 "createdTimestamp":"2021-02-18 11:29:07",
 "lastEventTimestamp":"2021-02-18 11:29:08",
 "status":"Verified",
 "statuscode":200,
 "statusmessage":"OK"
}

Cancel OTP

The OTP request can be cancelled if an OTP is not expired and verified yet. It can be done by either using requestId or destination number.

var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string requestid = "REQUEST-ID";
var response = await client.OTP.OTPCancelRequest(requestid);
var client = new Client(new Credentials("SMSGLOBAL-API-KEY", "SMSGLOBAL-SECRET-KEY"));

string destination = "DESTINATION-NUMBER";
var response = await client.OTP.OTPCancelDestination(destination);

The response object will contain OTP details such as request id, destination number such as:

{
 "requestId":"409261431691990777288109",
 "destination":"61450000000",
 "validUnitlTimestamp":"2021-02-18 11:39:07",
 "createdTimestamp":"2021-02-18 11:29:07",
 "lastEventTimestamp":"2021-02-18 11:29:08",
 "status":"Cancelled ",
 "statuscode":200,
 "statusmessage":"OK"
}

Getting help

View the REST API documentation for a list of available resources.

For any query contact us