wxc_sdk.telephony.voicemail_groups module

Voicemail groups API

class wxc_sdk.telephony.voicemail_groups.VoicemailGroup(*, id: str, name: str, locationName: str, locationId: str, extension: str | None = None, phoneNumber: str | None = None, routingPrefix: str | None = None, esn: str | None = None, enabled: bool, tollFreeNumber: bool = False)[source]

Bases: ApiModel

group_id: str

Voicemail Group ID.

name: str

Voicemail Group Name.

location_name: str

Location Name.

location_id: str

location id

extension: str | None

Extension of the voicemail group.

phone_number: str | None

Phone number of the voicemail group.

routingPrefix: str | None

If enabled, incoming calls are sent to voicemail. Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.

enabled: bool
toll_free_number: bool

Flag to indicate if the number is toll free.

class wxc_sdk.telephony.voicemail_groups.VoicemailGroupDetail(*, id: str | None = None, name: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, tollFreeNumber: bool | None = None, firstName: str | None = None, lastName: str | None = None, passcode: int | None = None, enabled: bool | None = None, languageCode: str | None = None, greeting: Greeting | None = None, greetingUploaded: bool | None = None, greetingDescription: str | None = None, messageStorage: VoicemailMessageStorage | None = None, notifications: VoicemailNotifications | None = None, faxMessage: VoicemailFax | None = None, transferToNumber: VoicemailTransferToNumber | None = None, emailCopyOfMessage: VoicemailCopyOfMessage | None = None, voiceMessageForwardingEnabled: bool | None = None, timeZone: str | None = None)[source]

Bases: ApiModel

group_id: str | None

UUID of voicemail group of a particular location.

name: str | None

Name of the voicemail group.

phone_number: str | None

Voicemail group phone number.

extension: str | None

Voicemail group extension number.

routingPrefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.

toll_free_number: bool | None

Voicemail group toll free number.

first_name: str | None

Voicemail group caller id first name.

last_name: str | None

Voicemail group called id last name.

passcode: int | None

passcode

enabled: bool | None

Enable/disable voicemail group.

language_code: str | None

Language for voicemail group audio announcement.

greeting: Greeting | None

Set voicemail group greeting typ

greeting_uploaded: bool | None

Enabled if CUSTOM greeting is previously uploaded.

greeting_description: str | None

CUSTOM greeting for previously uploaded.

message_storage: VoicemailMessageStorage | None

Message storage information

notifications: VoicemailNotifications | None

Message notifications

fax_message: VoicemailFax | None

Fax message receive settings

transfer_to_number: VoicemailTransferToNumber | None

Transfer message information

email_copy_of_message: VoicemailCopyOfMessage | None

Message copy information

voice_message_forwarding_enabled: bool | None

Enable/disable to forward voice message.

time_zone: str | None
static create(name: str, extension: str, first_name: str, last_name: str, passcode: int, language_code: str = 'en_us', phone_number: str | None = None) → VoicemailGroupDetail[source]

VoiceMailGroupDetail for create() call

Parameters:

  • name – Name of the voicemail group.

  • extension – Voicemail group extension number.

  • first_name – Voicemail group caller id first name.

  • last_name – Voicemail group called id last name.

  • passcode – passcode

  • language_code – Language for voicemail group audio announcement.

  • phone_number – Voicemail group phone number.

Returns:

Voicemail group details which can be used in VoicemailGroupsApi.create()

Return type:

VoicemailGroupDetail

json_for_create() → str[source]
json_for_update() → str[source]
class wxc_sdk.telephony.voicemail_groups.VoicemailGroupsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

API for voicemail groups

ep(location_id: str | None = None, path: str | None = None)[source]
Parameters:

  • location_id

  • path

Returns:

list(location_id: str | None = None, name: str | None = None, phone_number: str | None = None, org_id: str | None = None, **params) → Generator[VoicemailGroup, None, None][source]

List the voicemail group information for the organization.

You can create a shared voicemail box and inbound fax box to assign to users or call routing features like an auto attendant, call queue, or hunt group.

Retrieving voicemail Group for the organization requires a full read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Location to which the voicemail group belongs.

  • name (str) – Search (Contains) based on voicemail group name

  • phone_number (str) – Search (Contains) based on number or extension

  • org_id (str) – Organization to which the voicemail group belongs.

Returns:

yields ::class::VoicemailGroup instances

details(location_id: str, voicemail_group_id: str, org_id: str | None = None) → VoicemailGroupDetail[source]

Retrieve voicemail group details for a location.

Manage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.

Retrieving voicemail group details requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Retrieve voicemail group details for this location.

  • voicemail_group_id (str) – Retrieve voicemail group details for this voicemail group ID.

  • org_id (str) – Retrieve voicemail group details for a customer location.

Returns:

Voicemail group settings

Type:

VoicemailGroupDetail

update(location_id: str, voicemail_group_id: str, settings: VoicemailGroupDetail, org_id: str | None = None)[source]

Modifies the voicemail group location details for a particular location for a customer.

Manage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.

Modifying the voicemail group location details requires a full, user administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Modifies the voicemail group details for this location.

  • voicemail_group_id (str) – Modifies the voicemail group details for this voicemail group ID.

  • settings (VoicemailGroupDetail) – New settings

  • org_id (str) – Modifies the voicemail group details for a customer location.

create(location_id: str, settings: VoicemailGroupDetail, org_id: str | None = None) → str[source]

Create new voicemail group for the given location for a customer.

Voicemail group can be created for given location for a customer.

Creating voicemail group for the given location requires a full or user administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Create new voice mail group for this location.

  • settings (VoicemailGroupDetail) –

    settings for new voicemail group Example:

    settings = VoicemailGroupDetail.create(
                        name=vmg_name, extension=extension,
                        first_name='first', last_name='last',
                        passcode=740384)
vmg_id = api.telephony.voicemail_groups.create(location_id=location_id,
                                               settings=settings)

  • org_id (str) – Create new voice mail group for this organization.

Returns:

UUID of the newly created voice mail group.

Return type:

str

delete(location_id: str, voicemail_group_id: str, org_id: str | None = None)[source]

Delete the designated voicemail group.

Deleting a voicemail group requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location from which to delete a voicemail group.

  • voicemail_group_id (str) – Delete the voicemail group with the matching ID.

  • org_id (str) – Delete the voicemail group from this organization.

base = 'telephony/config/voicemailGroups'