Skip to content

GroupPreAlertingAnnouncementGetRequest20

Bases: OCIRequest

Get the group’s PreAlertingservice settings. The response is either a GroupPreAlertingAnnouncementGetResponse20 or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupPreAlertingAnnouncementGetRequest20(OCIRequest):
    """Get the group’s PreAlertingservice settings.
        The response is either a GroupPreAlertingAnnouncementGetResponse20 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 a GroupPreAlertingAnnouncementGetResponse20.

Attributes:

announcement_interruption (str):

interruption_digit_sequence (Optional[str]):

audio_selection (str):

audio_file (Optional[AnnouncementFileKey]):

audio_file_url (Optional[str]):

video_selection (str):

video_file (Optional[AnnouncementFileKey]):

video_file_url (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupPreAlertingAnnouncementGetResponse20(OCIDataResponse):
    """Response to a GroupPreAlertingAnnouncementGetResponse20.

    Attributes:

        announcement_interruption (str):

        interruption_digit_sequence (Optional[str]):

        audio_selection (str):

        audio_file (Optional[AnnouncementFileKey]):

        audio_file_url (Optional[str]):

        video_selection (str):

        video_file (Optional[AnnouncementFileKey]):

        video_file_url (Optional[str]):

    """

    announcement_interruption: str = field(
        metadata={"alias": "announcementInterruption"}
    )

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

    audio_selection: str = field(metadata={"alias": "audioSelection"})

    audio_file: Optional[AnnouncementFileKey] = field(
        default=None, metadata={"alias": "audioFile"}
    )

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

    video_selection: str = field(metadata={"alias": "videoSelection"})

    video_file: Optional[AnnouncementFileKey] = field(
        default=None, metadata={"alias": "videoFile"}
    )

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

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 GroupPreAlertingAnnouncementGetRequest20

client = Client()

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

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)