wxc_sdk.telephony.location.vm module

API for location voicemail settings

class wxc_sdk.telephony.location.vm.LocationVoiceMailSettings(*, voicemailTranscriptionEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

voicemail settings for a specific location

voicemail_transcription_enabled: bool | None

Set to true to enable voicemail transcription.

class wxc_sdk.telephony.location.vm.LocationVoicemailSettingsApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

location voicemail settings API, for now only enable/disable Vm transcription

read(location_id: str, org_id: str = None) → LocationVoiceMailSettings[source]

Get Location Voicemail

Retrieve voicemail settings for a specific location.

Location’s voicemail settings allows you to enable voicemail transcription for a specific location.

Retrieving location’s voicemail settings requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Retrieve access codes details for this location.

  • org_id (str) – Retrieve access codes details for a customer location in this organization

Returns:

location voicemail settings

Return type:

LocationVoiceMailSettings

update(location_id: str, settings: LocationVoiceMailSettings, org_id: str = None)[source]

Update Location Voicemail

Update the voicemail settings for a specific location.

Location voicemail settings allows you to enable voicemail transcription for a specific location.

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

Parameters:

  • location_id (str) – Update voicemail settings for this location.

  • settings (LocationVoiceMailSettings) – new settings

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

base = 'telephony/config/locations'