wxc_sdk.person_settings.moh module

class wxc_sdk.person_settings.moh.MusicOnHold(*, mohEnabled: bool | None = None, mohLocationEnabled: bool | None = None, greeting: Greeting | None = None, audioAnnouncementFile: AnnAudioFile | None = None)[source]

Bases: ApiModel

moh_enabled: bool | None

Music on hold enabled or disabled for the entity.

moh_location_enabled: bool | None

Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When mohLocationEnabled is false and mohEnabled is true, music on hold is disabled for the user. When mohLocationEnabled is true and mohEnabled is false, music on hold is turned off for the user. In both cases, music on hold will not be played.

greeting: Greeting | None

Greeting type for the person. example: DEFAULT

audio_announcement_file: AnnAudioFile | None

Announcement Audio File details when greeting is selected to be CUSTOM.

class wxc_sdk.person_settings.moh.MusicOnHoldApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

feature = 'musicOnHold'
read(entity_id: str, org_id: str | None = None) → MusicOnHold[source]

Retrieve Music On Hold Settings for a Person, virtual line, or workspace.

Retrieve the music on hold settings.

Music on hold is played when a caller is put on hold, or the call is parked.

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

Parameters:

  • entity_id (str) – Unique identifier for the person, virtual line, or workspace.

  • org_id (str) – ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Return type:

GetMusicOnHoldObject

configure(entity_id: str, settings: MusicOnHold, org_id: str | None = None)[source]

Configure Music On Hold Settings for a Personvirtual line, or workspace.

Configure music on hold settings.

Music on hold is played when a caller is put on hold, or the call is parked.

To configure music on hold settings for a person, music on hold setting must be enabled for this location.

Updating a person’s music on hold settings requires a full or user administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • entity_id (str) – Unique identifier for the person, virtual line, or workspace.

  • settings (MusicOnHold) – new MOH settings

  • org_id (str) – ID of the organization in which the entity resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Return type:

None

base = ''