components/camel-twilio/src/main/docs/twilio-component.adoc

= Twilio Component
:doctitle: Twilio
:shortname: twilio
:artifactid: camel-twilio
:description: Interact with Twilio REST APIs using Twilio Java SDK.
:since: 2.20
:supportlevel: Stable
:tabs-sync-option:
:component-header: Both producer and consumer are supported
//Manually maintained attributes
:camel-spring-boot-name: twilio

*Since Camel {since}*

*{component-header}*

The Twilio component provides access to Version 2010-04-01 of Twilio REST APIs accessible
using https://github.com/twilio/twilio-java[Twilio Java SDK].

Maven users will need to add the following dependency to their pom.xml
for this component:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-twilio</artifactId>
    <version>${camel-version}</version>
</dependency>
----


// component-configure options: START

// component-configure options: END

// component options: START
include::partial$component-configure-options.adoc[]
include::partial$component-endpoint-options.adoc[]
// component options: END

// endpoint options: START

// endpoint options: END


== Producer Endpoints:

Producer endpoints can use endpoint prefixes followed by endpoint names
and associated options described next. A shorthand alias can be used for
all of the endpoints. The endpoint URI MUST contain a prefix.

Any of the endpoint options can be provided in either the endpoint URI,
or dynamically in a message header. The message header name must be of
the format *`CamelTwilio.<option>`*. Note that the *`inBody`* option
overrides message header, i.e. the endpoint option *`inBody=option`*
would override a *`CamelTwilio.option`* header.

Endpoint can be one of:

[width="100%",cols="20%,20%,60%",options="header"]
|=======================================================================
| Endpoint  | Shorthand Alias | Description
| *creator* | create          | Make the request to the Twilio API to perform the create
| *deleter* | delete          | Make the request to the Twilio API to perform the delete
| *fetcher* | fetch           | Make the request to the Twilio API to perform the fetch
| *reader*  | read            | Make the request to the Twilio API to perform the read
| *updater* | update          | Make the request to the Twilio API to perform the update
|=======================================================================

Available endpoints differ depending on the endpoint prefixes.

For more information on the endpoints and options see API documentation at:
https://www.twilio.com/docs/libraries/reference/twilio-java/index.html



include::spring-boot:partial$starter.adoc[]