Skip to content

GroupPreAlertingAnnouncementModifyRequest20

Bases: OCIRequest

Modify the group level pre-alerting service settings. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

announcement_interruption (Optional[str]):

interruption_digit_sequence (Optional[str]):

audio_selection (Optional[str]):

audio_file (Optional[ExtendedMediaFileResource20]):

video_selection (Optional[str]):

video_file (Optional[ExtendedMediaFileResource20]):
Source code in src/mercury_ocip_fast/commands/commands.py 
53629
53630
53631
53632
53633
53634
53635
53636
53637
53638
53639
53640
53641
53642
53643
53644
53645
53646
53647
53648
53649
53650
53651
53652
53653
53654
53655
53656
53657
53658
53659
53660
53661
53662
53663
53664
53665
53666
53667
53668
53669
53670
53671
53672
53673
53674
53675
53676
53677
53678
53679
53680
@dataclass(kw_only=True)
class GroupPreAlertingAnnouncementModifyRequest20(OCIRequest):
    """Modify the group level pre-alerting service settings.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        announcement_interruption (Optional[str]):

        interruption_digit_sequence (Optional[str]):

        audio_selection (Optional[str]):

        audio_file (Optional[ExtendedMediaFileResource20]):

        video_selection (Optional[str]):

        video_file (Optional[ExtendedMediaFileResource20]):

    """

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

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

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

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

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

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

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

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

Responses

Bases: OCIResponse

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

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py 
115
116
117
118
119
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 GroupPreAlertingAnnouncementModifyRequest20

client = Client()

command = GroupPreAlertingAnnouncementModifyRequest20(
    service_provider_id=...,
    group_id=...,
    announcement_interruption=...,
    interruption_digit_sequence=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupPreAlertingAnnouncementModifyRequest20",
    service_provider_id=...,
    group_id=...,
    announcement_interruption=...,
    interruption_digit_sequence=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
)

print(response)