The Plivo .NET SDK makes it simpler to integrate communications into your .NET applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.
Supported .NET versions: This SDK was written targeting at .NET Standard 1.3 & .NET Standard 2.0, and thus works with .NET Framework 4.6+ and .NET Core 1.0+. Check here to know about all the other supported platforms.
You can install this SDK either by referencing the .dll file or using NuGet.
Use the following line to install the latest SDK using the NuGet CLI.
PM> Install-Package Plivo -Version 5.49.2
You can also use the .NET CLI to install this package as follows
> dotnet add package Plivo --version 5.49.2
To make the API requests, you need to create a PlivoApi instance and provide it with authentication credentials (which can be found at https://manage.plivo.com/dashboard/).
var api = new PlivoApi("<auth_id>", "<auth_token>");The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:
api.Resource.Create(params);
api.Resource.Get(params);
api.Resource.Update(identifier, params);
api.Resource.Delete(identifier);
api.Resource.List();Using api.Resource.List() would list the first 20 resources by default (which is the first page, with limit as 20, and offset as 0). To get more, you will have to use limit and offset to get the second page of resources.
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
var response = api.Message.Create(
src:"14156667778",
dst:"14156667777",
text:"Hello, this is a sample text from Plivo"
);
Console.WriteLine(response);
}
}internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
var response = api.Call.Create(
to:new List<String>{"the_to_number"},
from:"the_from_number",
answerMethod:"GET",
answerUrl:"https://answer.url"
);
Console.WriteLine(response);
}
}internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
var response = api.Lookup.Get("phone_number_here");
Console.WriteLine(response);
}
}class MainClass
{
public static void Main(string[] args)
{
Plivo.XML.Response response = new Plivo.XML.Response();
response.AddSpeak("Hello, world!",
new Dictionary<string, string>() { });
Console.WriteLine(response.ToString());
}
}This generates the following XML:
<Response>
<Speak>Hello, world!</Speak>
</Response>Plivo's WhatsApp API allows you to send different types of messages over WhatsApp, including templated messages, free form messages and interactive messages. Below are some examples on how to use the Plivo Go SDK to send these types of messages.
Templated messages are a crucial to your WhatsApp messaging experience, as businesses can only initiate WhatsApp conversation with their customers using templated messages.
WhatsApp templates support 4 components: header , body, footer and button. At the point of sending messages, the template object you see in the code acts as a way to pass the dynamic values within these components. header can accomodate text or media (images, video, documents) content. body can accomodate text content. button can support dynamic values in a url button or to specify a developer-defined payload which will be returned when the WhatsApp user clicks on the quick_reply button. footer cannot have any dynamic variables.
Example 1:
using System;
using System.Collections.Generic;
using Plivo;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
string jsonString = "{\"name\":\"plivo_movieticket_confirmation\",\"language\":\"en_US\",\"components\":[{\"type\":\"header\",\"parameters\":[{\"type\":\"media\",\"media\":\"https://media.geeksforgeeks.org/wp-content/uploads/20190712220639/ybearoutput-300x225.png\"}]},{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"Harry Potter\"},{\"type\":\"text\",\"text\":\"06:00 PM\"},{\"type\":\"text\",\"text\":\"Bengaluru\"},{\"type\":\"text\",\"text\":\"2\"}]}]}";
var response = api.Message.Create(
src: "14156667778",
dst: "14156667777",
type: "whatsapp",
template_json_string: jsonString);
Console.WriteLine(response);
}
}
}Example 2:
using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Resource.Message;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
var template = new Template
{
Name = "plivo_movieticket_confirmation",
Language = "en_US",
Components = new List<Component>
{
new Component
{
Type = "header",
Parameters = new List<Parameter>
{
new Parameter
{
Type = "media",
Media = "https://media.geeksforgeeks.org/wp-content/uploads/20190712220639/ybearoutput-300x225.png"
}
}
},
new Component
{
Type = "body",
Parameters = new List<Parameter>
{
new Parameter
{
Type = "text",
Text = "Harry Potter"
},
new Parameter
{
Type = "text",
Text = "06:00 PM"
},
new Parameter
{
Type = "text",
Text = "Bengaluru"
},
new Parameter
{
Type = "text",
Text = "2"
}
}
}
}
};
var response = api.Message.Create(
src: "14156667778",
dst: "14156667777",
type: "whatsapp",
template: template);
Console.WriteLine(response);
}
}
}Non-templated or Free Form WhatsApp messages can be sent as a reply to a user-initiated conversation (Service conversation) or if there is an existing ongoing conversation created previously by sending a templated WhatsApp message.
Example:
using System;
using System.Collections.Generic;
using Plivo;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
text: "Hello, this is sample text",
url: "https://<yourdomain>.com/wa_status/");
Console.WriteLine(response);
}
}
}Example:
using System;
using System.Collections.Generic;
using Plivo;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
text: "Hello, this is sample text",
media_urls: new string[] { "https://sample-videos.com/img/Sample-png-image-1mb.png"},
url: "https://<yourdomain>.com/wa_status/");
Console.WriteLine(response);
}
}
}This guide shows how to send non-templated interactive messages to recipients using Plivo’s APIs.
Quick reply buttons allow customers to quickly respond to your message with predefined options.
Example:
using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Resource.Message;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
var interactive = new Interactive
{
Type = "button",
Header = new Header
{
Type = "media",
Media = "https://media.geeksforgeeks.org/wp-content/uploads/20190712220639/ybearoutput-300x225.png"
},
Body = new Body
{
Text = "Make your selection"
},
Action = new MessageAction
{
Buttons = new List<Button>
{
new Button
{
Id = "bt1",
Title = "Click here"
},
new Button
{
Id = "bt2",
Title = "Know More"
},
new Button
{
Id = "bt3",
Title = "Request Callback"
}
}
}
};
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
interactive: interactive);
Console.WriteLine(response);
}
}
}Interactive lists allow you to present customers with a list of options.
Example:
using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Resource.Message;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>", "<auth_token>");
var interactive = new Interactive
{
Type = "list",
Header = new Header
{
Type = "text",
Text = "Welcome to Plivo"
},
Body = new Body
{
Text = "You can review the list of rewards we offer"
},
Footer = new Footer
{
Text = "Yours Truly"
},
Action = new MessageAction
{
Buttons = new List<Button>
{
new Button
{
Title = "Click here"
}
},
Sections = new List<Section>
{
new Section
{
Title = "SECTION_1_TITLE",
Rows = new List<Row>
{
new Row
{
Id = "SECTION_1_ROW_1_ID",
Title = "SECTION_1_ROW_1_TITLE",
Description = "SECTION_1_ROW_1_DESCRIPTION"
}
}
},
new Section
{
Title = "SECTION_2_TITLE",
Rows = new List<Row>
{
new Row
{
Id = "SECTION_2_ROW_1_ID",
Title = "SECTION_2_ROW_1_TITLE",
Description = "SECTION_2_ROW_1_DESCRIPTION"
}
}
}
}
}
};
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
interactive: interactive);
Console.WriteLine(response);
}
}
}CTA URL messages allow you to send links and call-to-action buttons.
Example:
using System;
using System.Collections.Generic;
using Plivo;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var interactive = new Interactive
{
Type = "cta_url",
Header = new Header
{
Type = "media",
Media = "https://media.geeksforgeeks.org/wp-content/uploads/20190712220639/ybearoutput-300x225.png"
},
Body = new Body
{
Text = "Know More"
},
Action = new MessageAction
{
Buttons = new List<Button>
{
new Button
{
Title = "Click here",
CtaUrl = "https://www.plivo.com"
}
}
}
};
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
interactive: interactive);
Console.WriteLine(response);
}
}
}This guide shows how to send templated and non-templated location messages to recipients using Plivo’s APIs.
Example:
using System;
using System.Collections.Generic;
using Plivo;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var template = new Template
{
Name = "plivo_order_pickup",
Language = "en_US",
Components = new List<Component>
{
new Component
{
Type = "header",
Parameters = new List<Parameter>
{
new Parameter
{
Type = "location",
Location = new Location
{
Longitude = "122.148981",
Latitude = "37.483307",
Name = "Pablo Morales",
Address = "1 Hacker Way, Menlo Park, CA 94025"
}
}
}
},
new Component
{
Type = "body",
Parameters = new List<Parameter>
{
new Parameter
{
Type = "text",
Text = "Harry"
}
}
}
}
};
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
template: template);
Console.WriteLine(response);
}
}
}Example:
using System;
using System.Collections.Generic;
using Plivo;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var location = new Location
{
Longitude = "122.148981",
Latitude = "37.483307",
Name = "Pablo Morales",
Address = "1 Hacker Way, Menlo Park, CA 94025"
};
var response = api.Message.Create(
src: "+14151112221",
dst: "+14151112222",
type: "whatsapp",
location: location);
Console.WriteLine(response);
}
}
}Refer to the Plivo API Reference for more examples.
Report any feedback or problems with this version by opening an issue on Github.
Note: Requires latest versions of Docker & Docker-Compose. If you're on MacOS, ensure Docker Desktop is running.
- Export the following environment variables in your host machine:
export PLIVO_AUTH_ID=<your_auth_id>
export PLIVO_AUTH_TOKEN=<your_auth_token>
export PLIVO_API_DEV_HOST=<plivoapi_dev_endpoint>
export PLIVO_API_PROD_HOST=<plivoapi_public_endpoint>- Run
make build. This will create a docker container in which the sdk will be setup and dependencies will be installed.
The entrypoint of the docker container will be the
setup_sdk.shscript. The script will handle all the necessary changes required for local development. It will also package the sdk and reinstall it as a dependecy for the test program.
- The above command will print the docker container id (and instructions to connect to it) to stdout.
- The testing code can be added to
<sdk_dir_path>/dotnet-sdk-test/Program.csin host
(or/usr/src/app/dotnet-sdk-test/Program.csin container) - The sdk directory will be mounted as a volume in the container. So any changes in the sdk code will also be reflected inside the container. However, when any change is made, the dependencies for the test program need to be re-installed. To do that:
- Either restart the docker container
- Or Run the
setup_sdk.shscript
- To run test code, run
make run CONTAINER=<cont_id>in host.
<cont_id>is the docker container id created in 2. (The docker container should be running)
Test code can also be run within the container using
make run. (CONTAINERargument should be omitted when running from the container)