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)[source]

Bases: ApiModel

organization: IdAndName | None

Details of the organization.

enabled: bool | None

Whether or not the call recording is enabled. example: True

vendor_id: str | None

A unique identifier for the vendor. example: Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw

vendor_name: str | None

A unique name for the vendor. example: Dubber

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. example: https://www.dubber.net/terms

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

Bases: ApiModel

vendor_id: str | None

A unique identifier for the vendor. example: Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw

vendor_name: str | None

A unique name for the vendor. example: Dubber

terms_of_service_enabled: bool | None

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

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. example: https://www.dubber.net/terms example: https://www.dubber.net/terms

class wxc_sdk.telephony.call_recording.OrgComplianceAnnouncement(*, inboundPSTNCallsEnabled: bool | None = None, outboundPSTNCallsEnabled: bool | None = None, outboundPSTNCallsDelayEnabled: bool | None = None, delayInSeconds: int | None = None)[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)[source]

Bases: OrgComplianceAnnouncement

use_org_settings_enabled: bool | None

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

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.

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.

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.

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.

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

base = 'telephony/config'