Skip to content

GroupCallCenterEnhancedReportingScheduledReportAddRequest

Bases: OCIRequest

Request to add a group level call center reporting scheduled report. The response is either a SuccessResponse or an ErrorResponse. The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate.

Attributes:

service_provider_id (str):

group_id (str):

name (str):

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[CallCenterScheduledReportAgentSelection]):

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/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterEnhancedReportingScheduledReportAddRequest(OCIRequest):
    """Request to add a group level call center reporting scheduled report.
        The response is either a SuccessResponse or an ErrorResponse.
        The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate.

    Attributes:

        service_provider_id (str):

        group_id (str):

        name (str):

        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[CallCenterScheduledReportAgentSelection]):

        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]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

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

    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[CallCenterScheduledReportAgentSelection] = 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"})

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

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

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupCallCenterEnhancedReportingScheduledReportAddRequest

client = Client()

command = GroupCallCenterEnhancedReportingScheduledReportAddRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
    description=...,
    report_template=...,
    schedule=...,
    sampling_period=...,
    start_day_of_week=...,
    report_time_zone=...,
    report_date_format=...,
    report_time_format=...,
    report_interval=...,
    report_format=...,
    agent=...,
    call_center=...,
    dnis=...,
    call_completion_threshold_seconds=...,
    short_duration_threshold_seconds=...,
    service_level_threshold_seconds=...,
    service_level_inclusions=...,
    service_level_objective_percentage=...,
    abandoned_call_threshold_seconds=...,
    email_address=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterEnhancedReportingScheduledReportAddRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
    description=...,
    report_template=...,
    schedule=...,
    sampling_period=...,
    start_day_of_week=...,
    report_time_zone=...,
    report_date_format=...,
    report_time_format=...,
    report_interval=...,
    report_format=...,
    agent=...,
    call_center=...,
    dnis=...,
    call_completion_threshold_seconds=...,
    short_duration_threshold_seconds=...,
    service_level_threshold_seconds=...,
    service_level_inclusions=...,
    service_level_objective_percentage=...,
    abandoned_call_threshold_seconds=...,
    email_address=...,
)

print(response)