Twilio
Since Camel 2.20
Both producer and consumer are supported
The Twilio component provides access to Version 2010-04-01 of Twilio REST APIs accessible using Twilio Java SDK.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-twilio</artifactId>
<version>${camel-version}</version>
</dependency>
Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The Twilio component supports 8 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
To use the shared configuration. |
TwilioConfiguration |
||
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
boolean |
|
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
boolean |
|
Autowired To use the shared REST client. |
TwilioRestClient |
||
The account SID to use. |
String |
||
Auth token for the account. |
String |
||
The account to use. |
String |
Endpoint Options
The Twilio endpoint is configured using URI syntax:
twilio:apiName/methodName
with the following path and query parameters:
Path Parameters (2 parameters)
Name | Description | Default | Type |
---|---|---|---|
Required What kind of operation to perform. Enum values:
|
TwilioApiName |
||
Required What sub operation to use for the selected operation. Enum values:
|
String |
Query Parameters (21 parameters)
Name | Description | Default | Type |
---|---|---|---|
Sets the name of a parameter to be passed in the exchange In Body. |
String |
||
If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
false |
boolean |
|
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
boolean |
|
To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
ExceptionHandler |
||
Sets the exchange pattern when the consumer creates an exchange. Enum values:
|
ExchangePattern |
||
A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |
PollingConsumerPollStrategy |
||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
|
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
int |
||
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |
int |
||
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |
int |
||
Milliseconds before the next poll. |
500 |
long |
|
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
false |
boolean |
|
Milliseconds before the first poll starts. |
1000 |
long |
|
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. |
0 |
long |
|
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. Enum values:
|
TRACE |
LoggingLevel |
|
Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |
ScheduledExecutorService |
||
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. |
none |
Object |
|
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. |
Map |
||
Whether the scheduler should be auto started. |
true |
boolean |
|
Time unit for initialDelay and delay options. Enum values:
|
MILLISECONDS |
TimeUnit |
|
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
true |
boolean |
API Parameters (56 APIs)
The Twilio endpoint is an API based component and has additional parameters based on which API name and API method is used.
The API name and API method is located in the endpoint URI as the apiName/methodName
path parameters:
twilio:apiName/methodName
There are 56 API names as listed in the table below:
API Name | Type | Description |
---|---|---|
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
||
Both |
Each API is documented in the following sections to come.
API: account
Both producer and consumer are supported
The account API is defined in the syntax as follows:
twilio:account/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a AccountFetcher to execute fetch |
|
update |
Create a AccountUpdater to execute update |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.AccountFetcher fetcher();
-
com.twilio.rest.api.v2010.AccountFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathSid |
Fetch by unique Account Sid |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.AccountUpdater updater();
-
com.twilio.rest.api.v2010.AccountUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathSid |
Update by unique Account Sid |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: address
Both producer and consumer are supported
The address API is defined in the syntax as follows:
twilio:address/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a AddressCreator to execute create |
|
delete |
Create a AddressDeleter to execute delete |
|
fetch |
Create a AddressFetcher to execute fetch |
|
read |
Create a AddressReader to execute read |
|
update |
Create a AddressUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.AddressCreator creator(String customerName, String street, String city, String region, String postalCode, String isoCountry);
-
com.twilio.rest.api.v2010.account.AddressCreator creator(String pathAccountSid, String customerName, String street, String city, String region, String postalCode, String isoCountry);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
city |
The city of the new address |
String |
customerName |
The name to associate with the new address |
String |
isoCountry |
The ISO country code of the new address |
String |
pathAccountSid |
The SID of the Account that will be responsible for the new Address resource |
String |
postalCode |
The postal code of the new address |
String |
region |
The state or region of the new address |
String |
street |
The number and street address of the new address |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that is responsible for the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that is responsible for this address |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.AddressReader reader();
-
com.twilio.rest.api.v2010.account.AddressReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that is responsible for this address |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that is responsible for the resource to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: address-dependent-phone-number
Both producer and consumer are supported
The address-dependent-phone-number API is defined in the syntax as follows:
twilio:address-dependent-phone-number/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a DependentPhoneNumberReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAccountSid, String pathAddressSid);
-
com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAddressSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathAddressSid |
The SID of the Address resource associated with the phone number |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: application
Both producer and consumer are supported
The application API is defined in the syntax as follows:
twilio:application/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a ApplicationCreator to execute create |
|
delete |
Create a ApplicationDeleter to execute delete |
|
fetch |
Create a ApplicationFetcher to execute fetch |
|
read |
Create a ApplicationReader to execute read |
|
update |
Create a ApplicationUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.ApplicationCreator creator();
-
com.twilio.rest.api.v2010.account.ApplicationCreator creator(String pathAccountSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.ApplicationReader reader();
-
com.twilio.rest.api.v2010.account.ApplicationReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: available-phone-number-country
Both producer and consumer are supported
The available-phone-number-country API is defined in the syntax as follows:
twilio:available-phone-number-country/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a AvailablePhoneNumberCountryFetcher to execute fetch |
|
read |
Create a AvailablePhoneNumberCountryReader to execute read |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathAccountSid, String pathCountryCode);
-
com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathCountryCode);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account requesting the available phone number Country resource |
String |
pathCountryCode |
The ISO country code of the country to fetch available phone number information about |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader();
-
com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account requesting the available phone number Country resources |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: available-phone-number-country-local
Both producer and consumer are supported
The available-phone-number-country-local API is defined in the syntax as follows:
twilio:available-phone-number-country-local/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a LocalReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathAccountSid, String pathCountryCode);
-
com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathCountryCode);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account requesting the AvailablePhoneNumber resources |
String |
pathCountryCode |
The ISO Country code of the country from which to read phone numbers |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: available-phone-number-country-mobile
Both producer and consumer are supported
The available-phone-number-country-mobile API is defined in the syntax as follows:
twilio:available-phone-number-country-mobile/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a MobileReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathAccountSid, String pathCountryCode);
-
com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathCountryCode);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account requesting the AvailablePhoneNumber resources |
String |
pathCountryCode |
The ISO Country code of the country from which to read phone numbers |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: available-phone-number-country-toll-free
Both producer and consumer are supported
The available-phone-number-country-toll-free API is defined in the syntax as follows:
twilio:available-phone-number-country-toll-free/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a TollFreeReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathAccountSid, String pathCountryCode);
-
com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathCountryCode);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account requesting the AvailablePhoneNumber resources |
String |
pathCountryCode |
The ISO Country code of the country from which to read phone numbers |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: call
Both producer and consumer are supported
The call API is defined in the syntax as follows:
twilio:call/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a CallCreator to execute create |
|
delete |
Create a CallDeleter to execute delete |
|
fetch |
Create a CallFetcher to execute fetch |
|
read |
Create a CallReader to execute read |
|
update |
Create a CallUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid);
-
com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml);
-
com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url);
-
com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid);
-
com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml);
-
com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
applicationSid |
The SID of the Application resource that will handle the call |
String |
from |
Twilio number from which to originate the call |
Endpoint |
pathAccountSid |
The SID of the Account that will create the resource |
String |
to |
Phone number, SIP address, or client identifier to call |
Endpoint |
twiml |
TwiML instructions for the call |
Twiml |
url |
The absolute URL that returns TwiML for this call |
URI |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to delete |
String |
pathSid |
The unique string that identifies this resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
pathSid |
The SID of the Call resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.CallReader reader();
-
com.twilio.rest.api.v2010.account.CallReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.CallUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.CallUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to update |
String |
pathSid |
The unique string that identifies this resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: call-feedback
Both producer and consumer are supported
The call-feedback API is defined in the syntax as follows:
twilio:call-feedback/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a FeedbackCreator to execute create |
|
fetch |
Create a FeedbackFetcher to execute fetch |
|
update |
Create a FeedbackUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.call.FeedbackCreator creator(String pathAccountSid, String pathCallSid, Integer qualityScore);
-
com.twilio.rest.api.v2010.account.call.FeedbackCreator creator(String pathCallSid, Integer qualityScore);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathCallSid |
The call sid that uniquely identifies the call |
String |
qualityScore |
The call quality expressed as an integer from 1 to 5 |
Integer |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.call.FeedbackFetcher fetcher(String pathAccountSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.call.FeedbackFetcher fetcher(String pathCallSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathCallSid |
The call sid that uniquely identifies the call |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.call.FeedbackUpdater updater(String pathAccountSid, String pathCallSid, Integer qualityScore);
-
com.twilio.rest.api.v2010.account.call.FeedbackUpdater updater(String pathCallSid, Integer qualityScore);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathCallSid |
The call sid that uniquely identifies the call |
String |
qualityScore |
The call quality expressed as an integer from 1 to 5 |
Integer |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: call-feedback-summary
Both producer and consumer are supported
The call-feedback-summary API is defined in the syntax as follows:
twilio:call-feedback-summary/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a FeedbackSummaryCreator to execute create |
|
delete |
Create a FeedbackSummaryDeleter to execute delete |
|
fetch |
Create a FeedbackSummaryFetcher to execute fetch |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.call.FeedbackSummaryCreator creator(String pathAccountSid, org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate);
-
com.twilio.rest.api.v2010.account.call.FeedbackSummaryCreator creator(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
endDate |
Only include feedback given on or before this date |
LocalDate |
pathAccountSid |
The unique sid that identifies this account |
String |
startDate |
Only include feedback given on or after this date |
LocalDate |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.call.FeedbackSummaryDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.call.FeedbackSummaryDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathSid |
A string that uniquely identifies this feedback summary resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.call.FeedbackSummaryFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.call.FeedbackSummaryFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathSid |
A string that uniquely identifies this feedback summary resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: call-notification
Both producer and consumer are supported
The call-notification API is defined in the syntax as follows:
twilio:call-notification/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a NotificationFetcher to execute fetch |
|
read |
Create a NotificationReader to execute read |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid);
-
com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathCallSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathCallSid |
The Call SID of the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathAccountSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathCallSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathCallSid |
The Call SID of the resource to fetch |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: call-recording
Both producer and consumer are supported
The call-recording API is defined in the syntax as follows:
twilio:call-recording/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a RecordingCreator to execute create |
|
delete |
Create a RecordingDeleter to execute delete |
|
fetch |
Create a RecordingFetcher to execute fetch |
|
read |
Create a RecordingReader to execute read |
|
update |
Create a RecordingUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathAccountSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathCallSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
pathCallSid |
The SID of the Call to associate the resource with |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathAccountSid, String pathCallSid, String pathSid);
-
com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathCallSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathCallSid |
The SID of the Call to associate the resource with |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid);
-
com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathCallSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathCallSid |
The SID of the Call to associate the resource with |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathAccountSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathCallSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathCallSid |
The SID of the Call to associate the resource with |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathAccountSid, String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording.Status status);
-
com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording.Status status);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to update |
String |
pathCallSid |
The SID of the Call to associate the resource with |
String |
pathSid |
The unique string that identifies the resource |
String |
status |
The new status of the recording |
Status |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: conference
Both producer and consumer are supported
The conference API is defined in the syntax as follows:
twilio:conference/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a ConferenceFetcher to execute fetch |
|
read |
Create a ConferenceReader to execute read |
|
update |
Create a ConferenceUpdater to execute update |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
pathSid |
The unique string that identifies this resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.ConferenceReader reader();
-
com.twilio.rest.api.v2010.account.ConferenceReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to update |
String |
pathSid |
The unique string that identifies this resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: conference-participant
Both producer and consumer are supported
The conference-participant API is defined in the syntax as follows:
twilio:conference-participant/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a ParticipantCreator to execute create |
|
delete |
Create a ParticipantDeleter to execute delete |
|
fetch |
Create a ParticipantFetcher to execute fetch |
|
read |
Create a ParticipantReader to execute read |
|
update |
Create a ParticipantUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathAccountSid, String pathConferenceSid, com.twilio.type.PhoneNumber from, com.twilio.type.PhoneNumber to);
-
com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathConferenceSid, com.twilio.type.PhoneNumber from, com.twilio.type.PhoneNumber to);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
from |
The phone number, Client identifier, or username portion of SIP address that made this call. |
PhoneNumber |
pathAccountSid |
The SID of the Account that will create the resource |
String |
pathConferenceSid |
The SID of the participant’s conference |
String |
to |
The phone number, SIP address or Client identifier that received this call. |
PhoneNumber |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathAccountSid, String pathConferenceSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathConferenceSid, String pathCallSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathCallSid |
The Call SID or URL encoded label of the participant to delete |
String |
pathConferenceSid |
The SID of the participant’s conference |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathAccountSid, String pathConferenceSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathConferenceSid, String pathCallSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathCallSid |
The Call SID or URL encoded label of the participant to fetch |
String |
pathConferenceSid |
The SID of the participant’s conference |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathAccountSid, String pathConferenceSid);
-
com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathConferenceSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathConferenceSid |
The SID of the participant’s conference |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathAccountSid, String pathConferenceSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathConferenceSid, String pathCallSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to update |
String |
pathCallSid |
The Call SID or URL encoded label of the participant to update |
String |
pathConferenceSid |
The SID of the participant’s conference |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: connect-app
Both producer and consumer are supported
The connect-app API is defined in the syntax as follows:
twilio:connect-app/methodName?[parameters]
The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a ConnectAppDeleter to execute delete |
|
fetch |
Create a ConnectAppFetcher to execute fetch |
|
read |
Create a ConnectAppReader to execute read |
|
update |
Create a ConnectAppUpdater to execute update |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.ConnectAppReader reader();
-
com.twilio.rest.api.v2010.account.ConnectAppReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: incoming-phone-number
Both producer and consumer are supported
The incoming-phone-number API is defined in the syntax as follows:
twilio:incoming-phone-number/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a IncomingPhoneNumberCreator to execute create |
|
delete |
Create a IncomingPhoneNumberDeleter to execute delete |
|
fetch |
Create a IncomingPhoneNumberFetcher to execute fetch |
|
read |
Create a IncomingPhoneNumberReader to execute read |
|
update |
Create a IncomingPhoneNumberUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String areaCode);
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, String areaCode);
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(com.twilio.type.PhoneNumber phoneNumber);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
areaCode |
The desired area code for the new phone number |
String |
pathAccountSid |
The SID of the Account that will create the resource |
String |
phoneNumber |
The phone number to purchase in E.164 format |
PhoneNumber |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader();
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: incoming-phone-number-local
Both producer and consumer are supported
The incoming-phone-number-local API is defined in the syntax as follows:
twilio:incoming-phone-number-local/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a LocalCreator to execute create |
|
read |
Create a LocalReader to execute read |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
-
com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(com.twilio.type.PhoneNumber phoneNumber);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
phoneNumber |
The phone number to purchase in E.164 format |
PhoneNumber |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader();
-
com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: incoming-phone-number-mobile
Both producer and consumer are supported
The incoming-phone-number-mobile API is defined in the syntax as follows:
twilio:incoming-phone-number-mobile/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a MobileCreator to execute create |
|
read |
Create a MobileReader to execute read |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
-
com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(com.twilio.type.PhoneNumber phoneNumber);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
phoneNumber |
The phone number to purchase in E.164 format |
PhoneNumber |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader();
-
com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: incoming-phone-number-toll-free
Both producer and consumer are supported
The incoming-phone-number-toll-free API is defined in the syntax as follows:
twilio:incoming-phone-number-toll-free/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a TollFreeCreator to execute create |
|
read |
Create a TollFreeReader to execute read |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
-
com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(com.twilio.type.PhoneNumber phoneNumber);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
phoneNumber |
The phone number to purchase in E.164 format |
PhoneNumber |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader();
-
com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: key
Both producer and consumer are supported
The key API is defined in the syntax as follows:
twilio:key/methodName?[parameters]
The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a KeyDeleter to execute delete |
|
fetch |
Create a KeyFetcher to execute fetch |
|
read |
Create a KeyReader to execute read |
|
update |
Create a KeyUpdater to execute update |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.KeyReader reader();
-
com.twilio.rest.api.v2010.account.KeyReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: message
Both producer and consumer are supported
The message API is defined in the syntax as follows:
twilio:message/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a MessageCreator to execute create |
|
delete |
Create a MessageDeleter to execute delete |
|
fetch |
Create a MessageFetcher to execute fetch |
|
read |
Create a MessageReader to execute read |
|
update |
Create a MessageUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, String body);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List<java.net.URI> mediaUrl);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List<java.net.URI> mediaUrl);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, String body);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List<java.net.URI> mediaUrl);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body);
-
com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List<java.net.URI> mediaUrl);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
body |
The text of the message you want to send. Can be up to 1,600 characters in length. |
String |
from |
The phone number that initiated the message |
PhoneNumber |
mediaUrl |
The URL of the media to send with the message |
List |
messagingServiceSid |
The SID of the Messaging Service you want to associate with the message |
String |
pathAccountSid |
The SID of the Account that will create the resource |
String |
to |
The destination phone number |
PhoneNumber |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.MessageReader reader();
-
com.twilio.rest.api.v2010.account.MessageReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathAccountSid, String pathSid, String body);
-
com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathSid, String body);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
body |
The text of the message you want to send |
String |
pathAccountSid |
The SID of the Account that created the resources to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: message-feedback
Both producer and consumer are supported
The message-feedback API is defined in the syntax as follows:
twilio:message-feedback/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a FeedbackCreator to execute create |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathAccountSid, String pathMessageSid);
-
com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathMessageSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
pathMessageSid |
The SID of the Message resource for which the feedback was provided |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: message-media
Both producer and consumer are supported
The message-media API is defined in the syntax as follows:
twilio:message-media/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a MediaDeleter to execute delete |
|
fetch |
Create a MediaFetcher to execute fetch |
|
read |
Create a MediaReader to execute read |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathAccountSid, String pathMessageSid, String pathSid);
-
com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathMessageSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to delete |
String |
pathMessageSid |
The SID of the Message resource that this Media resource belongs to |
String |
pathSid |
The unique string that identifies this resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathAccountSid, String pathMessageSid, String pathSid);
-
com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathMessageSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
pathMessageSid |
The SID of the Message resource that this Media resource belongs to |
String |
pathSid |
The unique string that identifies this resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathAccountSid, String pathMessageSid);
-
com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathMessageSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to read |
String |
pathMessageSid |
The SID of the Message resource that this Media resource belongs to |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: new-key
Both producer and consumer are supported
The new-key API is defined in the syntax as follows:
twilio:new-key/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a NewKeyCreator to execute create |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.NewKeyCreator creator();
-
com.twilio.rest.api.v2010.account.NewKeyCreator creator(String pathAccountSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will be responsible for the new Key resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: new-signing-key
Both producer and consumer are supported
The new-signing-key API is defined in the syntax as follows:
twilio:new-signing-key/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a NewSigningKeyCreator to execute create |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator();
-
com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator(String pathAccountSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will be responsible for the new Key resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: notification
Both producer and consumer are supported
The notification API is defined in the syntax as follows:
twilio:notification/methodName?[parameters]
The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a NotificationFetcher to execute fetch |
|
read |
Create a NotificationReader to execute read |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.NotificationReader reader();
-
com.twilio.rest.api.v2010.account.NotificationReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: outgoing-caller-id
Both producer and consumer are supported
The outgoing-caller-id API is defined in the syntax as follows:
twilio:outgoing-caller-id/methodName?[parameters]
The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a OutgoingCallerIdDeleter to execute delete |
|
fetch |
Create a OutgoingCallerIdFetcher to execute fetch |
|
read |
Create a OutgoingCallerIdReader to execute read |
|
update |
Create a OutgoingCallerIdUpdater to execute update |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader();
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: queue
Both producer and consumer are supported
The queue API is defined in the syntax as follows:
twilio:queue/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a QueueCreator to execute create |
|
delete |
Create a QueueDeleter to execute delete |
|
fetch |
Create a QueueFetcher to execute fetch |
|
read |
Create a QueueReader to execute read |
|
update |
Create a QueueUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.QueueCreator creator(String friendlyName);
-
com.twilio.rest.api.v2010.account.QueueCreator creator(String pathAccountSid, String friendlyName);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
friendlyName |
A string to describe this resource |
String |
pathAccountSid |
The SID of the Account that will create the resource |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to delete |
String |
pathSid |
The unique string that identifies this resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
pathSid |
The unique string that identifies this resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.QueueReader reader();
-
com.twilio.rest.api.v2010.account.QueueReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to update |
String |
pathSid |
The unique string that identifies this resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: queue-member
Both producer and consumer are supported
The queue-member API is defined in the syntax as follows:
twilio:queue-member/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a MemberFetcher to execute fetch |
|
read |
Create a MemberReader to execute read |
|
update |
Create a MemberUpdater to execute update |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathAccountSid, String pathQueueSid, String pathCallSid);
-
com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathQueueSid, String pathCallSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
pathCallSid |
The Call SID of the resource(s) to fetch |
String |
pathQueueSid |
The SID of the Queue in which to find the members |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathAccountSid, String pathQueueSid);
-
com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathQueueSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to read |
String |
pathQueueSid |
The SID of the Queue in which to find the members |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathAccountSid, String pathQueueSid, String pathCallSid, java.net.URI url);
-
com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathQueueSid, String pathCallSid, java.net.URI url);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to update |
String |
pathCallSid |
The Call SID of the resource(s) to update |
String |
pathQueueSid |
The SID of the Queue in which to find the members |
String |
url |
The absolute URL of the Queue resource |
URI |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: recording
Both producer and consumer are supported
The recording API is defined in the syntax as follows:
twilio:recording/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a RecordingDeleter to execute delete |
|
fetch |
Create a RecordingFetcher to execute fetch |
|
read |
Create a RecordingReader to execute read |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.RecordingReader reader();
-
com.twilio.rest.api.v2010.account.RecordingReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: recording-add-on-result
Both producer and consumer are supported
The recording-add-on-result API is defined in the syntax as follows:
twilio:recording-add-on-result/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a AddOnResultDeleter to execute delete |
|
fetch |
Create a AddOnResultFetcher to execute fetch |
|
read |
Create a AddOnResultReader to execute read |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathSid);
-
com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathReferenceSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathReferenceSid |
The SID of the recording to which the result to delete belongs |
String |
pathSid |
The unique string that identifies the resource to delete |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathSid);
-
com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathReferenceSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathReferenceSid |
The SID of the recording to which the result to delete belongs |
String |
pathSid |
The unique string that identifies the resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathAccountSid, String pathReferenceSid);
-
com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathReferenceSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathReferenceSid |
The SID of the recording to which the result to delete belongs |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: recording-add-on-result-payload
Both producer and consumer are supported
The recording-add-on-result-payload API is defined in the syntax as follows:
twilio:recording-add-on-result-payload/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a PayloadDeleter to execute delete |
|
fetch |
Create a PayloadFetcher to execute fetch |
|
read |
Create a PayloadReader to execute read |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid);
-
com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathReferenceSid, String pathAddOnResultSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathAddOnResultSid |
The SID of the AddOnResult to which the payloads to delete belongs |
String |
pathReferenceSid |
The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid);
-
com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathReferenceSid, String pathAddOnResultSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathAddOnResultSid |
The SID of the AddOnResult to which the payloads to delete belongs |
String |
pathReferenceSid |
The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs |
String |
pathSid |
The unique string that identifies the resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid);
-
com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathReferenceSid, String pathAddOnResultSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathAddOnResultSid |
The SID of the AddOnResult to which the payloads to delete belongs |
String |
pathReferenceSid |
The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: recording-transcription
Both producer and consumer are supported
The recording-transcription API is defined in the syntax as follows:
twilio:recording-transcription/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a TranscriptionDeleter to execute delete |
|
fetch |
Create a TranscriptionFetcher to execute fetch |
|
read |
Create a TranscriptionReader to execute read |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathAccountSid, String pathRecordingSid, String pathSid);
-
com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathRecordingSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathRecordingSid |
The SID of the recording that created the transcription to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathAccountSid, String pathRecordingSid, String pathSid);
-
com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathRecordingSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathRecordingSid |
The SID of the recording that created the transcription to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathAccountSid, String pathRecordingSid);
-
com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathRecordingSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
pathRecordingSid |
The SID of the recording that created the transcription to delete |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: short-code
Both producer and consumer are supported
The short-code API is defined in the syntax as follows:
twilio:short-code/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
fetch |
Create a ShortCodeFetcher to execute fetch |
|
read |
Create a ShortCodeReader to execute read |
|
update |
Create a ShortCodeUpdater to execute update |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to fetch |
String |
pathSid |
The unique string that identifies this resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.ShortCodeReader reader();
-
com.twilio.rest.api.v2010.account.ShortCodeReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource(s) to update |
String |
pathSid |
The unique string that identifies this resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: signing-key
Both producer and consumer are supported
The signing-key API is defined in the syntax as follows:
twilio:signing-key/methodName?[parameters]
The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a SigningKeyDeleter to execute delete |
|
fetch |
Create a SigningKeyFetcher to execute fetch |
|
read |
Create a SigningKeyReader to execute read |
|
update |
Create a SigningKeyUpdater to execute update |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The account_sid |
String |
pathSid |
The sid |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The account_sid |
String |
pathSid |
The sid |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.SigningKeyReader reader();
-
com.twilio.rest.api.v2010.account.SigningKeyReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The account_sid |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The account_sid |
String |
pathSid |
The sid |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-credential-list
Both producer and consumer are supported
The sip-credential-list API is defined in the syntax as follows:
twilio:sip-credential-list/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a CredentialListCreator to execute create |
|
delete |
Create a CredentialListDeleter to execute delete |
|
fetch |
Create a CredentialListFetcher to execute fetch |
|
read |
Create a CredentialListReader to execute read |
|
update |
Create a CredentialListUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String friendlyName);
-
com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String pathAccountSid, String friendlyName);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
friendlyName |
Human readable descriptive text |
String |
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathSid |
Delete by unique credential list Sid |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathSid |
Fetch by unique credential list Sid |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.CredentialListReader reader();
-
com.twilio.rest.api.v2010.account.sip.CredentialListReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathAccountSid, String pathSid, String friendlyName);
-
com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathSid, String friendlyName);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
friendlyName |
Human readable descriptive text |
String |
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathSid |
Update by unique credential list Sid |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-credential-list-credential
Both producer and consumer are supported
The sip-credential-list-credential API is defined in the syntax as follows:
twilio:sip-credential-list-credential/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a CredentialCreator to execute create |
|
delete |
Create a CredentialDeleter to execute delete |
|
fetch |
Create a CredentialFetcher to execute fetch |
|
read |
Create a CredentialReader to execute read |
|
update |
Create a CredentialUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathAccountSid, String pathCredentialListSid, String username, String password);
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathCredentialListSid, String username, String password);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
password |
The password will not be returned in the response |
String |
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathCredentialListSid |
The unique id that identifies the credential list to include the created credential |
String |
username |
The username for this credential |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathAccountSid, String pathCredentialListSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathCredentialListSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathCredentialListSid |
The unique id that identifies the credential list to include the created credential |
String |
pathSid |
The unique id that identifies the resource to delete |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathAccountSid, String pathCredentialListSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathCredentialListSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathCredentialListSid |
The unique id that identifies the credential list to include the created credential |
String |
pathSid |
The unique id that identifies the resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathAccountSid, String pathCredentialListSid);
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathCredentialListSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathCredentialListSid |
The unique id that identifies the credential list to include the created credential |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathAccountSid, String pathCredentialListSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathCredentialListSid, String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathCredentialListSid |
The unique id that identifies the credential list to include the created credential |
String |
pathSid |
The unique id that identifies the resource to update |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-domain
Both producer and consumer are supported
The sip-domain API is defined in the syntax as follows:
twilio:sip-domain/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a DomainCreator to execute create |
|
delete |
Create a DomainDeleter to execute delete |
|
fetch |
Create a DomainFetcher to execute fetch |
|
read |
Create a DomainReader to execute read |
|
update |
Create a DomainUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String domainName);
-
com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String pathAccountSid, String domainName);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
domainName |
The unique address on Twilio to route SIP traffic |
String |
pathAccountSid |
The SID of the Account that will create the resource |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.DomainReader reader();
-
com.twilio.rest.api.v2010.account.sip.DomainReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-domain-credential-list-mapping
Both producer and consumer are supported
The sip-domain-credential-list-mapping API is defined in the syntax as follows:
twilio:sip-domain-credential-list-mapping/methodName?[parameters]
The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a CredentialListMappingCreator to execute create |
|
delete |
Create a CredentialListMappingDeleter to execute delete |
|
fetch |
Create a CredentialListMappingFetcher to execute fetch |
|
read |
Create a CredentialListMappingReader to execute read |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathAccountSid, String pathDomainSid, String credentialListSid);
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathDomainSid, String credentialListSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
credentialListSid |
A string that identifies the CredentialList resource to map to the SIP domain |
String |
pathAccountSid |
The unique sid that identifies this account |
String |
pathDomainSid |
A string that identifies the SIP Domain for which the CredentialList resource will be mapped |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathDomainSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathDomainSid |
A string that identifies the SIP Domain for which the CredentialList resource will be mapped |
String |
pathSid |
A string that identifies the resource to delete |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathDomainSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathDomainSid |
A string that identifies the SIP Domain for which the CredentialList resource will be mapped |
String |
pathSid |
A string that identifies the resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathAccountSid, String pathDomainSid);
-
com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathDomainSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathDomainSid |
A string that identifies the SIP Domain for which the CredentialList resource will be mapped |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-domain-ip-access-control-list-mapping
Both producer and consumer are supported
The sip-domain-ip-access-control-list-mapping API is defined in the syntax as follows:
twilio:sip-domain-ip-access-control-list-mapping/methodName?[parameters]
The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a IpAccessControlListMappingCreator to execute create |
|
delete |
Create a IpAccessControlListMappingDeleter to execute delete |
|
fetch |
Create a IpAccessControlListMappingFetcher to execute fetch |
|
read |
Create a IpAccessControlListMappingReader to execute read |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathAccountSid, String pathDomainSid, String ipAccessControlListSid);
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathDomainSid, String ipAccessControlListSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
ipAccessControlListSid |
The unique id of the IP access control list to map to the SIP domain |
String |
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathDomainSid |
A string that uniquely identifies the SIP Domain |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathDomainSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathDomainSid |
A string that uniquely identifies the SIP Domain |
String |
pathSid |
A 34 character string that uniquely identifies the resource to delete. |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathDomainSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathDomainSid |
A string that uniquely identifies the SIP Domain |
String |
pathSid |
A 34 character string that uniquely identifies the resource to fetch. |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathAccountSid, String pathDomainSid);
-
com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathDomainSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique id of the Account that is responsible for this resource |
String |
pathDomainSid |
A string that uniquely identifies the SIP Domain |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-ip-access-control-list
Both producer and consumer are supported
The sip-ip-access-control-list API is defined in the syntax as follows:
twilio:sip-ip-access-control-list/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a IpAccessControlListCreator to execute create |
|
delete |
Create a IpAccessControlListDeleter to execute delete |
|
fetch |
Create a IpAccessControlListFetcher to execute fetch |
|
read |
Create a IpAccessControlListReader to execute read |
|
update |
Create a IpAccessControlListUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String friendlyName);
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String pathAccountSid, String friendlyName);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
friendlyName |
A human readable description of this resource |
String |
pathAccountSid |
The unique sid that identifies this account |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathSid |
A string that identifies the resource to delete |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathSid |
A string that identifies the resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader();
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathAccountSid, String pathSid, String friendlyName);
-
com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathSid, String friendlyName);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
friendlyName |
A human readable description of this resource |
String |
pathAccountSid |
The unique sid that identifies this account |
String |
pathSid |
A string that identifies the resource to update |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: sip-ip-access-control-list-ip-address
Both producer and consumer are supported
The sip-ip-access-control-list-ip-address API is defined in the syntax as follows:
twilio:sip-ip-access-control-list-ip-address/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a IpAddressCreator to execute create |
|
delete |
Create a IpAddressDeleter to execute delete |
|
fetch |
Create a IpAddressFetcher to execute fetch |
|
read |
Create a IpAddressReader to execute read |
|
update |
Create a IpAddressUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathAccountSid, String pathIpAccessControlListSid, String friendlyName, String ipAddress);
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathIpAccessControlListSid, String friendlyName, String ipAddress);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
friendlyName |
A human readable descriptive text for this resource, up to 64 characters long. |
String |
ipAddress |
An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. |
String |
pathAccountSid |
The unique sid that identifies this account |
String |
pathIpAccessControlListSid |
The IpAccessControlList Sid with which to associate the created IpAddress resource |
String |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathAccountSid, String pathIpAccessControlListSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathIpAccessControlListSid, String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathIpAccessControlListSid |
The IpAccessControlList Sid with which to associate the created IpAddress resource |
String |
pathSid |
A string that identifies the resource to delete |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathAccountSid, String pathIpAccessControlListSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathIpAccessControlListSid, String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathIpAccessControlListSid |
The IpAccessControlList Sid with which to associate the created IpAddress resource |
String |
pathSid |
A string that identifies the IpAddress resource to fetch |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathAccountSid, String pathIpAccessControlListSid);
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathIpAccessControlListSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathIpAccessControlListSid |
The IpAccessControlList Sid with which to associate the created IpAddress resource |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathAccountSid, String pathIpAccessControlListSid, String pathSid);
-
com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathIpAccessControlListSid, String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The unique sid that identifies this account |
String |
pathIpAccessControlListSid |
The IpAccessControlList Sid with which to associate the created IpAddress resource |
String |
pathSid |
A string that identifies the IpAddress resource to update |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: token
Both producer and consumer are supported
The token API is defined in the syntax as follows:
twilio:token/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a TokenCreator to execute create |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.TokenCreator creator();
-
com.twilio.rest.api.v2010.account.TokenCreator creator(String pathAccountSid);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that will create the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: transcription
Both producer and consumer are supported
The transcription API is defined in the syntax as follows:
twilio:transcription/methodName?[parameters]
The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
delete |
Create a TranscriptionDeleter to execute delete |
|
fetch |
Create a TranscriptionFetcher to execute fetch |
|
read |
Create a TranscriptionReader to execute read |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.TranscriptionReader reader();
-
com.twilio.rest.api.v2010.account.TranscriptionReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record
Both producer and consumer are supported
The usage-record API is defined in the syntax as follows:
twilio:usage-record/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a RecordReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.RecordReader reader();
-
com.twilio.rest.api.v2010.account.usage.RecordReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-all-time
Both producer and consumer are supported
The usage-record-all-time API is defined in the syntax as follows:
twilio:usage-record-all-time/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a AllTimeReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-daily
Both producer and consumer are supported
The usage-record-daily API is defined in the syntax as follows:
twilio:usage-record-daily/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a DailyReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.DailyReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.DailyReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-last-month
Both producer and consumer are supported
The usage-record-last-month API is defined in the syntax as follows:
twilio:usage-record-last-month/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a LastMonthReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-monthly
Both producer and consumer are supported
The usage-record-monthly API is defined in the syntax as follows:
twilio:usage-record-monthly/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a MonthlyReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-this-month
Both producer and consumer are supported
The usage-record-this-month API is defined in the syntax as follows:
twilio:usage-record-this-month/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a ThisMonthReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-today
Both producer and consumer are supported
The usage-record-today API is defined in the syntax as follows:
twilio:usage-record-today/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a TodayReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.TodayReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.TodayReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-yearly
Both producer and consumer are supported
The usage-record-yearly API is defined in the syntax as follows:
twilio:usage-record-yearly/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a YearlyReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-record-yesterday
Both producer and consumer are supported
The usage-record-yesterday API is defined in the syntax as follows:
twilio:usage-record-yesterday/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
read |
Create a YesterdayReader to execute read |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader();
-
com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: usage-trigger
Both producer and consumer are supported
The usage-trigger API is defined in the syntax as follows:
twilio:usage-trigger/methodName?[parameters]
The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a TriggerCreator to execute create |
|
delete |
Create a TriggerDeleter to execute delete |
|
fetch |
Create a TriggerFetcher to execute fetch |
|
read |
Create a TriggerReader to execute read |
|
update |
Create a TriggerUpdater to execute update |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(String pathAccountSid, java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger.UsageCategory usageCategory);
-
com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger.UsageCategory usageCategory);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
callbackUrl |
The URL we call when the trigger fires |
URI |
pathAccountSid |
The SID of the Account that will create the resource |
String |
triggerValue |
The usage value at which the trigger should fire |
String |
usageCategory |
The usage category the trigger watches |
UsageCategory |
Method deleter
Signatures:
-
com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathSid);
The twilio/deleter API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to delete |
String |
pathSid |
The unique string that identifies the resource |
String |
Method fetcher
Signatures:
-
com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathSid);
The twilio/fetcher API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resource to fetch |
String |
pathSid |
The unique string that identifies the resource |
String |
Method reader
Signatures:
-
com.twilio.rest.api.v2010.account.usage.TriggerReader reader();
-
com.twilio.rest.api.v2010.account.usage.TriggerReader reader(String pathAccountSid);
The twilio/reader API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to read |
String |
Method updater
Signatures:
-
com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathAccountSid, String pathSid);
-
com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathSid);
The twilio/updater API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account that created the resources to update |
String |
pathSid |
The unique string that identifies the resource |
String |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
API: validation-request
Both producer and consumer are supported
The validation-request API is defined in the syntax as follows:
twilio:validation-request/methodName?[parameters]
The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method | Alias | Description |
---|---|---|
create |
Create a ValidationRequestCreator to execute create |
Method creator
Signatures:
-
com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
-
com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(com.twilio.type.PhoneNumber phoneNumber);
The twilio/creator API method has the parameters listed in the table below:
Parameter | Description | Type |
---|---|---|
pathAccountSid |
The SID of the Account responsible for the new Caller ID |
String |
phoneNumber |
The phone number to verify in E.164 format |
PhoneNumber |
In addition to the parameters above, the twilio API can also use any of the Query Parameters (21 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format CamelTwilio.parameter
.
The inBody
parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere
would override a CamelTwilio.myParameterNameHere
header.
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:
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
Spring Boot Auto-Configuration
When using twilio with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-twilio-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 9 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
The account SID to use. |
String |
||
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
|
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
|
To use the shared configuration. The option is a org.apache.camel.component.twilio.TwilioConfiguration type. |
TwilioConfiguration |
||
Whether to enable auto configuration of the twilio component. This is enabled by default. |
Boolean |
||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
Boolean |
|
Auth token for the account. |
String |
||
To use the shared REST client. The option is a com.twilio.http.TwilioRestClient type. |
TwilioRestClient |
||
The account to use. |
String |