Skip to content

GroupCallCenterStrandedCallUnavailableModifyRequest20

Bases: OCIRequest

Modify a call center's stranded calls - unavailable settings. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_user_id (str):

condition_policy_on_number_of_agents_with_specified_unavailable_code (Optional[bool]):

number_of_agents_with_specified_unavailable_code (Optional[Nillable[int]]):

agents_unavailable_code (Optional[Nillable[str]]):

action (Optional[str]):

transfer_phone_number (Optional[Nillable[str]]):

audio_message_selection (Optional[str]):

audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

video_message_selection (Optional[str]):

video_url_list (Optional[CallCenterAnnouncementURLListModify]):

video_file_list (Optional[CallCenterAnnouncementFileListModify20]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterStrandedCallUnavailableModifyRequest20(OCIRequest):
    """Modify a call center's stranded calls - unavailable settings.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_user_id (str):

        condition_policy_on_number_of_agents_with_specified_unavailable_code (Optional[bool]):

        number_of_agents_with_specified_unavailable_code (Optional[Nillable[int]]):

        agents_unavailable_code (Optional[Nillable[str]]):

        action (Optional[str]):

        transfer_phone_number (Optional[Nillable[str]]):

        audio_message_selection (Optional[str]):

        audio_url_list (Optional[CallCenterAnnouncementURLListModify]):

        audio_file_list (Optional[CallCenterAnnouncementFileListModify20]):

        video_message_selection (Optional[str]):

        video_url_list (Optional[CallCenterAnnouncementURLListModify]):

        video_file_list (Optional[CallCenterAnnouncementFileListModify20]):

    """

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

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

    number_of_agents_with_specified_unavailable_code: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "numberOfAgentsWithSpecifiedUnavailableCode"}
    )

    agents_unavailable_code: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "agentsUnavailableCode"}
    )

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "number_of_agents_with_specified_unavailable_code",
            "agents_unavailable_code",
            "transfer_phone_number",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

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

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 GroupCallCenterStrandedCallUnavailableModifyRequest20

client = Client()

command = GroupCallCenterStrandedCallUnavailableModifyRequest20(
    service_user_id=...,
    condition_policy_on_number_of_agents_with_specified_unavailable_code=...,
    number_of_agents_with_specified_unavailable_code=...,
    agents_unavailable_code=...,
    action=...,
    transfer_phone_number=...,
    audio_message_selection=...,
    audio_url_list=...,
    audio_file_list=...,
    video_message_selection=...,
    video_url_list=...,
    video_file_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterStrandedCallUnavailableModifyRequest20",
    service_user_id=...,
    condition_policy_on_number_of_agents_with_specified_unavailable_code=...,
    number_of_agents_with_specified_unavailable_code=...,
    agents_unavailable_code=...,
    action=...,
    transfer_phone_number=...,
    audio_message_selection=...,
    audio_url_list=...,
    audio_file_list=...,
    video_message_selection=...,
    video_url_list=...,
    video_file_list=...,
)

print(response)