wxc_sdk.telephony.vm_rules module
API for voicemail rules
- class wxc_sdk.telephony.vm_rules.BlockRepeatedDigits(*, enabled: bool | None = None, max: int | None = None)[source]
Bases:
ApiModel
Settings for not allowing single or groups of repeated digits in passcode (for example, 22888, 121212, or 408408).
- enabled: bool | None
If enabled, passcode should not contain repeated digits.
- max: int | None
Maximum number of repeated digits. Min 1, Max 6.
- class wxc_sdk.telephony.vm_rules.BlockContiguousSequences(*, enabled: bool | None = None, numberOfAscendingDigits: int | None = None, numberOfDescendingDigits: int | None = None)[source]
Bases:
ApiModel
Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654).
- enabled: bool | None
If enabled, passcode should not contain a numerical sequence.
- number_of_ascending_digits: int | None
Number of ascending digits in sequence. Min 2, Max 5.
- number_of_descending_digits: int | None
Number of descending digits in sequence. Min 2, Max 5.
- class wxc_sdk.telephony.vm_rules.PinLength(*, min: int | None = None, max: int | None = None)[source]
Bases:
ApiModel
Length of the passcode.
- min: int | None
Min 2, Max 15.
- max: int | None
Min 3, Max 30.
- class wxc_sdk.telephony.vm_rules.DefaultVoicemailPinRules(*, blockRepeatedPatternsEnabled: bool | None = None, blockRepeatedDigits: BlockRepeatedDigits | None = None, blockContiguousSequences: BlockContiguousSequences | None = None, length: PinLength | None = None, defaultVoicemailPinEnabled: bool | None = None)[source]
Bases:
ApiModel
Default voicemail passcode requirements.
- block_repeated_patterns_enabled: bool | None
If enabled, the passcode should not contain repeated pattern.
- block_repeated_digits: BlockRepeatedDigits | None
Settings for not allowing single or groups of repeated digits in passcode (for example, 22888, 121212, or 408408).
- block_contiguous_sequences: BlockContiguousSequences | None
Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654).
- default_voicemail_pin_enabled: bool | None
If enabled, default voicemail passcode can be set.
- static default() DefaultVoicemailPinRules [source]
- class wxc_sdk.telephony.vm_rules.EnabledAndNumberOfDays(*, enabled: bool | None = None, numberOfDays: int | None = None)[source]
Bases:
ApiModel
Settings for passcode expiry or passcode changes
- enabled: bool | None
- number_of_days: int | None
- class wxc_sdk.telephony.vm_rules.BlockPreviousPasscodes(*, enabled: bool | None = None, numberOfPasscodes: int | None = None)[source]
Bases:
ApiModel
Settings for previous passcode usage.
- enabled: bool | None
If enabled, set how many of the previous passcodes are not allowed to be re-used.
- number_of_passcodes: int | None
Number of previous passcodes. Min 1, Max 10.
- class wxc_sdk.telephony.vm_rules.VoiceMailRules(*, defaultVoicemailPinRules: DefaultVoicemailPinRules | None = None, defaultVoicemailPinEnabled: bool | None = None, defaultVoicemailPin: str | None = None, expirePasscode: EnabledAndNumberOfDays | None = None, changePasscode: EnabledAndNumberOfDays | None = None, blockPreviousPasscodes: BlockPreviousPasscodes | None = None)[source]
Bases:
ApiModel
- default_voicemail_pin_rules: DefaultVoicemailPinRules | None
Default voicemail passcode requirements.
- default_voicemail_pin_enabled: bool | None
Set to true to enable default voicemail passcode; only used in update()
- default_voicemail_pin: str | None
Default voicemail passcode; only used in update()
- expire_passcode: EnabledAndNumberOfDays | None
Settings for passcode expiry.
- change_passcode: EnabledAndNumberOfDays | None
Settings for passcode changes.
- block_previous_passcodes: BlockPreviousPasscodes | None
Settings for previous passcode usage.
- static default() VoiceMailRules [source]
- class wxc_sdk.telephony.vm_rules.VoicemailRulesApi(*, session: RestSession, base: str | None = None)[source]
Bases:
ApiChild
API for voicemail rules settings
- read(org_id: str | None = None) VoiceMailRules [source]
Get Voicemail Rules
Retrieve the organization’s voicemail rules.
Organizational voicemail rules specify the default passcode requirements.
Retrieving the organization’s voicemail rules requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
- Parameters:
org_id (str) – Retrieve voicemail settings for this organization.
- Returns:
VM settings
- Return type:
- update(settings: VoiceMailRules, org_id: str | None = None)[source]
Update Voicemail Rules
Update the organization’s default voicemail passcode and/or rules.
Organizational voicemail rules specify the default passcode requirements.
If you choose to set default passcode for new people added to your organization, communicate to your people what that passcode is, and that it must be reset before they can access their voicemail. If this feature is not turned on, each new person must initially set their own passcode.
Updating organization’s voicemail passcode and/or rules requires a full administrator auth token with a scope of spark-admin:telephony_config_write.
- Parameters:
settings (VoiceMailRules) – new settings
org_id (str) – Update voicemail rules for this organization.
- base = 'telephony/config/voicemail/rules'