Skip to content

GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest

Bases: OCIRequest

Request to get all enabled call center report template for a group. The response is either a GroupCallCenterEnhancedReportingGetAvailableReportTemplateListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest(OCIRequest):
    """Request to get all enabled call center report template for a group.
        The response is either a GroupCallCenterEnhancedReportingGetAvailableReportTemplateListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

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

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

Responses

Bases: OCIDataResponse

Response to GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest. Contains a table with column headings: "Name", "Description" and "Level", "Is Agent Required", "Is Call Center Required", "Is Call Center Dnis Required","Is Real Time Report", "Is Sampling Period Required", "Call Completion Threshold Parameter", "Short Duration Threshold Parameter", "Service Level Threshold Parameter", "Service Level Inclusions Parameter", "Service Level Objective Threshold Parameter", "Abandoned Call Threshold Parameter", "Service Level Threshold Parameter Number", and "Abandoned Call Threshold Parameter Number". The possible values for "Level" are "System" and "Group". The possible values for "Is Agent Required", "Is Call Center Required", "Is Call Center Dnis Required", "Is Real Time Report" and "Is Sampling Period Required" are "true" and "false". The possible values for "Call Completion Threshold Parameter", "Short Duration Threshold Parameter", "Service Level Threshold Parameter", "Service Level Inclusions Parameter","Service Level Objective Threshold Parameter" and "Abandoned Call Threshold Parameter" are "Required", "Hidden" and "Does Not Apply".

Attributes:

report_template_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterEnhancedReportingGetAvailableReportTemplateListResponse(
    OCIDataResponse
):
    """Response to GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest.
        Contains a table with column headings: \"Name\", \"Description\" and \"Level\", \"Is Agent Required\",
        \"Is Call Center Required\", \"Is Call Center Dnis Required\",\"Is Real Time Report\", \"Is Sampling Period Required\",
        \"Call Completion Threshold Parameter\", \"Short Duration Threshold Parameter\",
        \"Service Level Threshold Parameter\", \"Service Level Inclusions Parameter\", \"Service Level Objective Threshold Parameter\",
        \"Abandoned Call Threshold Parameter\", \"Service Level Threshold Parameter Number\",
        and \"Abandoned Call Threshold Parameter Number\".
        The possible values for \"Level\" are \"System\" and \"Group\".
        The possible values for \"Is Agent Required\", \"Is Call Center Required\", \"Is Call Center Dnis Required\",
        \"Is Real Time Report\" and \"Is Sampling Period Required\" are \"true\" and \"false\".
        The possible values for \"Call Completion Threshold Parameter\", \"Short Duration Threshold Parameter\",
        \"Service Level Threshold Parameter\", \"Service Level Inclusions Parameter\",\"Service Level Objective Threshold Parameter\"
        and \"Abandoned Call Threshold Parameter\" are \"Required\", \"Hidden\" and \"Does Not Apply\".

    Attributes:

        report_template_table (OCITable):

    """

    report_template_table: OCITable = field(metadata={"alias": "reportTemplateTable"})

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 GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest

client = Client()

command = GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)