C#

This tutorial provides you with a step-by-step walkthrough on how to send a message using the Live Link 365 365 API.

This is not a production-ready application. Please take your time to enhance it for production so that it meets your specific business requirements.

Steps

Step 1

Prerequisites

keyboard_arrow_down

For this project, external NuGet Packages are required (they are already included within the project):

• Newtonsoft.Json: for JSON object handling
• RestSharp: to send the requests to the API

You are free to use whatever method you feel that accomplish these functions on your own project

Step 2

Set up the Global Environment Variables

keyboard_arrow_down

Create the static Globals class to access the environment variables used across the program. We have four required variables and one optional variable:

• baseUrl: Live Link 365 API URL
• appKey: Generated App Key. See the Documentation > Authentication section
• appSecret: Generated secret. See the Documentation > Authentication section
• defaultOrigin: Live Link 365 number that will be used to send the message
• proxy (optional): If you are behind a corporate proxy, you need to set the proxy to send HTTP requests

Step 3

Get the Authentication Token

keyboard_arrow_down

The GetAccessToken() function will take the app key and secret and will combine them into a Base64 string, which will then be sent to the /api/oauth/token endpoint to generate the authentication token. The function has two optional parameters. In case the function is called without them, it will take the values set on the Globals class.

Notice that you will need to parse the JSON string that the method returns before using it. After parsing the JSON string, you should return the access_token field from the JSON response

Optionally, if a proxy was set on the Globals class, it will be used to make the call

Step 4

Send the Message

keyboard_arrow_down

The sendSMS() function will take the message string and the destination phone number string received from the user. First we retrieve the authorization token by calling the getAccessToken() function, after that we create a POST request on which we are going to send the message, the destination and the default origin number from global variables.

Optionally, if a proxy was set on the global variable, it will be used to make the call

Step 5

Execute the Main Class

keyboard_arrow_down

Now, we execute the main function, we ask for the message that we want to send and the destination phone number to send it. Finally, call the sendSMS function to send the message

Code

Download

keyboard_arrow_down

zip tar

/HelloWorld/Program.cs

using System;
using System.Net;
using System.Text;

// _Step_1
using Newtonsoft.Json;
using RestSharp;

namespace HelloWorld
{

    // _Step_2
    static class Globals
    {
        public const String baseUrl = "https://livelink.sapdigitalinterconnect.com/api";
        public const String appKey = "";
        public const String appSecret = "";
        public const String defaultOrigin = "";
        public const WebProxy globalProxy = null;
    }

    public class HelloWorld
    {
        // _Step_3
        public static String GetAccessToken(String key = Globals.appKey, String secret = Globals.appSecret)
        {
            Console.WriteLine("...... executing authorization request with key: " + key);

            String oAuthUrl = Globals.baseUrl + "/oauth/token";
            String bearer = Convert.ToBase64String(Encoding.UTF8.GetBytes(key + ":" + secret));
            RestClient client = new RestClient(oAuthUrl);
            if (Globals.globalProxy != null) {
                client.Proxy = Globals.globalProxy;
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
            }
            RestRequest request = new RestRequest(Method.POST);
            request.AddHeader("content-type", "application/x-www-form-urlencoded");
            request.AddHeader("authorization", "Basic " + bearer);
            request.AddParameter("application/x-www-form-urlencoded", "grant_type=client_credentials", ParameterType.RequestBody);

            IRestResponse<oAuthToken> response = client.Execute<oAuthToken>(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("..... Error: " + response.StatusDescription);
                return "";
            }

            String accessToken = response.Data.access_token;
            Console.WriteLine("..... authorization request successfull access token: " + accessToken);
            return accessToken;
        }

        // _Step_4
        public static void sendSMS(String message, String destination)
        {
            Console.WriteLine("..... sending message");

            String messageUrl = Globals.baseUrl + "/v2/sms";
            Object messagePayload = new {
                message = message,
                origin =  Globals.defaultOrigin,
                destination = destination
            };
            String messageData = JsonConvert.SerializeObject(messagePayload);
            String bearer = GetAccessToken();
            if (String.IsNullOrEmpty(bearer)) {
                return;
            }
            RestClient client = new RestClient(messageUrl);
            if (Globals.globalProxy != null) {
                client.Proxy = Globals.globalProxy;
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
            }

            RestRequest request = new RestRequest(Method.POST);
            request.AddHeader("authorization", "Bearer " + bearer);
            request.AddHeader("content-type", "application/json");
            request.AddParameter("application/json", messageData, ParameterType.RequestBody);

            IRestResponse response = client.Execute(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("..... failed to send message.");
                Console.WriteLine("..... Error: " + response.ErrorMessage);
                return;
            }
            Console.WriteLine("..... Message sent successfully");
            return;
        }

        // _Step_5
        public static void Main(string[] args)
        {
            Console.Clear();
            Console.Write("What do you want to say(text message): ");
            String message = Console.ReadLine();
            Console.Write("Who do you want to send to(phone number): ");//Phone numbers have to be in E.164 format.
            String destination = Console.ReadLine();
            Console.WriteLine("****************************************");
            Console.WriteLine("Sending: " + message);
            Console.WriteLine("To: " + destination);
            sendSMS(message, destination);
        }
    }
}