com.twilio.rest.creator.api.v2010.account

Class IncomingPhoneNumberCreator

java.lang.Object

com.twilio.rest.creator.Creator<IncomingPhoneNumber>

com.twilio.rest.creator.api.v2010.account.IncomingPhoneNumberCreator

public class IncomingPhoneNumberCreator
extends Creator<IncomingPhoneNumber>

Constructor Summary

Constructors

Constructor and Description
IncomingPhoneNumberCreator(PhoneNumber phoneNumber) Construct a new IncomingPhoneNumberCreator.
IncomingPhoneNumberCreator(String areaCode) Construct a new IncomingPhoneNumberCreator.
IncomingPhoneNumberCreator(String ownerAccountSid, PhoneNumber phoneNumber) Construct a new IncomingPhoneNumberCreator.
IncomingPhoneNumberCreator(String ownerAccountSid, String areaCode) Construct a new IncomingPhoneNumberCreator.

Method Summary

Modifier and Type	Method and Description
IncomingPhoneNumber	execute(TwilioRestClient client) Make the request to the Twilio API to perform the create.
IncomingPhoneNumberCreator	setApiVersion(String apiVersion) Calls to this phone number will start a new TwiML session with this API version..
IncomingPhoneNumberCreator	setFriendlyName(String friendlyName) A human readable descriptive text for this resource, up to 64 characters long.
IncomingPhoneNumberCreator	setSmsApplicationSid(String smsApplicationSid) The 34 character sid of the application Twilio should use to handle SMSs sent to this number.
IncomingPhoneNumberCreator	setSmsFallbackMethod(HttpMethod smsFallbackMethod) The HTTP method Twilio will use when requesting the above URL.
IncomingPhoneNumberCreator	setSmsFallbackUrl(String smsFallbackUrl) The URL that Twilio will request if an error occurs retrieving or executing the TwiML from `SmsUrl`..
IncomingPhoneNumberCreator	setSmsFallbackUrl(URI smsFallbackUrl) The URL that Twilio will request if an error occurs retrieving or executing the TwiML from `SmsUrl`..
IncomingPhoneNumberCreator	setSmsMethod(HttpMethod smsMethod) The HTTP method Twilio will use when making requests to the `SmsUrl`.
IncomingPhoneNumberCreator	setSmsUrl(String smsUrl) The URL Twilio will request when receiving an incoming SMS message to this number..
IncomingPhoneNumberCreator	setSmsUrl(URI smsUrl) The URL Twilio will request when receiving an incoming SMS message to this number..
IncomingPhoneNumberCreator	setStatusCallback(String statusCallback) The URL that Twilio will request to pass status parameters (such as call ended) to your application..
IncomingPhoneNumberCreator	setStatusCallback(URI statusCallback) The URL that Twilio will request to pass status parameters (such as call ended) to your application..
IncomingPhoneNumberCreator	setStatusCallbackMethod(HttpMethod statusCallbackMethod) The HTTP method Twilio will use to make requests to the `StatusCallback` URL.
IncomingPhoneNumberCreator	setVoiceApplicationSid(String voiceApplicationSid) The 34 character sid of the application Twilio should use to handle phone calls to this number.
IncomingPhoneNumberCreator	setVoiceCallerIdLookup(Boolean voiceCallerIdLookup) Look up the caller's caller-ID name from the CNAM database ($0.01 per look up).
IncomingPhoneNumberCreator	setVoiceFallbackMethod(HttpMethod voiceFallbackMethod) The HTTP method Twilio will use when requesting the `VoiceFallbackUrl`.
IncomingPhoneNumberCreator	setVoiceFallbackUrl(String voiceFallbackUrl) The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by `Url`..
IncomingPhoneNumberCreator	setVoiceFallbackUrl(URI voiceFallbackUrl) The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by `Url`..
IncomingPhoneNumberCreator	setVoiceMethod(HttpMethod voiceMethod) The HTTP method Twilio will use when requesting the above `Url`.
IncomingPhoneNumberCreator	setVoiceUrl(String voiceUrl) The URL Twilio will request when this phone number receives a call.
IncomingPhoneNumberCreator	setVoiceUrl(URI voiceUrl) The URL Twilio will request when this phone number receives a call.

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

async, async, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

IncomingPhoneNumberCreator

public IncomingPhoneNumberCreator(PhoneNumber phoneNumber)

Construct a new IncomingPhoneNumberCreator.

Parameters:

phoneNumber - The phone number

IncomingPhoneNumberCreator

public IncomingPhoneNumberCreator(String ownerAccountSid,
                                  PhoneNumber phoneNumber)

Construct a new IncomingPhoneNumberCreator.

Parameters:

ownerAccountSid - The owner_account_sid

phoneNumber - The phone number

IncomingPhoneNumberCreator

public IncomingPhoneNumberCreator(String areaCode)

Construct a new IncomingPhoneNumberCreator.

Parameters:

areaCode - The desired area code for the new number

IncomingPhoneNumberCreator

public IncomingPhoneNumberCreator(String ownerAccountSid,
                                  String areaCode)

Construct a new IncomingPhoneNumberCreator.

Parameters:

ownerAccountSid - The owner_account_sid

areaCode - The desired area code for the new number

Method Detail

setApiVersion

public IncomingPhoneNumberCreator setApiVersion(String apiVersion)

Calls to this phone number will start a new TwiML session with this API version..

Parameters:

apiVersion - The Twilio Rest API version to use

Returns:

this

setFriendlyName

public IncomingPhoneNumberCreator setFriendlyName(String friendlyName)

A human readable descriptive text for this resource, up to 64 characters long. By default, the `FriendlyName` is a nicely formatted version of the phone number..

Parameters:

friendlyName - A human readable description of this resource

Returns:

this

setSmsApplicationSid

public IncomingPhoneNumberCreator setSmsApplicationSid(String smsApplicationSid)

The 34 character sid of the application Twilio should use to handle SMSs sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application..

Parameters:

smsApplicationSid - Unique string that identifies the application

Returns:

this

setSmsFallbackMethod

public IncomingPhoneNumberCreator setSmsFallbackMethod(HttpMethod smsFallbackMethod)

The HTTP method Twilio will use when requesting the above URL. Either `GET` or `POST`..

Parameters:

smsFallbackMethod - HTTP method used with sms fallback url

Returns:

this

setSmsFallbackUrl

public IncomingPhoneNumberCreator setSmsFallbackUrl(URI smsFallbackUrl)

The URL that Twilio will request if an error occurs retrieving or executing the TwiML from `SmsUrl`..

Parameters:

smsFallbackUrl - URL Twilio will request if an error occurs in executing TwiML

Returns:

this

setSmsFallbackUrl

public IncomingPhoneNumberCreator setSmsFallbackUrl(String smsFallbackUrl)

The URL that Twilio will request if an error occurs retrieving or executing the TwiML from `SmsUrl`..

Parameters:

smsFallbackUrl - URL Twilio will request if an error occurs in executing TwiML

Returns:

this

setSmsMethod

public IncomingPhoneNumberCreator setSmsMethod(HttpMethod smsMethod)

The HTTP method Twilio will use when making requests to the `SmsUrl`. Either `GET` or `POST`..

Parameters:

smsMethod - HTTP method to use with sms url

Returns:

this

setSmsUrl

public IncomingPhoneNumberCreator setSmsUrl(URI smsUrl)

The URL Twilio will request when receiving an incoming SMS message to this number..

Parameters:

smsUrl - URL Twilio will request when receiving an SMS

Returns:

this

setSmsUrl

public IncomingPhoneNumberCreator setSmsUrl(String smsUrl)

The URL Twilio will request when receiving an incoming SMS message to this number..

Parameters:

smsUrl - URL Twilio will request when receiving an SMS

Returns:

this

setStatusCallback

public IncomingPhoneNumberCreator setStatusCallback(URI statusCallback)

The URL that Twilio will request to pass status parameters (such as call ended) to your application..

Parameters:

statusCallback - URL Twilio will use to pass status parameters

Returns:

this

setStatusCallback

public IncomingPhoneNumberCreator setStatusCallback(String statusCallback)

The URL that Twilio will request to pass status parameters (such as call ended) to your application..

Parameters:

statusCallback - URL Twilio will use to pass status parameters

Returns:

this

setStatusCallbackMethod

public IncomingPhoneNumberCreator setStatusCallbackMethod(HttpMethod statusCallbackMethod)

The HTTP method Twilio will use to make requests to the `StatusCallback` URL. Either `GET` or `POST`..

Parameters:

statusCallbackMethod - HTTP method twilio will use with status callback

Returns:

this

setVoiceApplicationSid

public IncomingPhoneNumberCreator setVoiceApplicationSid(String voiceApplicationSid)

The 34 character sid of the application Twilio should use to handle phone calls to this number. If a `VoiceApplicationSid` is present, Twilio will ignore all of the voice urls above and use those set on the application. Setting a `VoiceApplicationSid` will automatically delete your `TrunkSid` and vice versa..

Parameters:

voiceApplicationSid - The unique sid of the application to handle this number

Returns:

this

setVoiceCallerIdLookup

public IncomingPhoneNumberCreator setVoiceCallerIdLookup(Boolean voiceCallerIdLookup)

Look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Either `true` or `false`..

Parameters:

voiceCallerIdLookup - Look up the caller's caller-ID

Returns:

this

setVoiceFallbackMethod

public IncomingPhoneNumberCreator setVoiceFallbackMethod(HttpMethod voiceFallbackMethod)

The HTTP method Twilio will use when requesting the `VoiceFallbackUrl`. Either `GET` or `POST`..

Parameters:

voiceFallbackMethod - HTTP method used with fallback_url

Returns:

this

setVoiceFallbackUrl

public IncomingPhoneNumberCreator setVoiceFallbackUrl(URI voiceFallbackUrl)

The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by `Url`..

Parameters:

voiceFallbackUrl - URL Twilio will request when an error occurs in TwiML

Returns:

this

setVoiceFallbackUrl

public IncomingPhoneNumberCreator setVoiceFallbackUrl(String voiceFallbackUrl)

The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by `Url`..

Parameters:

voiceFallbackUrl - URL Twilio will request when an error occurs in TwiML

Returns:

this

setVoiceMethod

public IncomingPhoneNumberCreator setVoiceMethod(HttpMethod voiceMethod)

The HTTP method Twilio will use when requesting the above `Url`. Either `GET` or `POST`..

Parameters:

voiceMethod - HTTP method used with the voice url

Returns:

this

setVoiceUrl

public IncomingPhoneNumberCreator setVoiceUrl(URI voiceUrl)

The URL Twilio will request when this phone number receives a call. The VoiceURL will no longer be used if a `VoiceApplicationSid` or a `TrunkSid` is set..

Parameters:

voiceUrl - URL Twilio will request when receiving a call

Returns:

this

setVoiceUrl

public IncomingPhoneNumberCreator setVoiceUrl(String voiceUrl)

The URL Twilio will request when this phone number receives a call. The VoiceURL will no longer be used if a `VoiceApplicationSid` or a `TrunkSid` is set..

Parameters:

voiceUrl - URL Twilio will request when receiving a call

Returns:

this

execute

public IncomingPhoneNumber execute(TwilioRestClient client)

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

Specified by:

execute in class Creator<IncomingPhoneNumber>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created IncomingPhoneNumber