wxc_sdk.telephony.cx_essentials.callqueue_recording package

class wxc_sdk.telephony.cx_essentials.callqueue_recording.QueueCallRecordingSettingsApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Queue Call Recording Settings

Queue Call Settings supports modifying Webex Calling settings for a specific queue.

Viewing Queue recording settings requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read or, for select APIs, a user auth token with spark:people_read scope can be used by a person to read their own settings.

Configuring Queue recording settings requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope or, for select APIs, a user auth token with spark:people_write scope can be used by a person to update their own settings.

Call Queue Recording Settings API access can be restricted via Control Hub by a full administrator. Restricting access causes the APIs to throw a 403 Access Forbidden error.

See details about features available by license type for Webex Calling.

read(location_id: str, queue_id: str, org_id: str = None) → CallRecordingSetting[source]

Read Queue Call Recording Settings for a Queue

Retrieve a queue’s 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 or location administrator auth token with the spark-admin:people_read scope.

A person with a Webex Calling Standard license is eligible for the Call Recording feature only when the Call Recording vendor is Webex.

Parameters:

  • location_id (str) – Unique identifier for the location.

  • queue_id (str) – Unique identifier for the queue.

  • org_id (str) – ID of the organization in which the queue resides. 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.

Return type:

CallRecordingSetting

configure(location_id: str, queue_id: str, recording: CallRecordingSetting, org_id: str = None)[source]

Configure Queue Call Recording Settings for a Queue

Configure a queue’s 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 or location administrator auth token with the spark-admin:people_write scope.

<div><Callout type=”warning”>A person with a Webex Calling Standard license is eligible for the Call Recording feature only when the Call Recording vendor is Webex.</Callout></div>

Parameters:

  • location_id (str) – Unique identifier for the location.

  • queue_id (str) – Unique identifier for the queue.

  • recording (CallRecordingSetting) – the new recording settings

  • org_id (str) – ID of the organization in which the queue resides. 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.

Return type:

None

base = 'telephony/config/locations'