Skip to content

GroupCallCenterGetAnnouncementRequest22

Bases: OCIRequest

Get a call center's announcement settings. The response is either a GroupCallCenterGetAnnouncementResponse22 or an ErrorResponse.

Attributes:

service_user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterGetAnnouncementRequest22(OCIRequest):
    """Get a call center's announcement settings.
        The response is either a GroupCallCenterGetAnnouncementResponse22 or an ErrorResponse.

    Attributes:

        service_user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the GroupCallCenterGetAnnouncementRequest22.

Attributes:

play_entrance_message (bool):

mandatory_entrance_message (bool):

entrance_audio_message_selection (str):

entrance_message_audio_url_list (Optional[CallCenterAnnouncementURLList]):

entrance_message_audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

entrance_video_message_selection (Optional[str]):

entrance_message_video_url_list (Optional[CallCenterAnnouncementURLList]):

entrance_message_video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

play_periodic_comfort_message (bool):

time_between_comfort_messages_seconds (int):

periodic_comfort_audio_message_selection (str):

periodic_comfort_message_audio_url_list (Optional[CallCenterAnnouncementURLList]):

periodic_comfort_message_audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

periodic_comfort_video_message_selection (Optional[str]):

periodic_comfort_message_video_url_list (Optional[CallCenterAnnouncementURLList]):

periodic_comfort_message_video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

enable_media_on_hold_for_queued_calls (bool):

media_on_hold_source (CallCenterMediaOnHoldSourceRead22):

media_on_hold_use_alternate_source_for_internal_calls (Optional[bool]):

media_on_hold_internal_source (Optional[CallCenterMediaOnHoldSourceRead22]):

play_whisper_message (Optional[bool]):

whisper_audio_message_selection (Optional[str]):

whisper_message_audio_url_list (Optional[CallCenterAnnouncementURLList]):

whisper_message_audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

whisper_video_message_selection (Optional[str]):

whisper_message_video_url_list (Optional[CallCenterAnnouncementURLList]):

whisper_message_video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

estimated_wait_message_options_read (EstimatedWaitMessageOptionsRead17sp4):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterGetAnnouncementResponse22(OCIDataResponse):
    """Response to the GroupCallCenterGetAnnouncementRequest22.

    Attributes:

        play_entrance_message (bool):

        mandatory_entrance_message (bool):

        entrance_audio_message_selection (str):

        entrance_message_audio_url_list (Optional[CallCenterAnnouncementURLList]):

        entrance_message_audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        entrance_video_message_selection (Optional[str]):

        entrance_message_video_url_list (Optional[CallCenterAnnouncementURLList]):

        entrance_message_video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        play_periodic_comfort_message (bool):

        time_between_comfort_messages_seconds (int):

        periodic_comfort_audio_message_selection (str):

        periodic_comfort_message_audio_url_list (Optional[CallCenterAnnouncementURLList]):

        periodic_comfort_message_audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        periodic_comfort_video_message_selection (Optional[str]):

        periodic_comfort_message_video_url_list (Optional[CallCenterAnnouncementURLList]):

        periodic_comfort_message_video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        enable_media_on_hold_for_queued_calls (bool):

        media_on_hold_source (CallCenterMediaOnHoldSourceRead22):

        media_on_hold_use_alternate_source_for_internal_calls (Optional[bool]):

        media_on_hold_internal_source (Optional[CallCenterMediaOnHoldSourceRead22]):

        play_whisper_message (Optional[bool]):

        whisper_audio_message_selection (Optional[str]):

        whisper_message_audio_url_list (Optional[CallCenterAnnouncementURLList]):

        whisper_message_audio_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        whisper_video_message_selection (Optional[str]):

        whisper_message_video_url_list (Optional[CallCenterAnnouncementURLList]):

        whisper_message_video_file_list (Optional[CallCenterAnnouncementFileListRead20]):

        estimated_wait_message_options_read (EstimatedWaitMessageOptionsRead17sp4):

    """

    play_entrance_message: bool = field(metadata={"alias": "playEntranceMessage"})

    mandatory_entrance_message: bool = field(
        metadata={"alias": "mandatoryEntranceMessage"}
    )

    entrance_audio_message_selection: str = field(
        metadata={"alias": "entranceAudioMessageSelection"}
    )

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

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

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

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

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

    play_periodic_comfort_message: bool = field(
        metadata={"alias": "playPeriodicComfortMessage"}
    )

    time_between_comfort_messages_seconds: int = field(
        metadata={"alias": "timeBetweenComfortMessagesSeconds"}
    )

    periodic_comfort_audio_message_selection: str = field(
        metadata={"alias": "periodicComfortAudioMessageSelection"}
    )

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

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

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

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

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

    enable_media_on_hold_for_queued_calls: bool = field(
        metadata={"alias": "enableMediaOnHoldForQueuedCalls"}
    )

    media_on_hold_source: CallCenterMediaOnHoldSourceRead22 = field(
        metadata={"alias": "mediaOnHoldSource"}
    )

    media_on_hold_use_alternate_source_for_internal_calls: Optional[bool] = field(
        default=None,
        metadata={"alias": "mediaOnHoldUseAlternateSourceForInternalCalls"},
    )

    media_on_hold_internal_source: Optional[CallCenterMediaOnHoldSourceRead22] = field(
        default=None, metadata={"alias": "mediaOnHoldInternalSource"}
    )

    play_whisper_message: Optional[bool] = field(
        default=None, metadata={"alias": "playWhisperMessage"}
    )

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

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

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

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

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

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

    estimated_wait_message_options_read: EstimatedWaitMessageOptionsRead17sp4 = field(
        metadata={"alias": "estimatedWaitMessageOptionsRead"}
    )

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 GroupCallCenterGetAnnouncementRequest22

client = Client()

command = GroupCallCenterGetAnnouncementRequest22(
    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("GroupCallCenterGetAnnouncementRequest22",
    service_user_id=...,
)

print(response)