wxc_sdk.person_settings.call_recording module

Call recording API

class wxc_sdk.person_settings.call_recording.Record(*values)[source]

Bases: str, SafeEnum

An enumeration.

always = 'Always': Call recording is always enabled.

never = 'Never': Call recording is never enabled.

on_demand = 'On Demand': Call recording is started and stopped manually by the user.

always_with_pause_resume = 'Always with Pause/Resume': Call recording is always enabled with the ability to pause and resume.

on_demand_with_user_initiated_start = 'On Demand with User Initiated Start': Call recording is started manually by the user.

class wxc_sdk.person_settings.call_recording.NotificationType(*values)[source]

Bases: str, SafeEnum

Type of pause/resume notification.

none = 'None': No notification sound played when call recording is paused or resumed.

beep = 'Beep': A beep sound is played when call recording is paused or resumed.

play_announcement = 'Play Announcement': A verbal announcement is played when call recording is paused or resumed.

class wxc_sdk.person_settings.call_recording.NotificationRepeat(*, interval: int, enabled: bool, **extra_data: Any)[source]

Bases: ApiModel

Beep sound plays periodically.

interval: int: Interval at which warning tone “beep” will be played. This interval is an integer from 10 to 1800 seconds

enabled: bool

class wxc_sdk.person_settings.call_recording.Notification(*, type: NotificationType | None = None, enabled: bool, **extra_data: Any)[source]

Bases: ApiModel

notification_type: NotificationType | None: Type of pause/resume notification.

enabled: bool: true when the notification feature is in effect. false indicates notification is disabled.

class wxc_sdk.person_settings.call_recording.CallRecordingSetting(*, enabled: bool | None = None, record: Record | None = None, recordVoicemailEnabled: bool | None = None, startStopAnnouncementEnabled: bool | None = None, notification: Notification | None = None, repeat: NotificationRepeat | None = None, serviceProvider: str | None = None, externalGroup: str | None = None, externalIdentifier: str | None = None, startStopAnnouncement: StartStopAnnouncement | None = None, callRecordingAccessSettings: CallRecordingAccessSettings | None = None, postCallRecordingSettings: PostCallRecordingSettings | None = None, announcements: CallRecordingAnnouncements | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None: true if call recording is enabled.

record: Record | None: Specified under which scenarios calls will be recorded.

record_voicemail_enabled: bool | None: When true, voicemail messages are also recorded.

start_stop_announcement_enabled: bool | None: When enabled, an announcement is played when call recording starts and an announcement is played when call recording ends.

notification: Notification | None: Pause/resume notification settings.

repeat: NotificationRepeat | None: Beep sound plays periodically.

service_provider: str | None: Name of the service provider providing call recording service.

external_group: str | None: Group utilized by the service provider providing call recording service

external_identifier: str | None: Unique person identifier utilized by the service provider providing call recording service.

start_stop_announcement: StartStopAnnouncement | None: Call Recording starts and stops announcement settings.

call_recording_access_settings: CallRecordingAccessSettings | None: Settings related to call recording access.

post_call_recording_settings: PostCallRecordingSettings | None

undocumented, issue 201

Type:: TODO

announcements: CallRecordingAnnouncements | None: Announcement settings

static default() → CallRecordingSetting[source]: Default settings for a user

class wxc_sdk.person_settings.call_recording.StartStopAnnouncement(*, internalCallsEnabled: bool | None = None, pstnCallsEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

Call Recording starts and stops announcement settings.

internal_calls_enabled: bool | None: When true, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls.

pstn_calls_enabled: bool | None: When true, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls.

class wxc_sdk.person_settings.call_recording.CallRecordingAccessSettings(*, viewAndPlayRecordingsEnabled: bool | None = None, downloadRecordingsEnabled: bool | None = None, deleteRecordingsEnabled: bool | None = None, shareRecordingsEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

view_and_play_recordings_enabled: bool | None: When true, the person can view and play call recordings.

download_recordings_enabled: bool | None: When true, the person can download call recordings.

delete_recordings_enabled: bool | None: When true, the person can delete call recordings.

share_recordings_enabled: bool | None: When true, the person can share call recordings.

class wxc_sdk.person_settings.call_recording.PostCallRecordingSettings(*, summaryAndActionItemsEnabled: bool | None = None, transcriptEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

summary_and_action_items_enabled: bool | None

transcript_enabled: bool | None

class wxc_sdk.person_settings.call_recording.CallRecordingAnnouncement(*, type: Greeting | None = None, audioAnnouncementFile: AnnAudioFile | None = None, **extra_data: Any)[source]

Bases: ApiModel

type: Greeting | None: Type of announcement to play when call recording starts.

audio_announcement_file: AnnAudioFile | None

class wxc_sdk.person_settings.call_recording.CallRecordingAnnouncements(*, useLocationLevelEnabled: bool | None = None, start: CallRecordingAnnouncement | None = None, stop: CallRecordingAnnouncement | None = None, pause: CallRecordingAnnouncement | None = None, resume: CallRecordingAnnouncement | None = None, failureEndWithCall: CallRecordingAnnouncement | None = None, failureProceedWithCall: CallRecordingAnnouncement | None = None, **extra_data: Any)[source]

Bases: ApiModel

use_location_level_enabled: bool | None: When true, the location level custom announcement settings are used. When false, queue custom announcement settings are used.

start: CallRecordingAnnouncement | None: The start announcement settings for this queue.

stop: CallRecordingAnnouncement | None: The stop announcement settings for this queue.

pause: CallRecordingAnnouncement | None: The pause announcement settings for this queue.

resume: CallRecordingAnnouncement | None: The resume announcement settings for this queue.

failure_end_with_call: CallRecordingAnnouncement | None: The failure end with call announcement settings for this queue.

failure_proceed_with_call: CallRecordingAnnouncement | None: The failure proceed with call announcement settings for this queue.

class wxc_sdk.person_settings.call_recording.CallRecordingApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for recording settings

Also used for virtual lines, workspaces

feature: str | None = 'callRecording'

read(entity_id: str, org_id: str = None) → CallRecordingSetting[source]

Read Call Recording Settings

Retrieve Call Recording Settings

The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

This API requires a full or user administrator auth token with the spark-admin:people_write scope.

Parameters:

entity_id (str) – Unique identifier for the entity.
org_id (str) – entity is in this organization. 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.

configure(entity_id: str, recording: CallRecordingSetting, org_id: str = None)[source]

Configure Call Recording Settings for a entity

Configure Call Recording Settings

The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

This API requires a full or user administrator auth token with the spark-admin:people_write scope.

Parameters:

entity_id (str) – Unique identifier for the entity.
recording (CallRecordingSetting) – the new recording settings
org_id (str) – entity is in this organization. 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.

base = ''