The Twilio for Salesforce package includes an Apex helper class that reduces the amount of code needed to interact with Twilio APIs. The Lightning components in the package focus only on SMS, so the helper class provides you with a way to write custom Apex to interact with any of Twilio's APIs, such as Voice and Chat.
Code samples are written in Apex, but are labeled as Java for syntax highlighting purposes.
_17//Post Example_17TwilioSF.TwilioApiClient api = new TwilioSF.TwilioApiClient();_17api.addUrlPart('Accounts');_17api.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_17api.addUrlPart('Messages.json');_17_17api.addParam('To','+15558675310');_17api.addParam('From','+15017122661');_17api.addParam('Body','Here is my message');_17TwilioSF.TwilioApiClientResponse response = api.doPost();_17_17//Example with key value pairs_17String sid = response.getTwilioJsonParser().get('sid').getString();_17Integer totalSegments = response.getTwilioJsonParser().get('num_segments').getInteger();_17_17//Example a key with object_17String media = response.getTwilioJsonParser().get('subresource_uris').get('media').getString();
Twilio will verify that you've included a valid Twilio phone number in the From parameter, then either queue the call or return an error.
Check out the Messages API reference for the full list of parameters you can include in your request. You can add these using the addUrlPart method. You can also find the properties you can expect in the response from Twilio.
_16//Put Example with failures_16TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_16//Switch for throwing exceptions,=._16//client.setThrowExceptionsOnFailedResponses();_16client.addUrlPart('Accounts');_16client.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_16client.addUrlPart('Messages.json');_16_16client.addParam('To','+15017122661');_16client.addParam('From','+15558675310');_16client.addParam('Body','Here is my message');_16_16_16TwilioSF.TwilioApiClientResponse response = client.doPut();_16system.debug(response.hasError());_16system.debug(response.getErrorMessage());
Use TwilioApiClientResponse to retrieve the status code and error message from your request.
_12//Get Messages No Params_12TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_12client.addUrlPart('Accounts');_12client.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_12client.addUrlPart('Messages');_12client.addUrlPart('.json');_12TwilioSF.TwilioApiClientResponse response = client.doGet();_12_12system.debug(response.getTwilioJsonParser().get('first_page_uri').getString());_12system.debug(response.getTwilioJsonParser().get('previous_page_uri').getString());_12system.debug(response.getTwilioJsonParser().get('end').getInteger());_12system.debug(JSON.serializePretty(response.toMap()));
This example shows you how to pull a list of messages from Twilio. By default, this method will return 50 results. The maximum number of records in a single request is 1000. You can set how many results are returned using the pageSize param.
See the "get messages with pagination" examples for retrieving larger groups of messages.
_21//Get Messages with Params_21TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_21client.addUrlPart('Accounts');_21client.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_21client.addUrlPart('Messages');_21client.addUrlPart('.json');_21_21client.addParam('To','+15558675310');_21client.addParam('PageSize','5');_21client.addParam('DateSent','2018-06-01','>=');_21TwilioSF.TwilioApiClientResponse response = client.doGet();_21_21system.debug(response.getTwilioJsonParser().get('previous_page_uri').getString());_21system.debug(response.getTwilioJsonParser().get('page_size').getInteger());_21system.debug(JSON.serializePretty(response.toMap()));_21_21String messagesString = response.getTwilioJsonParser().get('messages').getString();_21List<TwilioJsonParser> messagesArray = response.getTwilioArrayJsonParser(messagesString);_21for(TwilioJsonParser p:messagesArray){_21 system.debug(p.get('sid').getString());_21}
This example demonstrates how to retrieve a list of messages that match specified criteria. See this documentation to view additional options for filtering messages.
_18//Pagination_18TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_18client.addUrlPart('Accounts');_18client.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_18client.addUrlPart('Messages');_18client.addUrlPart('.json');_18_18_18TwilioSF.TwilioApiClientResponse response = client.doGet();_18String nextPage = response.getTwilioJsonParser().get('next_page_uri').getString();_18client.setNextUrl(nextPage);_18while (client.hasNextPage()) {_18 response = client.doGetNext();_18 if(response.responseBody != null){_18 nextPage = response.getTwilioJsonParser().get('next_page_uri').getString();_18 client.setNextUrl(nextPage);_18 }_18}
Get all messages in your Twilio account using pagination. In this example, you get the next page URL if it exists, and then call it in your Twilio client.
_22//Pagination Example_22TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_22client.addUrlPart('Accounts');_22client.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_22client.addUrlPart('Messages');_22client.addUrlPart('.json');_22_22_22TwilioSF.TwilioApiClientResponse response = client.doGet();_22String nextPage = response.getTwilioJsonParser().get('next_page_uri').getString();_22client.setNextUrl(nextPage);_22if(client.hasNextPage()){_22 response = client.doGetNext();_22_22 String previousPage = response.getTwilioJsonParser().get('previous_page_uri').getString();_22 client.setPreviousUrl(previousPage);_22_22 if(client.hasPreviousPage()){_22 response = client.doGetPrevious();_22 system.debug(response.getTwilioJsonParser().get('uri').getString());_22 }_22}
_10//Delete Example_10TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_10_10client.addUrlPart('Accounts');_10client.addUrlPart('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_10client.addUrlPart('Messages');_10client.addUrlPart('SMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json');_10_10TwilioApiClientResponse response = client.doDelete();_10system.debug(response.getHtttpStatusCode());
_10//Get Messages Services_10TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_10TwilioSF.TwilioApiClientResponse response = client.doGet('https://messaging.twilio.com/v1/Services');_10system.debug(JSON.serializePretty(response.toMap()));
A messaging service is a pool of phone numbers that properly encodes your message body, matches the recipient's area code, and distributes SMS across multiple numbers. You can read more about messaging services here.
This code example demonstrates how to get a list of Messaging Services in your account.
_13TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_13client.setBaseUrl('https://messaging.twilio.com/');_13client.setApiVersion('v1');_13client.addUrlPart('Services');_13client.addUrlPart('MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_13_13client.addParam('FriendlyName','Dev Org1');_13TwilioSF.TwilioApiClientResponse response = client.doPost();_13_13system.debug(response.getTwilioJsonParser().get('friendly_name').getString());_13system.debug(response.getTwilioJsonParser().get('area_code_geomatch').getBoolean());_13system.debug(response.getTwilioJsonParser().get('links').get('phone_numbers').getString());_13system.debug(JSON.serializePretty(response.toMap()));
This example shows you how to update the friendly name of a messaging service using the Twilio API.
_20//Task Router Get Reservations_20TwilioSF.TwilioApiClient client = new TwilioSF.TwilioApiClient();_20client.setBaseUrl('https://taskrouter.twilio.com/');_20client.setApiVersion('v1');_20client.addUrlPart('Workspaces');_20client.addUrlPart('WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_20client.addUrlPart('Workers');_20client.addUrlPart('WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');_20client.addUrlPart('Reservations');_20_20TwilioSF.TwilioApiClientResponse response = client.doGet();_20system.debug(response.getTwilioJsonParser().get('meta').get('first_page_url').getString());_20system.debug(JSON.serializePretty(response.toMap()));_20String messagesString = response.getTwilioJsonParser().get('reservations').getString();_20List<TwilioJsonParser> messagesArray = response.getTwilioArrayJsonParser(messagesString);_20for(TwilioJsonParser p:messagesArray){_20 system.debug(p.get('worker_sid').getString());_20 system.debug(p.get('date_updated').getDatetime());_20 system.debug(p.get('links').get('task').getString());_20}
Taskrouter is an API for tracking the availability of call center workers and routing tasks to the appropriate worker. In this example, we pull the current list of open ("reserved") tasks for an individual worker.