Avaya Client Services API Reference (iOS)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Properties | List of all members
CSDialingRulesConfiguration Class Reference

The dialing rules configuration to be applied to transform a user supplied number into a dialable number. More...

`#import <CSDialingRulesConfiguration.h>`

Inherits NSObject.

## Properties
BOOL | enabled
| Indicates whether the dialing rules are enabled. More...
NSString * | outsideLineAccessCode
| The string of digits to prepend to the dialed number to make an external call from an enterprise network. More...
NSString * | countryCode
| The country code for the user's region. More...
NSString * | areaCode
| The area code for the user's region. More...
BOOL | removeAreaCodeForLocalCalls
| Indicates whether or not the area code should be removed when dialing local numbers. More...
NSString * | pbxPrefix
| The prefix used for internal extensions. More...
NSString * | longDistanceAccessCode
| The long distance access code for the user's region. More...
NSString * | internationalAccessCode
| The access code for outgoing international calls. More...
NSArray * | nationalNumberLengths
| The lengths of national numbers valid for the user's country. More...
NSArray * | extensionLengths
| The lengths of all internal extensions in the enterprise network. More...
BOOL | applyOutsideLineAccessCodeToShortNumbers
| Indicates whether to disable the dialing rules logic that automatically prefixes the outside line access code to numbers that are shorter than the shortest extension length. More...
BOOL | allowE164Passthrough
| Indicates whether to allow sending of E.164 numbers (i.e any numbers with a leading '+') directly to the network server without application of any dialing rules transformations. More...
BOOL | enablePoundKeyAsCallTrigger
| Indicates whether pressing pound sign during off-hook dialing should trigger the call start. More...
BOOL | excludeDialingRulesFromCallRecordsEnabled
| Indicates whether dialing rule prefixes should be removed from call records for outgoing calls. More...

## Detailed Description

The dialing rules configuration to be applied to transform a user supplied number into a dialable number.

## Property Documentation

- (BOOL) allowE164Passthrough
| readwritenonatomicassign

Indicates whether to allow sending of E.164 numbers (i.e any numbers with a leading '+') directly to the network server without application of any dialing rules transformations.

- (BOOL) applyOutsideLineAccessCodeToShortNumbers
| readwritenonatomicassign

Indicates whether to disable the dialing rules logic that automatically prefixes the outside line access code to numbers that are shorter than the shortest extension length.

- (NSString*) areaCode
| readwritenonatomiccopy

The area code for the user's region.

For example, if local phone number is in the form of +1 303-538-1234, then the area code is "303".

- (NSString*) countryCode
| readwritenonatomiccopy

The country code for the user's region.

For example, if local phone number is in the form of +1 303-538-1234, then the country code is "1".

- (BOOL) enabled
| readwritenonatomicassign

Indicates whether the dialing rules are enabled.

- (BOOL) enablePoundKeyAsCallTrigger
| readwritenonatomicassign

Indicates whether pressing pound sign during off-hook dialing should trigger the call start.

- (BOOL) excludeDialingRulesFromCallRecordsEnabled
| readwritenonatomicassign

Indicates whether dialing rule prefixes should be removed from call records for outgoing calls.

When enabled, any access codes applied during dialing— such as outside line access (ARS), long distance (LDC), international call codes (ICC), PBX prefixes, or local area codes—are stripped before storing the number in the call log.

This ensures that the call record shows the original number the user intended to dial, without any extra prefixes that were added for routing purposes.

For example, if the dialed number is "909665493800", where:

- Outside line access code = 9
- Long distance access code = 0

The original number is "9665493800". Enabling this property will store "9665493800" in the call log, omitting the access codes used for dialing.

The default value of this property is `NO`.

- (NSArray*) extensionLengths
| readwritenonatomiccopy

The lengths of all internal extensions in the enterprise network.

- (NSString*) internationalAccessCode
| readwritenonatomiccopy

The access code for outgoing international calls.

For example, in the United States, this access code would be "011".

- (NSString*) longDistanceAccessCode
| readwritenonatomiccopy

The long distance access code for the user's region.

For example, in the United States, the access code would be "1".

- (NSArray*) nationalNumberLengths
| readwritenonatomiccopy

The lengths of national numbers valid for the user's country.

These lengths represent numbers without the country code. For example, some European countries like Italy have variable national number lengths between 8 to 12.

- (NSString*) outsideLineAccessCode
| readwritenonatomiccopy

The string of digits to prepend to the dialed number to make an external call from an enterprise network.

To disambiguate between internal and external numbers most PBX systems require an access code like "9" to obtain an outside line.

- (NSString*) pbxPrefix
| readwritenonatomiccopy

The prefix used for internal extensions.

For example, if the area code is set to "303", the prefix is set to "538", and the extension length is 5 then the number "+1 303-538-12345" will be dialed as "12345". The combination of area code and prefix allows the dialing rules to recognize an internal number from local, national or international numbering format.

- (BOOL) removeAreaCodeForLocalCalls
| readwritenonatomicassign

Indicates whether or not the area code should be removed when dialing local numbers.

For example, if the area code is set to "303", the outside line access code is set to "9", and this option is enabled, then applying dialing rules to "303-538-1234" will result in "95381234".

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

- CSDialingRulesConfiguration.h