wxc_sdk.me.voicemail package

class wxc_sdk.me.voicemail.MeVoicemailApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

settings() → VoicemailSettings[source]

Read Voicemail Settings for a Person

Retrieve a person’s voicemail settings.

The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.

Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.

This API requires a user auth token with a scope of spark-admin:people_read.

Return type:

VoicemailSettings

configure(settings: VoicemailSettings)[source]

Configure Voicemail Settings for a Person

Configure a person’s voicemail settings.

The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.

Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.

This API requires a user auth token with a scope of spark-admin:people_write.

Parameters:

settings (VoicemailSettings) – Voicemail settings

Return type:

None

upload_busy_greeting(content: BufferedReader | str, upload_as: str = None)[source]

Upload Voicemail Busy Greeting

Uploads a new busy greeting audio file for the authenticated user’s voicemail.

This endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the wxc-csg-hydra-call-184017-phase4 feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.

Requires a user auth token with the spark:telephony_config_write scope. Only the authenticated user may upload greetings for their own voicemail.

Parameters:

  • content (Union[BufferedReader, str]) – the file to be uploaded, can be a path to a file or a buffered reader (opened file); if a reader referring to an open file is passed then make sure to open the file as binary b/c otherwise the content length might be calculated wrong

  • upload_as (str) – filename for the content. Only required if content is a reader; has to be a .wav file name.

Return type:

None

upload_no_answer_greeting(content: BufferedReader | str, upload_as: str = None)[source]

Upload Voicemail No Answer Greeting

Uploads a new no answer greeting audio file for the authenticated user’s voicemail.

This endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the wxc-csg-hydra-call-184017-phase4 feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.

Requires a user auth token with the spark:telephony_config_write scope. Only the authenticated user may upload greetings for their own voicemail.

Parameters:

  • content (Union[BufferedReader, str]) – the file to be uploaded, can be a path to a file or a buffered reader (opened file); if a reader referring to an open file is passed then make sure to open the file as binary b/c otherwise the content length might be calculated wrong

  • upload_as (str) – filename for the content. Only required if content is a reader; has to be a .wav file name.

Return type:

None

update_pin(passcode: str) → None[source]

Update Voicemail PIN

Set the voicemail PIN for a person. Updates the PIN used to access voicemail messages. The PIN must comply with the passcode rules defined for the organization.

The voicemail feature is part of Webex Calling, allowing users to secure their voicemail access with a PIN. The PIN is required to retrieve voice messages via phone.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

passcode (str) – Person voicemail PIN. The PIN must comply with the passcode rules defined for the organization.

Return type:

None

get_voicemail_rules() → UserVoicemailPINRules[source]

Get Person’s Voicemail Rules

Get person’s voicemail passcode rules. Voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.

The voicemail feature allows users to manage their voicemail settings as part of Webex Calling. Voicemail rules help ensure secure access to voice messages by defining passcode complexity requirements.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

UserVoicemailPINRules

base = 'telephony/config/people/me'