RingCentral.NumberParserContext Class Reference

The manually set parsing context to override the context parameter values taken from the context source. More...

Properties
string	brandId [get, set]
	Internal identifier of the RingCentral brand. Brand context definition.
CountryContext	country [get, set]
string	defaultAreaCode [get, set]
	Default area code of the caller. Provides support for the dial plan feature "[Default Area Code](https://support.ringcentral.com/article/dial-plan-default-area-code-ringcentral-mvp.html)".
bool?	vanityPhoneNumbersAllowed [get, set]
	Vanity phone numbers are supported in the parsing input. Provides support for the feature "[Vanity Numbers dialing](https://support.ringcentral.com/article/Requesting-a-toll-free-vanity-number.html)".
long?	maxExtensionNumberLength [get, set]
	The maximum allowed length of extension numbers on the account. Provides support for the dial plan feature "[Variable-length Extensions](https://support.ringcentral.com/article/11277-Enterprise-Dial-Plan-Max-Extension-Length.html)".
bool?	shortCodesAllowed [get, set]
	Short codes are supported in the parsing input. Provides support for the feature "Shortcodes dialing".
string	siteCode [get, set]
	The site code of caller. Together with parameter context.shortExtensionNumberLength provides support for the feature "[Site Codes](https://support.ringcentral.com/article/11279-Enterprise-Dial-Plan-Site-Codes.html)".
long?	shortExtensionNumberLength [get, set]
	The allowed length of short extension numbers on the account. Together with parameter context.siteCode provides support for the feature "[Site Codes](https://support.ringcentral.com/article/11279-Enterprise-Dial-Plan-Site-Codes.html)".
string	outboundCallPrefix [get, set]
	Digit of outbound call prefix on the account. Provides support for the dial plan feature "[Outbound Call Prefix](https://support.ringcentral.com/article/11278-Enterprise-Dial-Plan-Outbound-Call-Prefix.html)".
bool?	maskedPhoneNumbersAllowed [get, set]
	Masked phone numbers are supported in the the parsing input. Provides support for the feature "[Masked Numbers](https://support.ringcentral.com/article/Number-Masking-French-Numbers.html)".
string	maskSymbol [get, set]
	A character used for masking phone numbers.
long?	maskLength [get, set]
	The number of last digits of the phone number which are masked.
string	conflictHandling [get, set]
	Defines the logic of conflicts resolving when it's impossible to detect whether the inputted string corresponds to an extension number or a phone number. Provides support for the feature "Smart Dial Plan Routing".

Detailed Description

The manually set parsing context to override the context parameter values taken from the context source.

Property Documentation

brandId

string RingCentral.NumberParserContext.brandId

getset

Internal identifier of the RingCentral brand. Brand context definition.

• If the value is not specified, it's taken from the context source:
  • Default -> null
  • Account -> brand from the request context header
• Explicitly set value redefines the value taken from the context source.
• Explicitly set null value disables brand context for parsing. Example: 1210

conflictHandling

string RingCentral.NumberParserContext.conflictHandling

getset

Defines the logic of conflicts resolving when it's impossible to detect whether the inputted string corresponds to an extension number or a phone number. Provides support for the feature "Smart Dial Plan Routing".

Possible values:

• Default - the ambiguous number will always be classified as an extension number;
• Client - the ambiguous number will get Ambiguous category and the final decision whether the number is an extension number or a phone number should be made by the requester.
• If the value is not specified, it's taken from the context source:
  • Default -> Default
  • Client -> the value from the requester's account settings
• Explicitly set value redefines the value taken from the context source. Example: Client Default: Default Enum: Default, Client

defaultAreaCode

string RingCentral.NumberParserContext.defaultAreaCode

getset

Default area code of the caller. Provides support for the dial plan feature "[Default Area Code](https://support.ringcentral.com/article/dial-plan-default-area-code-ringcentral-mvp.html)".

If the value is not specified or explicitly set to null, the feature "Default Area Code" context is disabled for parsing. Example: 650

maskedPhoneNumbersAllowed

bool? RingCentral.NumberParserContext.maskedPhoneNumbersAllowed

getset

Masked phone numbers are supported in the the parsing input. Provides support for the feature "[Masked Numbers](https://support.ringcentral.com/article/Number-Masking-French-Numbers.html)".

• If the value is not specified or explicitly set to false, the feature "Masked Numbers" context is disabled for parsing.

maskLength

long? RingCentral.NumberParserContext.maskLength

getset

The number of last digits of the phone number which are masked.

Absent if the request's parameter context.maskedPhoneNumbersAllowed value is set to false. Format: int32 Example: 4

maskSymbol

string RingCentral.NumberParserContext.maskSymbol

getset

A character used for masking phone numbers.

Absent if the request's parameter context.maskedPhoneNumbersAllowed value is set to false. Example: X

maxExtensionNumberLength

long? RingCentral.NumberParserContext.maxExtensionNumberLength

getset

The maximum allowed length of extension numbers on the account. Provides support for the dial plan feature "[Variable-length Extensions](https://support.ringcentral.com/article/11277-Enterprise-Dial-Plan-Max-Extension-Length.html)".

• If the value is not specified, it's taken from the context source:
  • Default -> 5
  • Account -> the value from the requester's account settings
• Explicitly set value redefines the value taken from the context source.
• Explicitly set null value disables extension numbers detection. Maximum: 9 Minimum: 1 Format: int32

outboundCallPrefix

string RingCentral.NumberParserContext.outboundCallPrefix

getset

Digit of outbound call prefix on the account. Provides support for the dial plan feature "[Outbound Call Prefix](https://support.ringcentral.com/article/11278-Enterprise-Dial-Plan-Outbound-Call-Prefix.html)".

• If the value is not specified, it's taken from the context source:
  • Default -> null
  • Account -> the value from the requester's account settings
• Explicitly set value redefines the value taken from the context source.
• Explicitly set null value disables outbound call prefix detection. Example: 9

shortCodesAllowed

bool? RingCentral.NumberParserContext.shortCodesAllowed

getset

Short codes are supported in the parsing input. Provides support for the feature "Shortcodes dialing".

• If the value is not specified, it's taken from the context source:
  • Default -> false
  • Account -> the value from the requester's account settings
• Explicitly set value redefines the value taken from the context source.

shortExtensionNumberLength

long? RingCentral.NumberParserContext.shortExtensionNumberLength

getset

The allowed length of short extension numbers on the account. Together with parameter context.siteCode provides support for the feature "[Site Codes](https://support.ringcentral.com/article/11279-Enterprise-Dial-Plan-Site-Codes.html)".

• The value is ignored and treated as null if parameter context.siteCode is not specified or explicitly set to null.
• If the value is not specified, it's taken from the context source:
  • Default -> 3
  • Account -> the value from the requester's account settings
• Explicitly set value redefines the value taken from the context source. Maximum: 8 Minimum: 1 Format: int32 Example: 4

siteCode

string RingCentral.NumberParserContext.siteCode

getset

The site code of caller. Together with parameter context.shortExtensionNumberLength provides support for the feature "[Site Codes](https://support.ringcentral.com/article/11279-Enterprise-Dial-Plan-Site-Codes.html)".

• If the value is not specified or explicitly set to null, the feature "Site Codes" context is disabled for parsing. Example: 13

vanityPhoneNumbersAllowed

bool? RingCentral.NumberParserContext.vanityPhoneNumbersAllowed

getset

Vanity phone numbers are supported in the parsing input. Provides support for the feature "[Vanity Numbers dialing](https://support.ringcentral.com/article/Requesting-a-toll-free-vanity-number.html)".

• If the value is not specified, it's taken from the context source:
  • Default -> false
  • Account -> true
• Explicitly set value redefines the value taken from the context source. Example: true

---

The documentation for this class was generated from the following file:

• RingCentral.Net/Definitions/NumberParserContext.cs