wxc_sdk.me.secondary_line.voicemail package

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

Bases: ApiChild

settings(lineowner_id: str) VoicemailSettings[source]

Get My Secondary Line Owner’s Voicemail Settings

GET voicemail settings for a secondary line of the authenticated user.

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.

Parameters:

lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

Return type:

VoicemailSettings

configure(lineowner_id: str, settings: VoicemailSettings)[source]

Modify My Secondary Line Owner’s Voicemail Settings

Update voicemail settings associated with a secondary line owner of the authenticated user.

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:
  • lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

  • settings (VoicemailSettings) – Voicemail settings

Return type:

None

base = 'telephony/config/people/me'