org.mule.modules.twilio

Class TwilioConnector

java.lang.Object

org.mule.modules.twilio.TwilioConnector

@RequiresEnterpriseLicense(allowEval=true)
 @Connector(name="twilio",
           schemaVersion="2.0",
           friendlyName="Twilio",
           minMuleVersion="3.8")
public class TwilioConnector
extends Object

Constructor Summary

Constructors

Constructor and Description
TwilioConnector()

Method Summary

Modifier and Type	Method and Description
void	deleteMedia(String DateCreated, String AccountSid, String MessageSid, String MediaSid) Delete Media
void	deleteMessage(String AccountSid, String MessageSid) Delete Message
AbstractConfig	getConfig()
GetMediaResponse	getMedia(String DateCreated, String AccountSid, String MessageSid, String MediaSid) Get Media
GetMediaListResponse	getMediaList(String DateCreated, String AccountSid, String MessageSid) Get Media List
GetMessageResponse	getMessage(String AccountSid, String MessageSid) Get Message
GetMessageListResponse	getMessageList(String To, String From, String DateSent, String AccountSid) Get Message List
RestClientConfigProvider<?>	getRestClientConfigProvider()
RedactMessageResponse	redactMessage(String AccountSid, String MessageSid, RedactInput entity) Redact Message
SendMessageResponse	sendMessage(String AccountSid, MessageInput entity) Send Message
void	setConfig(AbstractConfig config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TwilioConnector

public TwilioConnector()

Method Detail

getConfig

public AbstractConfig getConfig()

setConfig

public void setConfig(AbstractConfig config)

getRestClientConfigProvider

public RestClientConfigProvider<?> getRestClientConfigProvider()

getMessageList

@Processor(friendlyName="Get Message List")
public GetMessageListResponse getMessageList(@Optional
                                                                                         String To,
                                                                                         @Optional
                                                                                         String From,
                                                                                         @Optional
                                                                                         String DateSent,
                                                                                         String AccountSid)

Get Message List

Retrieves a list of messages associated with the user account. The list includes paging information.

Parameters:

To - Only show messages to this phone number.

From - Only show messages from this phone number or alphanumeric sender ID.

DateSent - Only show messages sent on this date (in GMT format), given as YYYY-MM-DD. Example: DateSent=2009-07-06. You can also specify inequality, such as DateSent<=YYYY-MM-DD for messages that were sent on or before midnight on a date, and DateSent>=YYYY-MM-DD for messages sent on or after midnight on a date.

AccountSid - A 34 character string that uniquely identifies the user account.

Returns:

org.mule.modules.twilio.pojo.getmessagelistresponse.GetMessageListResponse entity with the response result

sendMessage

@Processor(friendlyName="Send Message")
public SendMessageResponse sendMessage(String AccountSid,
                                                                               @RefOnly @Default(value="#[payload]")
                                                                               MessageInput entity)

Send Message

Sends a new outgoing message.

Parameters:

AccountSid - A 34 character string that uniquely identifies the user account.

Returns:

org.mule.modules.twilio.pojo.sendmessageresponse.SendMessageResponse entity with the response result

getMessage

@Processor(friendlyName="Get Message")
public GetMessageResponse getMessage(String AccountSid,
                                                                            String MessageSid)

Get Message

Returns a single message specified by the provided Message SID.

Parameters:

AccountSid - A 34 character string that uniquely identifies the user account.

MessageSid - Unique ID for any message successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

Returns:

org.mule.modules.twilio.pojo.getmessageresponse.GetMessageResponse entity with the response result

redactMessage

@Processor(friendlyName="Redact Message")
public RedactMessageResponse redactMessage(String AccountSid,
                                                                                     String MessageSid,
                                                                                     @RefOnly @Default(value="#[payload]")
                                                                                     RedactInput entity)

Redact Message

Removes (blacks-out) the body from a previously sent message record. Usually done for security purposes, when a user doesn't want to delete the message from history entirely. Redacting a message is done by posting an empty body to the message resource. NOTE: To redact is to edit. Frequently, a redacted document has simply had personal (or possibly actionable) information deleted or blacked out; as a consequence, redacted is often used to describe documents from which sensitive information has been expunged.

Parameters:

AccountSid - A 34 character string that uniquely identifies the user account.

MessageSid - Unique ID for any message successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

Returns:

org.mule.modules.twilio.pojo.redactmessageresponse.RedactMessageResponse entity with the response result

deleteMessage

@Processor(friendlyName="Delete Message")
public void deleteMessage(String AccountSid,
                                                                    String MessageSid)

Delete Message

Deletes a message record from the user account. Once the record is deleted, it will no longer appear in the API and Account Portal logs. However, deleting a message does not delete any media associated with the message. That media is still available at its original URI.

Parameters:

AccountSid - A 34 character string that uniquely identifies the user account.

MessageSid - Unique ID for any message successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

getMediaList

@Processor(friendlyName="Get Media List")
public GetMediaListResponse getMediaList(@Optional
                                                                                   String DateCreated,
                                                                                   String AccountSid,
                                                                                   String MessageSid)

Get Media List

Retrieves a list of media associated with the message.

Parameters:

DateCreated - Only show media created on the given date. Should be formatted as YYYY-MM-DD. You can also specify inequality, such as DateCreated<=YYYY-MM-DD for media generated at or before midnight on a date, and DateCreated>=YYYY-MM-DD for media generated at or after midnight on a date.

AccountSid - A 34 character string that uniquely identifies the user account.

MessageSid - Unique ID for any message successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

Returns:

org.mule.modules.twilio.pojo.getmedialistresponse.GetMediaListResponse entity with the response result

getMedia

@Processor(friendlyName="Get Media")
public GetMediaResponse getMedia(@Optional
                                                                      String DateCreated,
                                                                      String AccountSid,
                                                                      String MessageSid,
                                                                      String MediaSid)

Get Media

Retrieves a single media resource using one of several representations.

Parameters:

DateCreated - Only show media created on the given date. Should be formatted as YYYY-MM-DD. You can also specify inequality, such as DateCreated<=YYYY-MM-DD for media generated at or before midnight on a date, and DateCreated>=YYYY-MM-DD for media generated at or after midnight on a date.

AccountSid - A 34 character string that uniquely identifies the user account.

MessageSid - Unique ID for any message successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

MediaSid - Unique ID for any media successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

Returns:

org.mule.modules.twilio.pojo.getmediaresponse.GetMediaResponse entity with the response result

deleteMedia

@Processor(friendlyName="Delete Media")
public void deleteMedia(@Optional
                                                                String DateCreated,
                                                                String AccountSid,
                                                                String MessageSid,
                                                                String MediaSid)

Delete Media

Deletes Media from the user account. Once the media is deleted, you will no longer be billed for this storage.

Parameters:

DateCreated - Only show media created on the given date. Should be formatted as YYYY-MM-DD. You can also specify inequality, such as DateCreated<=YYYY-MM-DD for media generated at or before midnight on a date, and DateCreated>=YYYY-MM-DD for media generated at or after midnight on a date.

AccountSid - A 34 character string that uniquely identifies the user account.

MessageSid - Unique ID for any message successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.

MediaSid - Unique ID for any media successfully created by Twilio’s API. It is a 34 character string that starts with “SM…” for SMS and “MM…” for MMS. To find the SID for a specific message via the API, make a GET request to the Messages List Resource. This will return a list of SMS messages associated with your account along with details about each message. It would be the “Sid” property in a message resource.