Documentation Index
Fetch the complete documentation index at: https://plivo.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Get Started with .NET Core
Sign up for a Plivo account
When you sign up with Plivo, we give you a free trial account and free credits to experiment with and learn about our services. You can add a number to your account to start testing the full range of our voice and SMS service features.Follow these steps to get a free trial account:
- Sign up with your work email address.
- Check your inbox for an activation email message from Plivo. Click on the link in the message to activate your account.
- Enter your mobile number to complete the phone verification step.
Sign up with your work email address
If you have any issues creating a Plivo account, please contact our support team for assistance.To get started, try sending an SMS message either by using our API and XML documents, or via , our visual design tool, which allows you to create message flows using an intuitive canvas and deploy them with few clicks.Install .NET Core and the Plivo .NET SDK
You must set up and install .NET Core and Plivo’s .NET SDK before you send your first SMS message.Install .NET Core
You can check whether you already have .NET Core installed under macOS or Linux and what version is installed by running the command dotnet --version in a terminal window. Under Windows there are several ways to check. If you don’t have it or need a more current version, download and install it.Install the Plivo .NET SDK
Create a projects directory and change into it.$ mkdir mydotnetcoreapps
$ cd mydotnetcoreapps
$ dotnet new console
$ dotnet add package Plivo
Send your first outbound SMS/MMS message
You must have a Plivo phone number to send messages to the US or Canada; you can buy a Plivo number from Phone Numbers > Buy Numbers on the Plivo console or via the Numbers API.Code
Open the file in the CS project called Program.cs and paste into it this code.using System;
using System.Collections.Generic;
using Plivo;
namespace testplivo
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var response = api.Message.Create(
src: "<sender_id>",
dst: new List<String> { "<destination_number>" },
text: "Hello, from .NET Core!"
);
Console.WriteLine(response);
}
}
}
using System;
using System.Collections.Generic;
using Plivo;
namespace testplivo
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var response = api.Message.Create(
src: "<sender_id>",
dst: "<destination_number>",
text: "Hello, MMS from .NET Core!",
type:"mms",
media_urls: new string[]{"https://media.giphy.com/media/26gscSULUcfKU7dHq/source.gif"},
media_ids: new String[]{"801c2056-33ab-499c-80ef-58b574a462a2"}
);
Console.WriteLine(response);
}
}
}
Note:
We recommend that you store your credentials in the auth_id and auth_token environment variables to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use the Environment.SetEnvironmentVariable method to store environment variables and Environment.GetEnvironmentVariable to fetch them when initializing the client. Test
Save the file and run it.Receive your first inbound SMS/MMS message
To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API.Create an MVC project
In the .NET Core projects directory, create a new MVC project.$ dotnet new mvc --no-https
ReceiveSmsController.cs, and paste into it this code.using System;
using Microsoft.AspNetCore.Mvc;
namespace ReceiveSms.Controllers
{
public class ReceiveSmsController : Controller
{
// GET: /<controller>/
public String Index()
{
String from_number = Request.Form["From"];
String to_number = Request.Form["To"];
String text = Request.Form["Text"];
Console.WriteLine("Message received - From: {0}, To: {1}, Text: {2}", from_number, to_number, text);
return "Message received";
}
}
}
using System;
using Microsoft.AspNetCore.Mvc;
namespace ReceiveSms.Controllers
{
public class ReceiveSmsController : Controller
{
// GET: /<controller>/
public String Index()
{
String from_number = Request.Form["From"];
String to_number = Request.Form["To"];
String text = Request.Form["Text"];
String media_url = Request.Form["Media0"];
Console.WriteLine("Message received - From: {0}, To: {1}, Text: {2}, Media:{3}", from_number, to_number, text, media_url);
return "Message received";
}
}
}
applicationUrl. "applicationUrl": "http://localhost:5000/"
Expose your local server to the internet
To receive incoming messages, your local server must connect with Plivo API services. For that, we recommend using ngrok, which exposes local servers running behind NATs and firewalls to the public internet over secure tunnels. Using ngrok, you can set webhooks that can talk to the Plivo server.Install ngrok and run it on the command line, specifying the port that hosts the application on which you want to receive messages (5000 in this case):This starts the ngrok server on your local server. Ngrok will display a forwarding link that you can use as a webhook to access your local server over the public network.Now people can send messages to your Plivo number.Create a Plivo application to receive messages
Associate the controller you created with Plivo by creating a Plivo application. Visit Messaging > Applications and click Add New Application. You can also use Plivo’s Application API.Give your application a name — we called ours Receive SMS. Enter the server URL you want to use (for example https://<yourdomain>.com/receive_sms/) in the Message URL field and set the method to POST. Click Create Application to save your application.Assign a Plivo number to your application
Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Receive SMS (the name we gave the application).Click Update Number to save.Test
Send a text message to the Plivo number you specified using any phone.Reply to an incoming SMS/MMS message
To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API.Create a .NET controller
Create a controller called ReplytoInboundController.cs in the Controllers directory and paste into it this code.using System;
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
namespace ReceiveSms.Controllers
{
public class ReplytoInboundController : Controller
{
// GET: /<controller>/
public IActionResult Index()
{
String from_number = Request.Form["From"];
String to_number = Request.Form["To"];
String text = Request.Form["Text"];
Plivo.XML.Response resp = new Plivo.XML.Response();
resp.AddMessage("This is an automatic response",
new Dictionary<string, string>()
{
{"src", to_number},
{"dst", from_number},
{"type", "sms"}
});
var output = resp.ToString();
Console.WriteLine(output);
return this.Content(output, "text/xml");
}
}
}
Create a Plivo application to reply to messages
Associate the controller you created with Plivo by creating a Plivo application. Visiting Messaging > Applications and click Add New Application. You can also use Plivo’s Application API.Give your application a name — we called ours Reply Incoming SMS. Enter the server URL you want to use (for example http://<yourdomain>.com/replysms/) in the Message URL field and set the method to POST. Click Create Application to save your application.Assign a Plivo number to your application
Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Reply Incoming SMS (the name we gave the application).Click Update Number to save.Test
Start the local server.Send a text message to the Plivo number you specified using any phone. You should receive a reply.More use cases
We illustrate more than a dozen use cases with code for both API/XML and PHLO on our documentation pages.Get Started with .NET Framework
Sign up for a Plivo account
When you sign up with Plivo, we give you a free trial account and free credits to experiment with and learn about our services. You can add a number to your account to start testing the full range of our voice and SMS service features.Follow these steps to get a free trial account:
- Sign up with your work email address.
- Check your inbox for an activation email message from Plivo. Click on the link in the message to activate your account.
- Enter your mobile number to complete the phone verification step.
Sign up with your work email address
If you have any issues creating a Plivo account, please contact our support team for assistance.To get started, try sending an SMS message either by using our API and XML documents, or via , our visual design tool, which allows you to create message flows using an intuitive canvas and deploy them with few clicks.Install .NET Framework and the Plivo .NET SDK
You must set up and install .NET Framework 4.6 or higher and Plivo’s .NET SDK before you send your first SMS message.Install .NET Framework
You can check whether you already have .NET Framework installed under macOS or Linux and what version is installed by running the command dotnet --version in a terminal window. Under Windows there are several ways to check. If you don’t have it or need a more current version, download and install it.Install the Plivo .NET SDK using Visual Studio
Create a new project in Visual Studio.Choose a template for the new project.Install the Plivo NuGet package.Once you’ve set up your development environment, you can start sending and receiving messages using our APIs and XML documents. Here are three common use cases to get you started.Send your first outbound SMS/MMS message
You must have a Plivo phone number to send messages to the US or Canada; you can rent a Plivo number from Phone Numbers > Buy Numbers on the Plivo console or via the Numbers API.Open the file in the CS project called Program.cs and paste into it this code.Code
using System;
using System.Collections.Generic;
using Plivo;
namespace testplivo
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var response = api.Message.Create(
src: "<sender_id>",
dst: new List<String> { "<destination_number>" },
text: "Hello, from .NET Framework!"
);
Console.WriteLine(response);
}
}
}
using System;
using System.Collections.Generic;
using Plivo;
namespace testplivo
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
var response = api.Message.Create(
src: "<sender_id>",
dst: "<destination_number>",
text: "Hello, from .NET Framework!",
type:"mms",
media_urls: new string[]{"https://media.giphy.com/media/26gscSULUcfKU7dHq/source.gif"},
media_ids: new String[]{"801c2056-33ab-499c-80ef-58b574a462a2"}
);
Console.WriteLine(response);
}
}
}
Note:
We recommend that you store your credentials in the auth_id and auth_token environment variables to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use the Environment.SetEnvironmentVariable method to store environment variables and Environment.GetEnvironmentVariable to fetch them when initializing the client. Test
Before starting the application, edit Properties/launchSettings.json and set applicationUrl. "applicationUrl": "http://localhost:5000/"
Receive your first inbound SMS/MMS message
To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API.Create a .NET controller
Navigate to the Controllers directory, create a controller called ReceiveSmsController.cs, and paste into it this code.using System;
using Microsoft.AspNetCore.Mvc;
namespace ReceiveSms.Controllers
{
public class ReceiveSmsController : Controller
{
// GET: /<controller>/
public String Index()
{
String from_number = Request.Form["From"];
String to_number = Request.Form["To"];
String text = Request.Form["Text"];
Console.WriteLine("Message received - From: {0}, To: {1}, Text: {2}", from_number, to_number, text);
return "Message received";
}
}
}
using System;
using Microsoft.AspNetCore.Mvc;
namespace ReceiveSms.Controllers
{
public class ReceiveSmsController : Controller
{
// GET: /<controller>/
public String Index()
{
String from_number = Request.Form["From"];
String to_number = Request.Form["To"];
String text = Request.Form["Text"];
String media_url = Request.Form["Media0"];
Console.WriteLine("Message received - From: {0}, To: {1}, Text: {2}, Media: {3}", from_number, to_number, text, media_url);
return "Message received";
}
}
}
Test
Before starting the application, edit Properties/launchSettings.json and set applicationUrl. "applicationUrl": "http://localhost:5000/"
Expose your local server to the internet
To receive incoming messages, your local server must connect with Plivo API services. For that, we recommend using ngrok, which exposes local servers running behind NATs and firewalls to the public internet over secure tunnels. Using ngrok, you can set webhooks that can talk to the Plivo server.Install ngrok and run it on the command line, specifying the port that hosts the application on which you want to receive messages (5000 in this case):This starts the ngrok server on your local server. Ngrok will display a forwarding link that you can use as a webhook to access your local server over the public network.Now people can send messages to your Plivo number.Create a Plivo application to receive messages
Associate the controller you created with Plivo by creating a Plivo application. Visiting Messaging > Applications and click Add New Application. You can also use Plivo’s Application API.Give your application a name — we called ours Receive SMS. Enter the server URL you want to use (for example https://<yourdomain>.com/receive_sms/) in the Message URL field and set the method to POST. Click Create Application to save your application.Assign a Plivo number to your application
Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Receive SMS (the name we gave the application).Click Update Number to save.Test
Send a text message to the Plivo number you specified using any phone.Reply to an incoming SMS/MMS message
To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API.Create a .NET controller
Create a controller called ReplytoInboundController.cs in the Controllers directory and paste into it this code.using System;
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
namespace ReceiveSms.Controllers
{
public class ReplytoInboundController : Controller
{
// GET: /<controller>/
public IActionResult Index()
{
String from_number = Request.Form["From"];
String to_number = Request.Form["To"];
String text = Request.Form["Text"];
Plivo.XML.Response resp = new Plivo.XML.Response();
resp.AddMessage("This is an automatic response",
new Dictionary<string, string>()
{
{"src", to_number},
{"dst", from_number},
{"type", "sms"}
});
var output = resp.ToString();
Console.WriteLine(output);
return this.Content(output, "text/xml");
}
}
}
Create a Plivo application to reply to messages
Associate the controller you created with Plivo by creating a Plivo application. Visiting Messaging > Applications and click Add New Application. You can also use Plivo’s Application API.Give your application a name — we called ours Reply Incoming SMS. Enter the server URL you want to use (for example http://<yourdomain>.com/replysms/) in the Message URL field and set the method to POST. Click Create Application to save your application.Assign a Plivo number to your application
Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Reply Incoming SMS (the name we gave the application).Click Update Number to save.Test
Run the project.Send a text message to the Plivo number you specified using any phone. You should receive a reply.More use cases
We illustrate more than a dozen use cases with code for both API/XML and PHLO on our documentation pages.
