GroupRoutePointBouncedCallModifyRequest

Bases: OCIRequest

Modify a route point's bounced call settings. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_user_id (str):

is_active (Optional[bool]):

number_of_rings_before_bouncing_call (Optional[int]):

enable_transfer (Optional[bool]):

transfer_phone_number (Optional[Nillable[str]]):

bounce_call_when_agent_unavailable (Optional[bool]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupRoutePointBouncedCallModifyRequest(OCIRequest):
    """Modify a route point's bounced call settings.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_user_id (str):

        is_active (Optional[bool]):

        number_of_rings_before_bouncing_call (Optional[int]):

        enable_transfer (Optional[bool]):

        transfer_phone_number (Optional[Nillable[str]]):

        bounce_call_when_agent_unavailable (Optional[bool]):

    """

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["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 GroupRoutePointBouncedCallModifyRequest

client = Client()

command = GroupRoutePointBouncedCallModifyRequest(
    service_user_id=...,
    is_active=...,
    number_of_rings_before_bouncing_call=...,
    enable_transfer=...,
    transfer_phone_number=...,
    bounce_call_when_agent_unavailable=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupRoutePointBouncedCallModifyRequest",
    service_user_id=...,
    is_active=...,
    number_of_rings_before_bouncing_call=...,
    enable_transfer=...,
    transfer_phone_number=...,
    bounce_call_when_agent_unavailable=...,
)

print(response)