wxc_sdk.telephony.voiceportal module

Voice portal API

class wxc_sdk.telephony.voiceportal.VoicePortalSettings(*, id: str | None = None, name: str, language: str, languageCode: str, extension: str | None = None, phoneNumber: str | None = None, firstName: str, lastName: str)[source]

Bases: ApiModel

portal_id: str | None: Voice Portal ID

name: str: Voice Portal Name.

language: str: Language for audio announcements.

language_code: str: Language code for voicemail group audio announcement

extension: str | None: Extension of incoming call.

phone_number: str | None: Phone Number of incoming call.

first_name: str: Caller ID First Name.

last_name: str: Caller ID Last Name

class wxc_sdk.telephony.voiceportal.FailedAttempts(*, enabled: bool, attempts: int)[source]

Bases: ApiModel

Number of failed attempts allowed.

enabled: bool: If enabled, allows specified number of attempts before locking voice portal access.

attempts: int: Number of failed attempts allowed.

class wxc_sdk.telephony.voiceportal.ExpirePasscode(*, enabled: bool, days: int)[source]

Bases: ApiModel

enabled: bool

days: int

class wxc_sdk.telephony.voiceportal.PasscodeRules(*, expirePasscode: ExpirePasscode | None = None, failedAttempts: FailedAttempts, blockPreviousPasscodes: BlockPreviousPasscodes, blockRepeatedDigits: BlockRepeatedDigits, blockContiguousSequences: BlockContiguousSequences, length: PinLength, blockReversedUserNumberEnabled: bool, blockUserNumberEnabled: bool, blockRepeatedPatternsEnabled: bool, blockReversedOldPasscodeEnabled: bool)[source]

Bases: ApiModel

expire_passcode: ExpirePasscode | None: Settings for passcode expiry.

failed_attempts: FailedAttempts: Number of failed attempts allowed.

block_previous_passcodes: BlockPreviousPasscodes: Settings for previous passcode usage.

block_repeated_digits: BlockRepeatedDigits: Settings for not allowing single or groups of repeated digits in passcode (for example, 22888, 121212, or 408408).

block_contiguous_sequences: BlockContiguousSequences: Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654).

length: PinLength: Allowed length of the passcode.

block_reversed_user_number_enabled: bool: If enabled, the passcode do not allow revered phone number or extension.

block_user_number_enabled: bool: If enabled, the passcode do not allow user phone number or extension.

block_repeated_patterns_enabled: bool: If enabled, the passcode do not contain repeated pattern.

block_reversed_old_passcode_enabled: bool: If enabled, the passcode do not allow setting reversed old passcode.

class wxc_sdk.telephony.voiceportal.VoicePortalApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

location voice portal API

read(location_id: str, org_id: str | None = None) → VoicePortalSettings[source]

Parameters:

location_id (str) – Location to which the voice portal belongs.
org_id (str) – Organization to which the voice portal belongs.

Returns:

location voice portal settings

Return type:

VoicePortalSettings

update(location_id: str, settings: VoicePortalSettings, passcode: str | None = None, org_id: str | None = None)[source]

Update VoicePortal

Update Voice portal information for the location.

Voice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant announcements.

Updating voice portal information for organization and/or rules requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – Location to which the voice portal belongs.
settings (VoicePortalSettings) – new settings
passcode (str) – new passcode
org_id (str) – Organization to which the voice portal belongs.

passcode_rules(location_id: str, org_id: str | None = None) → PasscodeRules[source]

Get VoicePortal Passcode Rule

Retrieve the voice portal passcode rule for a location.

Voice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant announcements

Retrieving the voice portal passcode rule requires a full read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

location_id (str) – Retrieve voice portal passcode rules for this location.
org_id (str) – Retrieve voice portal passcode rules for this organization.

Returns:

passcode rules

Return type:

PasscodeRules

base = 'telephony/config/locations'