com.telapi.api.domain
Class AvailablePhoneNumber

java.lang.Object
  com.telapi.api.domain.AvailablePhoneNumber

public class AvailablePhoneNumber
extends Object

If you want to add a new TelAPI number, you need to know what ones are available. Our REST API provides a way to request a list of available numbers along with all of their resource properties so you know the numbers you have to choose from. Note that individual AvailablePhoneNumber resources can not be requested. Requests only return a list of available resources based on the filtering parameters sent with the request.

Constructor Summary

AvailablePhoneNumber()

Method Summary

String	getCity()
String	getCountryCode()
String	getExchange()
String	getFriendlyName()
String	getIsoCountry()
String	getLata()
String	getLatitude()
String	getLongitude()
BigDecimal	getMonthlyCost()
String	getNpa()
String	getPhoneNumber()
String	getPostalCode()
String	getRateCenter()
String	getRegion()
BigDecimal	getSetupCost()
Boolean	getSmsEnabled()
Boolean	getSupportsForwardedFrom()
PhoneNumberType	getType()
Boolean	getUnblockSupport()
Boolean	getVoiceEnabled()
void	setCity(String city)
void	setCountryCode(String countryCode)
void	setExchange(String exchange)
void	setFriendlyName(String friendlyName)
void	setIsoCountry(String isoCountry)
void	setLata(String lata)
void	setLatitude(String latitude)
void	setLongitude(String longitude)
void	setMonthlyCost(BigDecimal monthlyCost)
void	setNpa(String npa)
void	setPhoneNumber(String phoneNumber)
void	setPostalCode(String postalCode)
void	setRateCenter(String rateCenter)
void	setRegion(String region)
void	setSetupCost(BigDecimal setupCost)
void	setSmsEnabled(Boolean smsEnabled)
void	setSupportsForwardedFrom(Boolean supportsForwardedFrom)
void	setType(PhoneNumberType type)
void	setUnblockSupport(Boolean unblockSupport)
void	setVoiceEnabled(Boolean voiceEnabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailablePhoneNumber

public AvailablePhoneNumber()

Method Detail

getFriendlyName

public String getFriendlyName()

Returns:

Domestic format version of the available phone number. (e.g. 1234567890 to (123)-456-7890)

setFriendlyName

public void setFriendlyName(String friendlyName)

getPhoneNumber

public String getPhoneNumber()

Returns:

The E.164 format number of each available number

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

getLata

public String getLata()

Returns:

Local Access and Transportation Area of the available number. The LATA is determined by geographical region.

setLata

public void setLata(String lata)

getRateCenter

public String getRateCenter()

Returns:

The available phone numbers rate center.

setRateCenter

public void setRateCenter(String rateCenter)

getLatitude

public String getLatitude()

Returns:

The latitude of the available phone number.

setLatitude

public void setLatitude(String latitude)

getLongitude

public String getLongitude()

Returns:

The longitude of the available phone number.

setLongitude

public void setLongitude(String longitude)

getRegion

public String getRegion()

Returns:

The region of the available phone number. Usually a two letter abbreviation.

setRegion

public void setRegion(String region)

getPostalCode

public String getPostalCode()

Returns:

The postal code (also known as zip code) of the available number.

setPostalCode

public void setPostalCode(String postalCode)

getIsoCountry

public String getIsoCountry()

Returns:

Two letter country code of the available phone number.

setIsoCountry

public void setIsoCountry(String isoCountry)

getCountryCode

public String getCountryCode()

Returns:

Code used to identify the phone numbers geographic origin. Found at the beginning of the number.

setCountryCode

public void setCountryCode(String countryCode)

getNpa

public String getNpa()

Returns:

Numbering Plan Area of the available number. This is more commonly known as the area code.

setNpa

public void setNpa(String npa)

getExchange

public String getExchange()

Returns:

Three digits following the NPA (area code) in the available number.

setExchange

public void setExchange(String exchange)

getCity

public String getCity()

Returns:

The available phone numbers city.

setCity

public void setCity(String city)

getType

public PhoneNumberType getType()

Returns:

Type of phone number. (e.g. local, international, etc.)

setType

public void setType(PhoneNumberType type)

getSetupCost

public BigDecimal getSetupCost()

Returns:

Cost of phone number setup.

setSetupCost

public void setSetupCost(BigDecimal setupCost)

getMonthlyCost

public BigDecimal getMonthlyCost()

Returns:

Cost of phone number per month.

setMonthlyCost

public void setMonthlyCost(BigDecimal monthlyCost)

getVoiceEnabled

public Boolean getVoiceEnabled()

Returns:

Is Voice enabled for this phone number? Can be true or false.

setVoiceEnabled

public void setVoiceEnabled(Boolean voiceEnabled)

getSmsEnabled

public Boolean getSmsEnabled()

Returns:

Is SMS enabled for this phone number? Can be true or false.

setSmsEnabled

public void setSmsEnabled(Boolean smsEnabled)

getSupportsForwardedFrom

public Boolean getSupportsForwardedFrom()

Returns:

Does phone number support forwarded from? Can be true or false.

setSupportsForwardedFrom

public void setSupportsForwardedFrom(Boolean supportsForwardedFrom)

getUnblockSupport

public Boolean getUnblockSupport()

Returns:

setUnblockSupport

public void setUnblockSupport(Boolean unblockSupport)