wxc_sdk.me.recording package

class wxc_sdk.me.recording.MeRecordingApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

settings() → MeRecordingSettings[source]

Get My Call Recording Settings

Get details of call recording settings associated with the authenticated user.

Call recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:: MeRecordingSettings

base = 'telephony/config/people/me'

class wxc_sdk.me.recording.MeRecordingSettings(*, enabled: bool | None = None, vendor: MeRecordingVendor | None = None, recordingMode: Record | None = None, pauseResumeNotifyMethod: NotificationType | None = None, announcementEnabled: bool | None = None, warningToneEnabled: bool | None = None, warningToneDuration: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None: Indicates whether Call Recording is enabled for the user or not.

vendor: MeRecordingVendor | None: List of available vendors and their details.

recording_mode: Record | None

pause_resume_notify_method: NotificationType | None

announcement_enabled: bool | None: If true, an announcement is played when call recording starts.

warning_tone_enabled: bool | None: If true, a warning tone is played when call recording starts.

warning_tone_duration: int | None: Duration of the warning tone in seconds. Duration can be configured between 10 and 1800 seconds.

class wxc_sdk.me.recording.MeRecordingVendor(*, id: str | None = None, name: str | None = None, loginUrl: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None: Unique identifier of a vendor.

name: str | None: Name of a call recording vendor.

login_url: str | None: Login URL of the vendor.