wxc_sdk.telephony.organisation_vm module

Organisation voicemail settings

class wxc_sdk.telephony.organisation_vm.OrganisationVoicemailSettings(*, messageExpiryEnabled: bool, numberOfDaysForMessageExpiry: int, strictDeletionEnabled: bool | None = None, voiceMessageForwardingEnabled: bool | None = None)[source]

Bases: ApiModel

voicemail settings for and organization.

message_expiry_enabled: bool: When enabled, you can set the deletion conditions for expired messages.

number_of_days_for_message_expiry: int: Number of days after which messages expire.

strict_deletion_enabled: bool | None: When enabled, all read and unread voicemail messages will be deleted based on the time frame you set. When disabled, all unread voicemail messages will be kept.

voice_message_forwarding_enabled: bool | None: When enabled, people in the organization can configure the email forwarding of voicemails.

static default() → OrganisationVoicemailSettings[source]

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

Bases: ApiChild

API for Organisation voicemail settings

read(org_id: str | None = None) → OrganisationVoicemailSettings[source]

Get Voicemail Settings

Retrieve the organization’s voicemail settings.

Organizational voicemail settings determines what voicemail features a person can configure and automatic message expiration.

Retrieving organization’s voicemail settings 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:: OrganisationVoicemailSettings

update(settings: OrganisationVoicemailSettings, org_id: str | None = None)[source]

Update the organization’s voicemail settings.

Organizational voicemail settings determines what voicemail features a person can configure and automatic message expiration.

Updating organization’s voicemail settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

settings (OrganisationVoicemailSettings) – new settings
org_id (str) – Update voicemail settings for this organization.

base = 'telephony/config/voicemail/settings'