# twilio-salesforce

**Repository Path**: mirrors_twilio/twilio-salesforce

## Basic Information

- **Project Name**: twilio-salesforce
- **Description**: A Salesforce/Force.com library for communicating with the Twilio REST API and generating TwiML. Need help? Post your questions to http://getsatisfaction.com/twilio or email us at help@twilio.com
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Deprecation Notice
_Note: this library is deprecated and *not recommended for new work.* Please see the [Twilio Salesforce](http://www.twilio.com/docs/salesforce) documentation for new work with Twilio and Salesforce._

# Twilio Helper Library for Salesforce

Get ready to unleash the power of the Twilio cloud communications platform in Salesforce and Force.com!  Soon you'll be building powerful voice and text messaging apps in Apex and Visualforce.

With this toolkit you'll be able to:

* Make requests to Twilio's [REST API](http://www.twilio.com/docs/api)
* Control phone calls and respond to text messages in real time with [TwiML](http://www.twilio.com/docs/api/twiml)
* Embed [Twilio Client](http://www.twilio.com/docs/client) in-browser calling in your Salesforce and Force.com apps


Installation
============

We've made it easy to get started. Just grab the code from GitHub and deploy it to your Salesforce org with the included Ant script.

**Quick Install**: If you do not have the existing Twilio-Salesforce library installed, you can use this unmanaged package to install: 
v4.2.0 <https://login.salesforce.com/packaging/installPackage.apexp?p0=04t1a000000AQzf>


v3.2.0 <https://login.salesforce.com/packaging/installPackage.apexp?p0=04ti0000000XkE0>


If you have a previous version of Twilio-Salesforce library installed, you will need to use Ant to install/update:


1. Checkout or download the [twilio-salesforce](https://github.com/twilio/twilio-salesforce) library from GitHub.

    ```bash
    $ git clone git@github.com:twilio/twilio-salesforce.git
    ```

1. Install the [Force.com Migration Tool](http://www.salesforce.com/us/developer/docs/daas/Content/forcemigrationtool_install.htm) plugin for Ant, if you don't already have it.

1. Edit `install/build.properties` to insert your Salesforce username and password.  Since you will be using the API to access Salesforce, remember to [append your Security Token](http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_concepts_security.htm#topic-title_login_token) to your password.

1. Open your command line to the `install` folder, then deploy using Ant:

    ```bash
    $ ant deployTwilio
    ```

Now all the library code is in your org and you're ready to start coding!



Quickstart
==========

Getting started with the Twilio API couldn't be easier. Create a Twilio REST client to get started. For example, the following code makes a call using the Twilio REST API.

Make a Call
-----------
This sample calls the `to` phone number and plays music.  The `from` number must be a [verified number](https://www.twilio.com/user/account/phone-numbers/verified) on your Twilio account.

```javascript
// Find your Twilio API credentials at https://www.twilio.com/user/account
String account = 'ACXXXXXXXXXXXXXXXXX';
String token = 'YYYYYYYYYYYYYYYYYY';

TwilioRestClient client = new TwilioRestClient(account, token);

Map<String,String> params = new Map<String,String> {
        'To'   => '9991231234',
        'From' => '9991231234',
        'Url'  => 'http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient'
    };
TwilioCall call = client.getAccount().getCalls().create(params);
```

Send an SMS
-----------
This sample texts *Hello there!* to the `to` phone number.  The `from` number must be a number which you have purchased from Twilio. Unlike voice calls, SMS messages cannot be sent from a verified number.

```javascript
String account = 'ACXXXXXXXXXXXXXXXXX';
String token = 'YYYYYYYYYYYYYYYYYY';
TwilioRestClient client = new TwilioRestClient(account, token);

Map<String,String> params = new Map<String,String> {
        'To'   => '+12316851234',
        'From' => '+15555555555',
        'Body' => 'Hello there!'
    };
TwilioSMS sms = client.getAccount().getSMSMessages().create(params);
```

Generate TwiML
--------------

To control phone calls, your application needs to output [TwiML](http://www.twilio.com/docs/api/twiml/). Use `TwilioTwiML.Response` to easily create a TwiML document.

```javascript
TwilioTwiML.Response r = new TwilioTwiML.Response();
TwilioTwiML.Play p = new TwilioTwimL.Play('https://api.twilio.com/cowbell.mp3');
p.setLoop(5);
r.append(p);
System.debug(r.toXML());
```

```xml
<Response><Play loop="5">https://api.twilio.com/cowbell.mp3</Play><Response>
```



Next Steps
==========

The full power of the Twilio API is at your fingertips. Visit the [full documentation](https://twilio-salesforce.readthedocs.org/en/latest/) for advanced topics.