wxc_sdk.me.voicemail package

class wxc_sdk.me.voicemail.MeVoicemailApi(*, session: RestSession, base: str | None = 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

base = 'telephony/config/people/me'