com.twilio.sdk.creator.api.v2010.account

Class CallCreator

java.lang.Object

com.twilio.sdk.creator.Creator<Call>

com.twilio.sdk.creator.api.v2010.account.CallCreator

public class CallCreator
extends Creator<Call>

Constructor Summary

Constructors

Constructor and Description
CallCreator(String accountSid, PhoneNumber to, PhoneNumber from, String applicationSid) Construct a new CallCreator.
CallCreator(String accountSid, PhoneNumber to, PhoneNumber from, URI url) Construct a new CallCreator.

Method Summary

Modifier and Type	Method and Description
Call	execute(TwilioRestClient client) Make the request to the Twilio API to perform the create.
CallCreator	setFallbackMethod(HttpMethod fallbackMethod) The HTTP method that Twilio should use to request the `FallbackUrl`.
CallCreator	setFallbackUrl(String fallbackUrl) A URL that Twilio will request if an error occurs requesting or executing the TwiML at `Url`.
CallCreator	setFallbackUrl(URI fallbackUrl) A URL that Twilio will request if an error occurs requesting or executing the TwiML at `Url`.
CallCreator	setIfMachine(String ifMachine) Tell Twilio to try and determine if a machine (like voicemail) or a human has answered the call.
CallCreator	setMethod(HttpMethod method) The HTTP method Twilio should use when requesting the URL.
CallCreator	setRecord(Boolean record) Set this parameter to true to record the entirety of a phone call.
CallCreator	setSendDigits(String sendDigits) A string of keys to dial after connecting to the number.
CallCreator	setStatusCallback(String statusCallback) A URL that Twilio will request when the call ends to notify your app.
CallCreator	setStatusCallback(URI statusCallback) A URL that Twilio will request when the call ends to notify your app.
CallCreator	setStatusCallbackMethod(HttpMethod statusCallbackMethod) The HTTP method that Twilio should use to request the `StatusCallback`.
CallCreator	setTimeout(Integer timeout) The integer number of seconds that Twilio should allow the phone to ring before assuming there is no answer.

Methods inherited from class com.twilio.sdk.creator.Creator

async, async, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

CallCreator

public CallCreator(String accountSid,
                   PhoneNumber to,
                   PhoneNumber from,
                   URI url)

Construct a new CallCreator.

Parameters:

accountSid - The account_sid

to - Phone number, SIP address or client identifier to call

from - Twilio number from which to originate the call

url - Url from which to fetch TwiML

CallCreator

public CallCreator(String accountSid,
                   PhoneNumber to,
                   PhoneNumber from,
                   String applicationSid)

Construct a new CallCreator.

Parameters:

accountSid - The account_sid

to - Phone number, SIP address or client identifier to call

from - Twilio number from which to originate the call

applicationSid - ApplicationSid that configures from where to fetch TwiML

Method Detail

setMethod

public CallCreator setMethod(HttpMethod method)

The HTTP method Twilio should use when requesting the URL. Defaults to `POST`. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

method - HTTP method to use to fetch TwiML

Returns:

this

setFallbackUrl

public CallCreator setFallbackUrl(URI fallbackUrl)

A URL that Twilio will request if an error occurs requesting or executing the TwiML at `Url`. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

fallbackUrl - Fallback URL in case of error

Returns:

this

setFallbackUrl

public CallCreator setFallbackUrl(String fallbackUrl)

A URL that Twilio will request if an error occurs requesting or executing the TwiML at `Url`. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

fallbackUrl - Fallback URL in case of error

Returns:

this

setFallbackMethod

public CallCreator setFallbackMethod(HttpMethod fallbackMethod)

The HTTP method that Twilio should use to request the `FallbackUrl`. Must be either `GET` or `POST`. Defaults to `POST`. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

fallbackMethod - HTTP Method to use with FallbackUrl

Returns:

this

setStatusCallback

public CallCreator setStatusCallback(URI statusCallback)

A URL that Twilio will request when the call ends to notify your app. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

statusCallback - Status Callback URL

Returns:

this

setStatusCallback

public CallCreator setStatusCallback(String statusCallback)

A URL that Twilio will request when the call ends to notify your app. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

statusCallback - Status Callback URL

Returns:

this

setStatusCallbackMethod

public CallCreator setStatusCallbackMethod(HttpMethod statusCallbackMethod)

The HTTP method that Twilio should use to request the `StatusCallback`. Defaults to `POST`. If an `ApplicationSid` was provided, this parameter is ignored..

Parameters:

statusCallbackMethod - HTTP Method to use with StatusCallback

Returns:

this

setSendDigits

public CallCreator setSendDigits(String sendDigits)

A string of keys to dial after connecting to the number. Valid digits in the string include: any digit (`0`-`9`), '`#`', '`*`' and '`w`' (to insert a half second pause). For example, if you connected to a company phone number, and wanted to pause for one second, dial extension 1234 and then the pound key, use `ww1234#`..

Parameters:

sendDigits - Digits to send

Returns:

this

setIfMachine

public CallCreator setIfMachine(String ifMachine)

Tell Twilio to try and determine if a machine (like voicemail) or a human has answered the call. Possible value are `Continue` and `Hangup`..

Parameters:

ifMachine - Action to take if a machine has answered the call

Returns:

this

setTimeout

public CallCreator setTimeout(Integer timeout)

The integer number of seconds that Twilio should allow the phone to ring before assuming there is no answer. Default is `60` seconds, the maximum is `999` seconds. Note, you could set this to a low value, such as `15`, to hangup before reaching an answering machine or voicemail..

Parameters:

timeout - Number of seconds to wait for an answer

Returns:

this

setRecord

public CallCreator setRecord(Boolean record)

Set this parameter to true to record the entirety of a phone call. The RecordingUrl will be sent to the StatusCallback URL. Defaults to false..

Parameters:

record - Whether or not to record the Call

Returns:

this

execute

public Call execute(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

execute in class Creator<Call>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Call