Skip to content

GroupCallCenterModifyDNISAnnouncementRequest20

Bases: OCIRequest

Modify a call center DNIS announcement settings. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

dnis_key (DNISKey):

play_entrance_message (Optional[bool]):

mandatory_entrance_message (Optional[bool]):

entrance_audio_message_selection (Optional[str]):

entrance_message_audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

entrance_message_audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

entrance_video_message_selection (Optional[str]):

entrance_message_video_url_list (Optional[CallCenterAnnouncementURLListModify]):

entrance_message_video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

play_periodic_comfort_message (Optional[bool]):

time_between_comfort_messages_seconds (Optional[int]):

periodic_comfort_audio_message_selection (Optional[str]):

periodic_comfort_message_audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

periodic_comfort_message_audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

periodic_comfort_video_message_selection (Optional[str]):

periodic_comfort_message_video_url_list (Optional[CallCenterAnnouncementURLListModify]):

periodic_comfort_message_video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

enable_media_on_hold_for_queued_calls (Optional[bool]):

media_on_hold_source (Optional[CallCenterMediaOnHoldSourceModify20]):

play_whisper_message (Optional[bool]):

whisper_audio_message_selection (Optional[str]):

whisper_message_audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

whisper_message_audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

whisper_video_message_selection (Optional[str]):

whisper_message_video_url_list (Optional[CallCenterAnnouncementURLListModify]):

whisper_message_video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

estimated_wait_message_options_modify (Optional[EstimatedWaitMessageOptionsModify]):
Source code in src/mercury_ocip_fast/commands/commands.py 
39040
39041
39042
39043
39044
39045
39046
39047
39048
39049
39050
39051
39052
39053
39054
39055
39056
39057
39058
39059
39060
39061
39062
39063
39064
39065
39066
39067
39068
39069
39070
39071
39072
39073
39074
39075
39076
39077
39078
39079
39080
39081
39082
39083
39084
39085
39086
39087
39088
39089
39090
39091
39092
39093
39094
39095
39096
39097
39098
39099
39100
39101
39102
39103
39104
39105
39106
39107
39108
39109
39110
39111
39112
39113
39114
39115
39116
39117
39118
39119
39120
39121
39122
39123
39124
39125
39126
39127
39128
39129
39130
39131
39132
39133
39134
39135
39136
39137
39138
39139
39140
39141
39142
39143
39144
39145
39146
39147
39148
39149
39150
39151
39152
39153
39154
39155
39156
39157
39158
39159
39160
39161
39162
39163
39164
39165
39166
39167
39168
39169
39170
39171
39172
39173
39174
39175
39176
39177
39178
39179
39180
39181
39182
39183
39184
39185
39186
39187
39188
39189
39190
39191
39192
39193
39194
39195
39196
39197
39198
39199
39200
39201
39202
39203
39204
39205
39206
39207
@dataclass(kw_only=True)
class GroupCallCenterModifyDNISAnnouncementRequest20(OCIRequest):
    """Modify a call center DNIS announcement settings.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        dnis_key (DNISKey):

        play_entrance_message (Optional[bool]):

        mandatory_entrance_message (Optional[bool]):

        entrance_audio_message_selection (Optional[str]):

        entrance_message_audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

        entrance_message_audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        entrance_video_message_selection (Optional[str]):

        entrance_message_video_url_list (Optional[CallCenterAnnouncementURLListModify]):

        entrance_message_video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        play_periodic_comfort_message (Optional[bool]):

        time_between_comfort_messages_seconds (Optional[int]):

        periodic_comfort_audio_message_selection (Optional[str]):

        periodic_comfort_message_audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

        periodic_comfort_message_audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        periodic_comfort_video_message_selection (Optional[str]):

        periodic_comfort_message_video_url_list (Optional[CallCenterAnnouncementURLListModify]):

        periodic_comfort_message_video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        enable_media_on_hold_for_queued_calls (Optional[bool]):

        media_on_hold_source (Optional[CallCenterMediaOnHoldSourceModify20]):

        play_whisper_message (Optional[bool]):

        whisper_audio_message_selection (Optional[str]):

        whisper_message_audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

        whisper_message_audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        whisper_video_message_selection (Optional[str]):

        whisper_message_video_url_list (Optional[CallCenterAnnouncementURLListModify]):

        whisper_message_video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        estimated_wait_message_options_modify (Optional[EstimatedWaitMessageOptionsModify]):

    """

    dnis_key: DNISKey = field(metadata={"alias": "dnisKey"})

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

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

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

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

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

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

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

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

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

    time_between_comfort_messages_seconds: Optional[int] = field(
        default=None, metadata={"alias": "timeBetweenComfortMessagesSeconds"}
    )

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

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

    periodic_comfort_message_audio_file_list: Optional[
        CallCenterAnnouncementFileListModify20
    ] = 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[
        CallCenterAnnouncementURLListModify
    ] = field(default=None, metadata={"alias": "periodicComfortMessageVideoUrlList"})

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

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

    media_on_hold_source: Optional[CallCenterMediaOnHoldSourceModify20] = field(
        default=None, metadata={"alias": "mediaOnHoldSource"}
    )

    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[CallCenterAnnouncementURLListModify] = (
        field(default=None, metadata={"alias": "whisperMessageAudioUrlList"})
    )

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

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

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

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

    estimated_wait_message_options_modify: Optional[
        EstimatedWaitMessageOptionsModify
    ] = field(default=None, metadata={"alias": "estimatedWaitMessageOptionsModify"})

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 GroupCallCenterModifyDNISAnnouncementRequest20

client = Client()

command = GroupCallCenterModifyDNISAnnouncementRequest20(
    dnis_key=...,
    play_entrance_message=...,
    mandatory_entrance_message=...,
    entrance_audio_message_selection=...,
    entrance_message_audio_url_list=...,
    entrance_message_audio_file_list=...,
    entrance_video_message_selection=...,
    entrance_message_video_url_list=...,
    entrance_message_video_file_list=...,
    play_periodic_comfort_message=...,
    time_between_comfort_messages_seconds=...,
    periodic_comfort_audio_message_selection=...,
    periodic_comfort_message_audio_url_list=...,
    periodic_comfort_message_audio_file_list=...,
    periodic_comfort_video_message_selection=...,
    periodic_comfort_message_video_url_list=...,
    periodic_comfort_message_video_file_list=...,
    enable_media_on_hold_for_queued_calls=...,
    media_on_hold_source=...,
    play_whisper_message=...,
    whisper_audio_message_selection=...,
    whisper_message_audio_url_list=...,
    whisper_message_audio_file_list=...,
    whisper_video_message_selection=...,
    whisper_message_video_url_list=...,
    whisper_message_video_file_list=...,
    estimated_wait_message_options_modify=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCallCenterModifyDNISAnnouncementRequest20",
    dnis_key=...,
    play_entrance_message=...,
    mandatory_entrance_message=...,
    entrance_audio_message_selection=...,
    entrance_message_audio_url_list=...,
    entrance_message_audio_file_list=...,
    entrance_video_message_selection=...,
    entrance_message_video_url_list=...,
    entrance_message_video_file_list=...,
    play_periodic_comfort_message=...,
    time_between_comfort_messages_seconds=...,
    periodic_comfort_audio_message_selection=...,
    periodic_comfort_message_audio_url_list=...,
    periodic_comfort_message_audio_file_list=...,
    periodic_comfort_video_message_selection=...,
    periodic_comfort_message_video_url_list=...,
    periodic_comfort_message_video_file_list=...,
    enable_media_on_hold_for_queued_calls=...,
    media_on_hold_source=...,
    play_whisper_message=...,
    whisper_audio_message_selection=...,
    whisper_message_audio_url_list=...,
    whisper_message_audio_file_list=...,
    whisper_video_message_selection=...,
    whisper_message_video_url_list=...,
    whisper_message_video_file_list=...,
    estimated_wait_message_options_modify=...,
)

print(response)