PhoneNumber (Twilio Java)

java.lang.Object
- com.twilio.sdk.resource.Resource<C>
- - com.twilio.sdk.resource.InstanceResource<C>
  - - com.twilio.sdk.resource.NextGenInstanceResource<TwilioTrunkingClient>
    - - com.twilio.sdk.resource.instance.trunking.PhoneNumber

public class PhoneNumber
extends NextGenInstanceResource<TwilioTrunkingClient>

Represents a phone number associated to a trunk

See Also:: Phone Numbers

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`PhoneNumber.Capabilities` This is a set of boolean properties that indicate whether a phone number can receive calls or messages.

Constructor Summary

Constructors
Constructor and Description
`PhoneNumber(TwilioTrunkingClient client, Map<String,Object> properties)` Initialize phone number with data
`PhoneNumber(TwilioTrunkingClient client, String trunkSid, String phoneNumberSid)` Initialize phone number

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`delete()` Remove the associated phone number
`String`	`getAccountSid()` The unique ID of the Account that owns this Phone Number
`String`	`getAddressRequirements()` Indicates whether this number requires an Address to be on file with Twilio.
`String`	`getApiVersion()` Gets the api version.
`PhoneNumber.Capabilities`	`getCapabilities()` Return capabilities associated to this phone number
`Calendar`	`getDateCreated()` The date this Origination Url was created.
`Calendar`	`getDateUpdated()` The date this Origination Url was updated.
`String`	`getFriendlyName()` A human readable descriptive text, up to 64 characters long.
`String`	`getPhoneNumber()` The incoming phone number.
`String`	`getSid()` A 34 character string that uniquely identifies the Phone Number in this Twilio Trunk.
`String`	`getSipUrl()` The SIP address you want Twilio to route your Origination calls to.
`String`	`getSmsFallbackMethod()` Gets the sms fallback method.
`String`	`getSmsFallbackUrl()` Gets the sms fallback url.
`String`	`getSmsMethod()` Gets the sms method.
`String`	`getSmsStatusCallback()` Gets the sms status callback.
`String`	`getSmsUrl()` Gets the sms url.
`String`	`getStatusCallback()` The URL that Twilio will request to pass status parameters (such as call ended) to your application.
`String`	`getStatusCallbackMethod()` The HTTP method Twilio will use to make requests to the StatusCallback URL.
`String`	`getTrunkSid()` The unique ID of the Trunk that is associated to this phone number.
`String`	`getUrl()` The absolute URL for this resource
`String`	`getVoiceApplicationSid()` The 34 character sid of the application Twilio should use to handle phone calls to this number.
`String`	`getVoiceFallbackMethod()` The HTTP method Twilio will use when requesting the VoiceFallbackUrl.
`String`	`getVoiceFallbackUrl()` The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.
`String`	`getVoiceMethod()` The HTTP method Twilio will use when requesting the above Url.
`String`	`getVoiceUrl()` The URL Twilio will request when this phone number receives a call.
`Boolean`	`isBeta()` Whether this number is new to the Twilio platform.
`Boolean`	`isVoiceCallerIdLookup()` Look up the caller's caller-ID name from the CNAM database ($0.01 per look up).

Methods inherited from class com.twilio.sdk.resource.InstanceResource
getCastedObject, getObject, getProperty, toJSON, update, update

Methods inherited from class com.twilio.sdk.resource.Resource
setRequestAccountSid

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PhoneNumber
```
public PhoneNumber(TwilioTrunkingClient client,
                   String trunkSid,
                   String phoneNumberSid)
```
    Initialize phone number
    
    Parameters:
    
    client - A TwilioTrunkingClient
    
    trunkSid - The trunk sid
    
    phoneNumberSid - The phone number sid
  - PhoneNumber
```
public PhoneNumber(TwilioTrunkingClient client,
                   Map<String,Object> properties)
```
    Initialize phone number with data
    
    Parameters:
    
    client - A TwilioTrunkingClient
    
    properties - The data for this phone number instance
- Method Detail
  - getApiVersion
```
public String getApiVersion()
```
    Gets the api version.
    
    Returns:
    
    the api version
  - getSid
```
public String getSid()
```
    A 34 character string that uniquely identifies the Phone Number in this Twilio Trunk.
    
    Returns:
    
    The phone number sid
  - getAccountSid
```
public String getAccountSid()
```
    The unique ID of the Account that owns this Phone Number
    
    Returns:
    
    The account sid
  - getTrunkSid
```
public String getTrunkSid()
```
    The unique ID of the Trunk that is associated to this phone number.
    
    Returns:
    
    The trunk sid
  - getFriendlyName
```
public String getFriendlyName()
```
    A human readable descriptive text, up to 64 characters long.
    
    Returns:
    
    The friendly name
  - getSipUrl
```
public String getSipUrl()
```
    The SIP address you want Twilio to route your Origination calls to. This must be a sip: schema.
    
    Returns:
    
    The sip url
  - getDateCreated
```
public Calendar getDateCreated()
```
    The date this Origination Url was created.
    
    Returns:
    
    The created date
  - getDateUpdated
```
public Calendar getDateUpdated()
```
    The date this Origination Url was updated.
    
    Returns:
    
    The updated date
  - getUrl
```
public String getUrl()
```
    The absolute URL for this resource
    
    Returns:
    
    The absolute URL
  - getPhoneNumber
```
public String getPhoneNumber()
```
    The incoming phone number. e.g., +16175551212 (E.164 format)
    
    Returns:
    
    the phone number
  - isVoiceCallerIdLookup
```
public Boolean isVoiceCallerIdLookup()
```
    Look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Either true or false.
    
    Returns:
    
    The voice caller id lookup
  - getVoiceUrl
```
public String getVoiceUrl()
```
    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.
    
    Returns:
    
    The voice url
  - getVoiceMethod
```
public String getVoiceMethod()
```
    The HTTP method Twilio will use when requesting the above Url. Either GET or POST.
    
    Returns:
    
    The voice method
  - getVoiceFallbackUrl
```
public String getVoiceFallbackUrl()
```
    The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.
    
    Returns:
    
    The voice fallback url
  - getVoiceFallbackMethod
```
public String getVoiceFallbackMethod()
```
    The HTTP method Twilio will use when requesting the VoiceFallbackUrl. Either GET or POST.
    
    Returns:
    
    The voice fallback method
  - getStatusCallback
```
public String getStatusCallback()
```
    The URL that Twilio will request to pass status parameters (such as call ended) to your application.
    
    Returns:
    
    The status callback url
  - getStatusCallbackMethod
```
public String getStatusCallbackMethod()
```
    The HTTP method Twilio will use to make requests to the StatusCallback URL. Either GET or POST.
    
    Returns:
    
    The status callback method
  - getVoiceApplicationSid
```
public String getVoiceApplicationSid()
```
    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.
    
    Returns:
    
    the voice application sid
  - getSmsUrl
```
public String getSmsUrl()
```
    Gets the sms url.
    
    Returns:
    
    the sms url
  - getSmsMethod
```
public String getSmsMethod()
```
    Gets the sms method.
    
    Returns:
    
    the sms method
  - getSmsFallbackUrl
```
public String getSmsFallbackUrl()
```
    Gets the sms fallback url.
    
    Returns:
    
    the sms fallback url
  - getSmsFallbackMethod
```
public String getSmsFallbackMethod()
```
    Gets the sms fallback method.
    
    Returns:
    
    the sms fallback method
  - getSmsStatusCallback
```
public String getSmsStatusCallback()
```
    Gets the sms status callback.
    
    Returns:
    
    the sms status callback
  - getAddressRequirements
```
public String getAddressRequirements()
```
    Indicates whether this number requires an Address to be on file with Twilio. Potential values are "any", "local", "foreign", or "none".
    
    Returns:
    
    the address requirements
  - isBeta
```
public Boolean isBeta()
```
    Whether this number is new to the Twilio platform.
    
    Returns:
    
    Beta status
  - getCapabilities
```
public PhoneNumber.Capabilities getCapabilities()
```
    Return capabilities associated to this phone number
    
    Returns:
    
    The capability for this number
  - delete
```
public boolean delete()
               throws TwilioRestException
```
    Remove the associated phone number
    
    Returns:
    
    True iff the delete was successful
    
    Throws:
    
    TwilioRestException

Class PhoneNumber

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.twilio.sdk.resource.InstanceResource

Methods inherited from class com.twilio.sdk.resource.Resource

Methods inherited from class java.lang.Object

Constructor Detail

PhoneNumber

PhoneNumber

Method Detail

getApiVersion

getSid

getAccountSid

getTrunkSid

getFriendlyName

getSipUrl

getDateCreated

getDateUpdated

getUrl

getPhoneNumber

isVoiceCallerIdLookup

getVoiceUrl

getVoiceMethod

getVoiceFallbackUrl

getVoiceFallbackMethod

getStatusCallback

getStatusCallbackMethod

getVoiceApplicationSid

getSmsUrl

getSmsMethod

getSmsFallbackUrl

getSmsFallbackMethod

getSmsStatusCallback

getAddressRequirements

isBeta

getCapabilities

delete