Package com.ringcentral.definitions

Class NumberDetails

java.lang.Object

com.ringcentral.definitions.NumberDetails

public class NumberDetails
extends Object

Absent if the request's parameter `resultContent.includeNumberDetails` value is set to `false`.

Field Summary

Fields

Modifier and Type	Field	Description
String	allocationBlockCode	Absent if the response's attribute `results.originalString` value doesn't contain an allocation block code.
String	areaCode	Absent if the response's attribute `results.originalString` value doesn't contain an area code.
CountryContext	country
String	dtmfPostfix	Absent if the response's attribute `results.originalString` value doesn't contain a DTMF postfix.
String	extensionNumber	Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode`, `SpecialService`, `Regular`, `TollFree` and `ShortCode`.
String	nationalDestinationCode	Absent if the response's attribute `results.originalString` value doesn't contain a national destination code.
Boolean	probablyMasked	Absent if the request's parameter `context.maskedPhoneNumbersAllowed` value is set to `false`.
String	regionalDestinationCode	Absent if the response's attribute `results.originalString` value doesn't contain a regional destination code.
String	shortExtensionNumber	Absent if the request's parameter `context.siteCode` value is set to `null`.
String	sipPostfix	Absent if the response's attribute `results.originalString` value doesn't contain a SIP postfix.
String	siteCode	Absent if the request's parameter `context.siteCode` value is set to `null`.
NumberDetailsSpecialService	specialService	Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode`, `Extension`, `Regular`, `TollFree`, `ShortCode` and `Ambiguous`.
String	status	Absent for the `results.category` response's attribute values: `Unknown`, `SpecialService`, `Extension`, `TollFree`, `ShortCode` and `Ambiguous`.
String	subAddress	Absent if the response's attribute `results.originalString` value doesn't contain a sub-address.
String	subscriberNumber	Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode` and `Extension`.

Constructor Summary

Constructors

Constructor	Description
NumberDetails()

Method Summary

Modifier and Type	Method	Description
NumberDetails	allocationBlockCode(String allocationBlockCode)
NumberDetails	areaCode(String areaCode)
NumberDetails	country(CountryContext country)
NumberDetails	dtmfPostfix(String dtmfPostfix)
NumberDetails	extensionNumber(String extensionNumber)
NumberDetails	nationalDestinationCode(String nationalDestinationCode)
NumberDetails	probablyMasked(Boolean probablyMasked)
NumberDetails	regionalDestinationCode(String regionalDestinationCode)
NumberDetails	shortExtensionNumber(String shortExtensionNumber)
NumberDetails	sipPostfix(String sipPostfix)
NumberDetails	siteCode(String siteCode)
NumberDetails	specialService(NumberDetailsSpecialService specialService)
NumberDetails	status(String status)
NumberDetails	subAddress(String subAddress)
NumberDetails	subscriberNumber(String subscriberNumber)

Methods inherited from class java.lang.Object

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

Field Details

siteCode

public String siteCode

Absent if the request's parameter `context.siteCode` value is set to `null`. Example: 10

shortExtensionNumber

public String shortExtensionNumber

Absent if the request's parameter `context.siteCode` value is set to `null`. Example: 303

extensionNumber

public String extensionNumber

Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode`, `SpecialService`, `Regular`, `TollFree` and `ShortCode`. Example: 10303

specialService

public NumberDetailsSpecialService specialService

Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode`, `Extension`, `Regular`, `TollFree`, `ShortCode` and `Ambiguous`.

country

public CountryContext country

nationalDestinationCode

public String nationalDestinationCode

Absent if the response's attribute `results.originalString` value doesn't contain a national destination code.

areaCode

public String areaCode

Absent if the response's attribute `results.originalString` value doesn't contain an area code. Example: 650

regionalDestinationCode

public String regionalDestinationCode

Absent if the response's attribute `results.originalString` value doesn't contain a regional destination code.

allocationBlockCode

public String allocationBlockCode

Absent if the response's attribute `results.originalString` value doesn't contain an allocation block code.

subscriberNumber

public String subscriberNumber

Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode` and `Extension`. Example: 5558275

subAddress

public String subAddress

Absent if the response's attribute `results.originalString` value doesn't contain a sub-address. Example: 1019

dtmfPostfix

public String dtmfPostfix

Absent if the response's attribute `results.originalString` value doesn't contain a DTMF postfix. Example: ,,,1,3,1,

sipPostfix

public String sipPostfix

Absent if the response's attribute `results.originalString` value doesn't contain a SIP postfix. Example: @sip.ringcentral.com

probablyMasked

public Boolean probablyMasked

Absent if the request's parameter `context.maskedPhoneNumbersAllowed` value is set to `false`.

status

public String status

Absent for the `results.category` response's attribute values: `Unknown`, `SpecialService`, `Extension`, `TollFree`, `ShortCode` and `Ambiguous`. Example: Valid Enum: Valid, Possible, Invalid

Constructor Details

NumberDetails

public NumberDetails()

Method Details

siteCode

public NumberDetails siteCode(String siteCode)

shortExtensionNumber

public NumberDetails shortExtensionNumber(String shortExtensionNumber)

extensionNumber

public NumberDetails extensionNumber(String extensionNumber)

specialService

public NumberDetails specialService(NumberDetailsSpecialService specialService)

country

public NumberDetails country(CountryContext country)

nationalDestinationCode

public NumberDetails nationalDestinationCode(String nationalDestinationCode)

areaCode

public NumberDetails areaCode(String areaCode)

regionalDestinationCode

public NumberDetails regionalDestinationCode(String regionalDestinationCode)

allocationBlockCode

public NumberDetails allocationBlockCode(String allocationBlockCode)

subscriberNumber

public NumberDetails subscriberNumber(String subscriberNumber)

subAddress

public NumberDetails subAddress(String subAddress)

dtmfPostfix

public NumberDetails dtmfPostfix(String dtmfPostfix)

sipPostfix

public NumberDetails sipPostfix(String sipPostfix)

probablyMasked

public NumberDetails probablyMasked(Boolean probablyMasked)

status

public NumberDetails status(String status)