wxc_sdk.telephony.call_recording package

class wxc_sdk.telephony.call_recording.CallRecordingInfo(*, organization: IdAndName | None = None, enabled: bool | None = None, vendorId: str | None = None, vendorName: str | None = None, termsOfServiceUrl: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

organization: IdAndName | None

Details of the organization.

enabled: bool | None

Whether or not the call recording is enabled.

vendor_id: str | None

A unique identifier for the vendor.

vendor_name: str | None

A unique name for the vendor.

terms_of_service_url: str | None

Url where can be found terms of service for the vendor.

NOTE: This is expected to be empty for Webex Recording Platform.

class wxc_sdk.telephony.call_recording.CallRecordingTermsOfService(*, vendorId: str | None = None, vendorName: str | None = None, termsOfServiceEnabled: bool | None = None, termsOfServiceUrl: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

vendor_id: str | None

A unique identifier for the vendor.

vendor_name: str | None

A unique name for the vendor.

terms_of_service_enabled: bool | None

Whether or not the call recording terms of service are enabled.

terms_of_service_url: str | None

Url where can be found terms of service for the vendor.

NOTE: This is expected to be empty for Webex Recording Platform.

class wxc_sdk.telephony.call_recording.OrgComplianceAnnouncement(*, inboundPSTNCallsEnabled: bool | None = None, outboundPSTNCallsEnabled: bool | None = None, outboundPSTNCallsDelayEnabled: bool | None = None, delayInSeconds: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

inbound_pstncalls_enabled: bool | None

Flag to indicate whether the Call Recording START/STOP announcement is played to an inbound caller.

outbound_pstncalls_enabled: bool | None

Flag to indicate whether the Call Recording START/STOP announcement is played to an outbound caller.

outbound_pstncalls_delay_enabled: bool | None

Flag to indicate whether compliance announcement is played after a specified delay in seconds.

delay_in_seconds: int | None

Number of seconds to wait before playing the compliance announcement.

class wxc_sdk.telephony.call_recording.LocationComplianceAnnouncement(*, inboundPSTNCallsEnabled: bool | None = None, outboundPSTNCallsEnabled: bool | None = None, outboundPSTNCallsDelayEnabled: bool | None = None, delayInSeconds: int | None = None, useOrgSettingsEnabled: bool | None = None, **extra_data: Any)[source]

Bases: OrgComplianceAnnouncement

use_org_settings_enabled: bool | None

Flag to indicate whether to use the customer level compliance announcement default settings.

class wxc_sdk.telephony.call_recording.CallRecordingRegion(*, code: str | None = None, name: str | None = None, defaultEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

code: str | None

Two character region code.

name: str | None

Name of the region.

default_enabled: bool | None

Enabled by default.

class wxc_sdk.telephony.call_recording.RecordingUser(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, type: UserType | None = None, licenseType: UserLicenseType | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier of the member.

last_name: str | None

Last name of the member.

first_name: str | None

First name of the member.

type: UserType | None

Type of member.

license_type: UserLicenseType | None

License type of the member.

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

Bases: str, SafeEnum

An enumeration.

proceed_with_call_no_announcement = 'PROCEED_WITH_CALL_NO_ANNOUNCEMENT'

Failure behavior will make sure that the call proceeds without announcement.

proceed_call_with_announcement = 'PROCEED_CALL_WITH_ANNOUNCEMENT'

Failure behavior will make sure that the call proceeds with an announcement.

end_call_with_announcement = 'END_CALL_WITH_ANNOUNCEMENT'

Failure behavior will make sure that the call ends with an announcement.

class wxc_sdk.telephony.call_recording.RecordingVendor(*, id: str | None = None, name: str | None = None, description: str | None = None, migrateUserCreationEnabled: bool | None = None, loginUrl: str | None = None, termsOfServiceUrl: 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.

description: str | None

Describing some vendor info.

migrate_user_creation_enabled: bool | None

Users can be migrated.

login_url: str | None

Login URL of the vendor.

terms_of_service_url: str | None

URL to vendor’s terms of service.

class wxc_sdk.telephony.call_recording.CallRecordingVendors(*, vendorId: str | None = None, vendorName: str | None = None, vendors: list[RecordingVendor] | None = None, storageRegion: str | None = None, failureBehavior: FailureBehavior | None = None, **extra_data: Any)[source]

Bases: ApiModel

vendor_id: str | None

Unique identifier of the vendor.

vendor_name: str | None

Name of the vendor.

vendors: list[RecordingVendor] | None

List of call recording vendors

storage_region: str | None

Call recording storage region. Only applicable for Webex as a vendor and isn’t used for other vendors.

failure_behavior: FailureBehavior | None

Call recording failure behavior.

class wxc_sdk.telephony.call_recording.CallRecordingLocationVendors(*, orgDefaultEnabled: bool | None = None, orgDefaultVendorId: str | None = None, orgDefaultVendorName: str | None = None, defaultVendorId: str | None = None, defaultVendorName: str | None = None, vendors: list[RecordingVendor] | None = None, orgStorageRegionEnabled: bool | None = None, orgStorageRegion: str | None = None, storageRegion: str | None = None, orgFailureBehaviorEnabled: bool | None = None, orgFailureBehavior: FailureBehavior | None = None, failureBehavior: FailureBehavior | None = None, **extra_data: Any)[source]

Bases: ApiModel

org_default_enabled: bool | None

Default call recording is enabled.

org_default_vendor_id: str | None

Unique identifier of a vendor.

org_default_vendor_name: str | None

Name of the call recording vendor.

default_vendor_id: str | None

Unique identifier of a vendor.

default_vendor_name: str | None

Name of the call recording vendor.

vendors: list[RecordingVendor] | None

List of available vendors and their details.

org_storage_region_enabled: bool | None

Region-based storage is enabled.

org_storage_region: str | None

Org level two character Region code.

storage_region: str | None

Location level character Region code.

org_failure_behavior_enabled: bool | None

Failure behavior is enabled.

org_failure_behavior: FailureBehavior | None

Type of org-level failure behavior.

failure_behavior: FailureBehavior | None

Type of location level failure behavior.

class wxc_sdk.telephony.call_recording.CallRecordingSettingsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Features: Call Recording

Not supported for Webex for Government (FedRAMP)

Features: Call Recording supports reading and writing of Webex Calling Call Recording settings for a specific organization.

Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

A partner administrator can retrieve or change settings in a customer’s organization using the optional orgId query parameter.

read(org_id: str | None = None) → CallRecordingInfo[source]

Get Call Recording Settings

Retrieve call recording settings for the organization.

The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

Retrieving call recording settings requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

org_id (str) – Retrieve call recording settings from this organization.

Return type:

CallRecordingInfo

update(enabled: bool, org_id: str | None = None)[source]

Update Call Recording Settings

Update call recording settings for the organization.

The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

Updating call recording settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

NOTE: This API is for Cisco partners only.

Parameters:

  • enabled (bool) – Whether or not the call recording is enabled.

  • org_id (str) – Retrieve call recording settings from this organization.

Return type:

None

read_terms_of_service(vendor_id: str, org_id: str | None = None) → CallRecordingTermsOfService[source]

Get Call Recording Terms Of Service Settings

Retrieve call recording terms of service settings for the organization.

The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

Retrieving call recording terms of service settings requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • vendor_id (str) – Retrieve call recording terms of service details for the given vendor.

  • org_id (str) – Retrieve call recording terms of service details from this organization.

Return type:

CallRecordingTermsOfService

update_terms_of_service(vendor_id: str, enabled: bool, org_id: str | None = None)[source]

Update Call Recording Terms Of Service Settings

Update call recording terms of service settings for the given vendor.

The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

Updating call recording terms of service settings requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • vendor_id (str) – Update call recording terms of service settings for the given vendor.

  • enabled (bool) – Whether or not the call recording terms of service are enabled.

  • org_id (str) – Update call recording terms of service settings from this organization.

Return type:

None

read_org_compliance_announcement(org_id: str | None = None) → OrgComplianceAnnouncement[source]

Get details for the organization Compliance Announcement Setting

Retrieve the organization compliance announcement settings.

The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.

Retrieving organization compliance announcement setting requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

org_id (str) – Retrieve compliance announcement setting from this organization.

Return type:

OrgComplianceAnnouncement

update_org_compliance_announcement(settings: OrgComplianceAnnouncement, org_id: str | None = None)[source]

Update the organization compliance announcement

The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.

Updating the organization compliance announcement requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • settings (OrgComplianceAnnouncement) – new settings

  • org_id (str) – Update the compliance announcement setting from this organization.

Return type:

None

read_location_compliance_announcement(location_id: str, org_id: str | None = None) → LocationComplianceAnnouncement[source]

Get details for the Location Compliance Announcement Setting

Retrieve the location compliance announcement settings.

The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.

Retrieving location compliance announcement setting requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Retrieve compliance announcement settings for this location.

  • org_id (str) – Retrieve compliance announcement setting from this organization.

Return type:

LocationComplianceAnnouncement

update_location_compliance_announcement(location_id: str, settings: LocationComplianceAnnouncement, org_id: str | None = None)[source]

Update the location compliance announcement

The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.

Updating the location compliance announcement requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Update the compliance announcement settings for this location.

  • settings (LocationComplianceAnnouncement) – new settings

  • org_id (str) – Update the compliance announcement setting from this organization.

Return type:

None

get_call_recording_regions(org_id: str | None = None) → list[CallRecordingRegion][source]

Get Call Recording Regions

Retrieve all the call recording regions that are available for an organization.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

org_id (str) – Retrieve call recording regions for this organization.

Return type:

list[Regions]

list_org_users(standard_user_only: bool | None = None, org_id: str | None = None, **params) → Generator[RecordingUser, None, None][source]

Get Call Recording Vendor Users

Retrieve call recording vendor users of an organization. This API is used to get the list of users who are assigned to the default call-recording vendor of the organization.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • standard_user_only (bool) – If true, results only include Webex Calling standard users.

  • org_id (str) – Retrieve call recording vendor users for this organization.

set_location_vendor(location_id: str, id: str | None = None, org_default_enabled: bool | None = None, storage_region: str | None = None, org_storage_region_enabled: bool | None = None, failure_behavior: FailureBehavior | None = None, org_failure_behavior_enabled: bool | None = None, org_id: str | None = None) → str[source]

Set Call Recording Vendor for a Location

Assign a call recording vendor to a location of an organization. Response will be 204 if the changes can be applied immediatley otherwise 200 with a job ID is returned.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Update the call recording vendor for this location

  • id (str) – Unique identifier of the call recording vendor.

  • org_default_enabled (bool) – Vendor is enabled by default.

  • storage_region (str) – Regions where call recordings are stored.

  • org_storage_region_enabled (bool) – Region-based call recording storage is enabled.

  • failure_behavior (FailureBehavior) – Type of failure behavior.

  • org_failure_behavior_enabled (bool) – Failure behavior is enabled.

  • org_id (str) – Update the call recording vendor for this organization.

Return type:

str

get_location_vendors(location_id: str, org_id: str | None = None) → CallRecordingLocationVendors[source]

Get Location Call Recording Vendors

Retrieve details of the call recording vendor that the location is assigned and also a list of vendors.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

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

  • org_id (str) – Retrieve vendor details for this organization.

Return type:

CallRecordingLocationVendors

list_location_users(location_id: str, standard_user_only: bool | None = None, org_id: str | None = None, **params) → Generator[RecordingUser, None, None][source]

Get Call Recording Vendor Users for a Location

Retrieve call recording vendor users of a location. This API is used to get the list of users assigned to the call recording vendor of the location.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Retrieve vendor users for this location.

  • standard_user_only (bool) – If true, results only include Webex Calling standard users.

  • org_id (str) – Retrieve vendor users for this organization.

get_org_vendors(org_id: str | None = None) → CallRecordingVendors[source]

Get Organization Call Recording Vendors

Returns what the current vendor is as well as a list of all the available vendors.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

org_id (str) – Retrieve call recording settings from this organization.

Return type:

CallRecordingVendors

set_org_vendor(vendor_id: str, storage_region: str | None = None, failure_behavior: FailureBehavior | None = None, org_id: str | None = None) → str[source]

Set Organization Call Recording Vendor

Returns a Job ID that you can use to get the status of the job.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full administrator auth token with a scope of spark-admin:telephony_config_write, spark-admin:telephony_config_read, and spark-admin:people_write.

Parameters:

  • vendor_id (str) – Unique identifier of the vendor.

  • storage_region (str) – Call recording storage region. Only applicable for Webex as a vendor and isn’t used for other vendors.

  • failure_behavior (FailureBehavior) – Call recording failure behavior.

  • org_id (str) – Modify call recording settings from this organization.

Return type:

str

base = 'telephony/config'