Skip to content

GroupRoutePointOverflowGetRequest20

Bases: OCIRequest

Get a route point's overflow settings. The response is either a GroupRoutePointOverflowGetResponse20 or an ErrorResponse.

Attributes:

service_user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointOverflowGetRequest20(OCIRequest):
    """Get a route point's overflow settings.
        The response is either a GroupRoutePointOverflowGetResponse20 or an ErrorResponse.

    Attributes:

        service_user_id (str):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

Responses

Bases: OCIDataResponse

Response to the GroupRoutePointOverflowGetRequest20.

Attributes:

action (str):

transfer_phone_number (Optional[str]):

overflow_after_timeout (bool):

timeout_seconds (int):

play_announcement_before_overflow_processing (bool):

audio_message_selection (str):

audio_url_list (Optional[CallCenterAnnouncementURLList]):

audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

video_message_selection (Optional[str]):

video_url_list (Optional[CallCenterAnnouncementURLList]):

video_file_list (Optional[CallCenterAnnouncementFileListRead20]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointOverflowGetResponse20(OCIDataResponse):
    """Response to the GroupRoutePointOverflowGetRequest20.

    Attributes:

        action (str):

        transfer_phone_number (Optional[str]):

        overflow_after_timeout (bool):

        timeout_seconds (int):

        play_announcement_before_overflow_processing (bool):

        audio_message_selection (str):

        audio_url_list (Optional[CallCenterAnnouncementURLList]):

        audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        video_message_selection (Optional[str]):

        video_url_list (Optional[CallCenterAnnouncementURLList]):

        video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

    """

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

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

    overflow_after_timeout: bool = field(metadata={"alias": "overflowAfterTimeout"})

    timeout_seconds: int = field(metadata={"alias": "timeoutSeconds"})

    play_announcement_before_overflow_processing: bool = field(
        metadata={"alias": "playAnnouncementBeforeOverflowProcessing"}
    )

    audio_message_selection: str = field(metadata={"alias": "audioMessageSelection"})

    audio_url_list: Optional[CallCenterAnnouncementURLList] = field(
        default=None, metadata={"alias": "audioUrlList"}
    )

    audio_file_list: Optional[CallCenterAnnouncementFileListRead20] = field(
        default=None, metadata={"alias": "audioFileList"}
    )

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

    video_url_list: Optional[CallCenterAnnouncementURLList] = field(
        default=None, metadata={"alias": "videoUrlList"}
    )

    video_file_list: Optional[CallCenterAnnouncementFileListRead20] = field(
        default=None, metadata={"alias": "videoFileList"}
    )

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 GroupRoutePointOverflowGetRequest20

client = Client()

command = GroupRoutePointOverflowGetRequest20(
    service_user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupRoutePointOverflowGetRequest20",
    service_user_id=...,
)

print(response)