Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
No |
Mule Version |
3.8.0 or higher |
Configs
Basic Authentication
<twilio:config>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
username |
x |
|||
password |
x |
|||
apiUrl |
Base URL for the API. |
|
Processors
Get Message List
<twilio:get-message-list>
Get Message List Retrieves a list of messages associated with the user account. The list includes paging information.
XML Sample
<twilio:get-message-list config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
x |
Returns
| Return Java Type | Description |
|---|---|
org.mule.modules.twilio.pojo.getmessagelistresponse.GetMessageListResponse entity with the response result |
Send Message
<twilio:send-message>
Send Message Sends a new outgoing message.
XML Sample
<twilio:send-message config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" entity="#[payload]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
AccountSid |
A 34 character string that uniquely identifies the user account. |
x |
||
entity |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
org.mule.modules.twilio.pojo.sendmessageresponse.SendMessageResponse entity with the response result |
Get Message
<twilio:get-message>
Get Message Returns a single message specified by the provided Message SID.
XML Sample
<twilio:get-message config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" MessageSid="SM800f449d0399ed014aae2bcc0cc2f2ec" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
AccountSid |
A 34 character string that uniquely identifies the user account. |
x |
||
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. |
x |
Returns
| Return Java Type | Description |
|---|---|
org.mule.modules.twilio.pojo.getmessageresponse.GetMessageResponse entity with the response result |
Redact Message
<twilio:redact-message>
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.
XML Sample
<twilio:redact-message config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" MessageSid="SM800f449d0399ed014aae2bcc0cc2f2ec" entity="#[payload]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
AccountSid |
A 34 character string that uniquely identifies the user account. |
x |
||
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. |
x |
||
entity |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
org.mule.modules.twilio.pojo.redactmessageresponse.RedactMessageResponse entity with the response result |
Delete Message
<twilio:delete-message>
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.
XML Sample
<twilio:delete-message config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" MessageSid="entity="#[payload] />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
AccountSid |
A 34 character string that uniquely identifies the user account. |
x |
||
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. |
x |
Get Media List
<twilio:get-media-list>
Get Media List Retrieves a list of media associated with the message.
XML Sample
<twilio:get-media-list config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" MessageSid="MM800f449d0399ed014aae2bcc0cc2f2ec" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
x |
||
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. |
x |
Returns
| Return Java Type | Description |
|---|---|
org.mule.modules.twilio.pojo.getmedialistresponse.GetMediaListResponse entity with the response result |
Get Media
<twilio:get-media>
Get Media Retrieves a single media resource using one of several representations.
XML Sample
<twilio:get-media config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" MessageSid="MM800f449d0399ed014aae2bcc0cc2f2ec" MediaSid="#[flowVars.MediaSid]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
x |
||
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. |
x |
||
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. |
x |
Returns
| Return Java Type | Description |
|---|---|
org.mule.modules.twilio.pojo.getmediaresponse.GetMediaResponse entity with the response result |
Delete Media
<twilio:delete-media>
Delete Media Deletes Media from the user account. Once the media is deleted, you will no longer be billed for this storage.
XML Sample
<twilio:delete-media config-ref="Twilio__Configuration" AccountSid="ACc222f888caf8de421a99f99fd244d088" MessageSid="MM800f449d0399ed014aae2bcc0cc2f2ec" MediaSid="ME85ebf7e12cb821f84b319340424dcb02" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
x |
||
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. |
x |
||
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. |
x |