Skip to content

UserCallCenterEnhancedReportingScheduledReportGetRequest

Bases: OCIRequest

Request to get a call center reporting scheduled report created by supervisor. The response is either a UserCallCenterEnhancedReportingScheduledReportGetResponse or an ErrorResponse.

Attributes:

supervisor_user_id (str):

name (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterEnhancedReportingScheduledReportGetRequest(OCIRequest):
    """Request to get a call center reporting scheduled report created by supervisor.
        The response is either a UserCallCenterEnhancedReportingScheduledReportGetResponse or an ErrorResponse.

    Attributes:

        supervisor_user_id (str):

        name (str):

    """

    supervisor_user_id: str = field(metadata={"alias": "supervisorUserId"})

    name: str = field(metadata={"alias": "name"})

Responses

Bases: OCIDataResponse

Response to UserCallCenterEnhancedReportingScheduledReportGetRequest.

Attributes:

description (Optional[str]):

report_template (CallCenterReportTemplateKey):

schedule (CallCenterReportSchedule):

sampling_period (Optional[str]):

start_day_of_week (Optional[str]):

report_time_zone (str):

report_date_format (str):

report_time_format (str):

report_interval (CallCenterReportInterval):

report_format (str):

agent (Optional[CallCenterScheduledReportAgentSelectionRead]):

call_center (Optional[CallCenterScheduledReportCallCenterSelection]):

dnis (Optional[CallCenterScheduledReportDNISSelection]):

call_completion_threshold_seconds (Optional[int]):

short_duration_threshold_seconds (Optional[int]):

service_level_threshold_seconds (Optional[List[int]]):

service_level_inclusions (Optional[CallCenterScheduledReportServiceLevelInclusions]):

service_level_objective_percentage (Optional[int]):

abandoned_call_threshold_seconds (Optional[List[int]]):

email_address (List[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterEnhancedReportingScheduledReportGetResponse(OCIDataResponse):
    """Response to UserCallCenterEnhancedReportingScheduledReportGetRequest.

    Attributes:

        description (Optional[str]):

        report_template (CallCenterReportTemplateKey):

        schedule (CallCenterReportSchedule):

        sampling_period (Optional[str]):

        start_day_of_week (Optional[str]):

        report_time_zone (str):

        report_date_format (str):

        report_time_format (str):

        report_interval (CallCenterReportInterval):

        report_format (str):

        agent (Optional[CallCenterScheduledReportAgentSelectionRead]):

        call_center (Optional[CallCenterScheduledReportCallCenterSelection]):

        dnis (Optional[CallCenterScheduledReportDNISSelection]):

        call_completion_threshold_seconds (Optional[int]):

        short_duration_threshold_seconds (Optional[int]):

        service_level_threshold_seconds (Optional[List[int]]):

        service_level_inclusions (Optional[CallCenterScheduledReportServiceLevelInclusions]):

        service_level_objective_percentage (Optional[int]):

        abandoned_call_threshold_seconds (Optional[List[int]]):

        email_address (List[str]):

    """

    description: Optional[str] = field(default=None, metadata={"alias": "description"})

    report_template: CallCenterReportTemplateKey = field(
        metadata={"alias": "reportTemplate"}
    )

    schedule: CallCenterReportSchedule = field(metadata={"alias": "schedule"})

    sampling_period: Optional[str] = field(
        default=None, metadata={"alias": "samplingPeriod"}
    )

    start_day_of_week: Optional[str] = field(
        default=None, metadata={"alias": "startDayOfWeek"}
    )

    report_time_zone: str = field(metadata={"alias": "reportTimeZone"})

    report_date_format: str = field(metadata={"alias": "reportDateFormat"})

    report_time_format: str = field(metadata={"alias": "reportTimeFormat"})

    report_interval: CallCenterReportInterval = field(
        metadata={"alias": "reportInterval"}
    )

    report_format: str = field(metadata={"alias": "reportFormat"})

    agent: Optional[CallCenterScheduledReportAgentSelectionRead] = field(
        default=None, metadata={"alias": "agent"}
    )

    call_center: Optional[CallCenterScheduledReportCallCenterSelection] = field(
        default=None, metadata={"alias": "callCenter"}
    )

    dnis: Optional[CallCenterScheduledReportDNISSelection] = field(
        default=None, metadata={"alias": "dnis"}
    )

    call_completion_threshold_seconds: Optional[int] = field(
        default=None, metadata={"alias": "callCompletionThresholdSeconds"}
    )

    short_duration_threshold_seconds: Optional[int] = field(
        default=None, metadata={"alias": "shortDurationThresholdSeconds"}
    )

    service_level_threshold_seconds: Optional[List[int]] = field(
        default=None, metadata={"alias": "serviceLevelThresholdSeconds"}
    )

    service_level_inclusions: Optional[
        CallCenterScheduledReportServiceLevelInclusions
    ] = field(default=None, metadata={"alias": "serviceLevelInclusions"})

    service_level_objective_percentage: Optional[int] = field(
        default=None, metadata={"alias": "serviceLevelObjectivePercentage"}
    )

    abandoned_call_threshold_seconds: Optional[List[int]] = field(
        default=None, metadata={"alias": "abandonedCallThresholdSeconds"}
    )

    email_address: List[str] = field(metadata={"alias": "emailAddress"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserCallCenterEnhancedReportingScheduledReportGetRequest

client = Client()

command = UserCallCenterEnhancedReportingScheduledReportGetRequest(
    supervisor_user_id=...,
    name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCallCenterEnhancedReportingScheduledReportGetRequest",
    supervisor_user_id=...,
    name=...,
)

print(response)