Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twilio/twilio-csharp
Twilio C#/.NET Helper Library for .NET6+.
https://github.com/twilio/twilio-csharp
api mms phone sms telephony twilio twiml video voice wireless
Last synced: 8 days ago
JSON representation
Twilio C#/.NET Helper Library for .NET6+.
- Host: GitHub
- URL: https://github.com/twilio/twilio-csharp
- Owner: twilio
- License: mit
- Created: 2009-09-15T06:32:31.000Z (about 15 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T14:51:34.000Z (6 months ago)
- Last Synced: 2024-05-22T15:49:40.783Z (6 months ago)
- Topics: api, mms, phone, sms, telephony, twilio, twiml, video, voice, wireless
- Language: C#
- Homepage:
- Size: 52 MB
- Stars: 657
- Watchers: 97
- Forks: 297
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-sdks - Twilio - [Twilio](https://www.twilio.com/docs/libraries/csharp-dotnet) C#/.NET Helper Library for .NET Framework 3.5+ and supported .NET Core versions. (Csharp)
README
# twilio-csharp
[](https://github.com/twilio/twilio-csharp/actions/workflows/test-and-deploy.yml)
[](https://sonarcloud.io/summary/new_code?id=twilio_twilio-csharp)
[](https://www.nuget.org/packages/Twilio)
[](https://twil.io/learn-open-source)
## Twilio REST API and TwiML Libraries for .NET
Twilio provides a HTTP-based API for sending and receiving phone calls and text messages. Learn more on [twilio.com][apidocs].
More documentation for this library can be found [here][libdocs].
## Versions
`twilio-csharp` uses a modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.
### Migrate from earlier versions
See the migration guide [here](./UPGRADE.md). Also, if you were using the `Twilio.Mvc` package, that has been replaced by the [Twilio.AspNet.Mvc][aspnet] package which is compatible with this version of the library.
### TLS 1.2 Requirements
New accounts and subaccounts are now required to use TLS 1.2 when accessing the REST API. ["Upgrade Required" errors](https://www.twilio.com/docs/api/errors/20426) indicate that TLS 1.0/1.1 is being used. With .NET, you can enable TLS 1.2 using this setting:
```csharp
System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
```
### Supported .NET versions
This library supports .NET applications that utilize .NET6+.
## Installation
The best and easiest way to add the Twilio 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 Twilio NuGet package. Or, as a shortcut, simply type the following command into the Package Manager Console:
```shell
Install-Package Twilio
```
### 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:
```shell
dotnet add package Twilio
```
## Sample usage
The examples below show how to have your application initiate and outbound phone call and send an SMS message using the Twilio .NET helper library:
```csharp
TwilioClient.Init("ACCOUNT_SID", "AUTH_TOKEN");
var call = CallResource.Create(
new PhoneNumber("+11234567890"),
from: new PhoneNumber("+10987654321"),
url: new Uri("https://my.twiml.here")
);
Console.WriteLine(call.Sid);
var message = MessageResource.Create(
new PhoneNumber("+11234567890"),
from: new PhoneNumber("+10987654321"),
body: "Hello World!"
);
Console.WriteLine(message.Sid);
```
Examples on how to make rest calls with bearer token authentication is added [here](https://github.com/twilio/twilio-csharp/blob/orgs_api_uptake/examples/BearerTokenAuthentication.md)
## Specify Region and/or Edge
To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
```csharp
TwilioClient.SetRegion("au1");
TwilioClient.SetEdge("sydney");
```
This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`. Use appropriate client depending on the type of authentication used
## Enable debug logging
There are two ways to enable debug logging in the default HTTP client. You can create an environment variable called `TWILIO_LOG_LEVEL` and set it to `debug` or you can set the LogLevel variable on the client as debug:
```csharp
TwilioClient.SetLogLevel("debug");
```
## Handle exceptions
For an example on how to handle exceptions in this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/csharp-dotnet/usage-guide#handle-errors).
## Generate TwiML
To control phone calls, your application needs to output [TwiML][twiml].
```csharp
// TwiML classes can be created as standalone elements
var gather = new Gather(numDigits: 1, action: new Uri("hello-monkey-handle-key.cshtml"), method: HttpMethod.Post)
.Say("To speak to a real monkey, press 1. Press 2 to record your own monkey howl. Press any other key to start over.");
// Attributes can be set directly on the object
gather.Timeout = 100;
gather.MaxSpeechTime = 200
// Arbitrary attributes can be set by calling set/getOption
var dial = new Dial().SetOption("myAttribute", 200)
.SetOption("newAttribute", false);
// Or can be created and attached to a response directly using helper methods
var response = new VoiceResponse()
.Say("Hello Monkey")
.Play(new Uri("http://demo.twilio.com/hellomonkey/monkey.mp3"))
.Append(gather)
.Append(dial);
// Serialize the TwiML objects to XML string
Console.WriteLine(response);
/*
Hello Monkey
http://demo.twilio.com/hellomonkey/monkey.mp3
To speak to a real monkey, press 1. Press 2 to record your own monkey howl. Press any other key to start over.
*/
```
## Use a custom HTTP Client
To use a custom HTTP client with this helper library, please see the [advanced example of how to do so](./advanced-examples/custom-http-client.md).
## Annotations
### Beta
Features marked with the `[Beta]` attribute are in a beta stage and may undergo changes in future releases. Use these features with caution as they may not be stable.
### Deprecated
Features marked with the `[Deprecated]` attribute are deprecated and are not encouraged to use
### Preview
Features marked with the `[Preview]` attribute are in a preview stage and are intended for evaluation purposes. They are subject to change and should not be used in production without thorough testing.
## Docker Image
The `Dockerfile` present in this repository and its respective `twilio/twilio-csharp` Docker image are used by Twilio for testing purposes.
You could use the docker image for building and running tests:
```bash
docker build -t twiliobuild .
```
Bash:
```bash
docker run -it --rm -v $(pwd):/twilio twiliobuild
make test
```
Powershell:
```pwsh
docker run -it --rm -v ${PWD}:/twilio twiliobuild
make test
```
## Get support
If you need help installing or using the library, please check the [Twilio Support Help Center](https://support.twilio.com) first, and [file a support ticket](https://twilio.com/help/contact) if you don't find an answer to your question.
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
[twilio]: https://www.twilio.com
[apidocs]: https://www.twilio.com/docs/api
[twiml]: https://www.twilio.com/docs/api/twiml
[libdocs]: https://www.twilio.com/docs/libraries/reference/twilio-csharp/
[aspnet]: https://github.com/twilio/twilio-aspnet