wxc_sdk.person_settings.call_recording module

Call recording API

class wxc_sdk.person_settings.call_recording.Record(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

always = 'Always': Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.

never = 'Never': Calls will not be recorded.

always_w_pause_resume = 'Always with Pause/Resume': Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.

on_demand = 'On Demand with User Initiated Start': Records only the portion of the call after the recording start (*44) has been entered. Pause, resume, and stop controls are supported.

class wxc_sdk.person_settings.call_recording.NotificationType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[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)[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)[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, record: Record, recordVoicemailEnabled: bool, startStopAnnouncementEnabled: bool, notification: Notification, repeat: NotificationRepeat, serviceProvider: str | None = None, externalGroup: str | None = None, externalIdentifier: str | None = None, startStopAnnouncement: StartStopAnnouncement | None = None)[source]

Bases: ApiModel

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

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

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

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

notification: Notification: Pause/resume notification settings.

repeat: NotificationRepeat: 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.

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)[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.CallRecordingApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for recording settings

Also used for virtual lines, workspaces

feature = 'callRecording'

read(entity_id: str, org_id: str | None = 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 = 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 = ''