Skip to content

GroupRoutePointModifyInstanceRequest22

Bases: OCIRequest

Request to modify a Route Point instance. The response is either SuccessResponse or ErrorResponse. The Following elements are only used in AS data mode and ignored in XS data mode: - sendCallAdmissionNotification, use value ‘false’ in XS data mode. - callAdmissionTimerSeconds, use value ‘3’ in XS data mode.

Attributes:

service_user_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

network_class_of_service (Optional[str]):

external_preferred_audio_codec (Optional[str]):

internal_preferred_audio_codec (Optional[str]):

queue_length (Optional[int]):

no_answer_timeout_rings (Optional[int]):

enable_video (Optional[bool]):

play_ringing_when_offering_call (Optional[bool]):

override_agent_wrap_up_time (Optional[bool]):

wrap_up_seconds (Optional[Nillable[int]]):

enable_automatic_state_change_for_agents (Optional[bool]):

agent_state_after_call (Optional[str]):

agent_unavailable_code (Optional[Nillable[str]]):

force_delivery_of_calls (Optional[bool]):

force_delivery_wait_time_seconds (Optional[Nillable[int]]):

send_call_admission_notification (Optional[bool]):

call_admission_timer_seconds (Optional[int]):

enable_unlimited_queue_length (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointModifyInstanceRequest22(OCIRequest):
    """Request to modify a Route Point instance.
        The response is either SuccessResponse or ErrorResponse.
        The Following elements are only used in AS data mode and ignored in XS data mode:
            - sendCallAdmissionNotification, use value ‘false’ in XS data mode.
            - callAdmissionTimerSeconds, use value ‘3’ in XS data mode.

    Attributes:

        service_user_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        network_class_of_service (Optional[str]):

        external_preferred_audio_codec (Optional[str]):

        internal_preferred_audio_codec (Optional[str]):

        queue_length (Optional[int]):

        no_answer_timeout_rings (Optional[int]):

        enable_video (Optional[bool]):

        play_ringing_when_offering_call (Optional[bool]):

        override_agent_wrap_up_time (Optional[bool]):

        wrap_up_seconds (Optional[Nillable[int]]):

        enable_automatic_state_change_for_agents (Optional[bool]):

        agent_state_after_call (Optional[str]):

        agent_unavailable_code (Optional[Nillable[str]]):

        force_delivery_of_calls (Optional[bool]):

        force_delivery_wait_time_seconds (Optional[Nillable[int]]):

        send_call_admission_notification (Optional[bool]):

        call_admission_timer_seconds (Optional[int]):

        enable_unlimited_queue_length (Optional[bool]):

    """

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

    service_instance_profile: Optional[ServiceInstanceModifyProfile] = field(
        default=None, metadata={"alias": "serviceInstanceProfile"}
    )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "wrap_up_seconds",
            "agent_unavailable_code",
            "force_delivery_wait_time_seconds",
        ]
        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 GroupRoutePointModifyInstanceRequest22

client = Client()

command = GroupRoutePointModifyInstanceRequest22(
    service_user_id=...,
    service_instance_profile=...,
    network_class_of_service=...,
    external_preferred_audio_codec=...,
    internal_preferred_audio_codec=...,
    queue_length=...,
    no_answer_timeout_rings=...,
    enable_video=...,
    play_ringing_when_offering_call=...,
    override_agent_wrap_up_time=...,
    wrap_up_seconds=...,
    enable_automatic_state_change_for_agents=...,
    agent_state_after_call=...,
    agent_unavailable_code=...,
    force_delivery_of_calls=...,
    force_delivery_wait_time_seconds=...,
    send_call_admission_notification=...,
    call_admission_timer_seconds=...,
    enable_unlimited_queue_length=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupRoutePointModifyInstanceRequest22",
    service_user_id=...,
    service_instance_profile=...,
    network_class_of_service=...,
    external_preferred_audio_codec=...,
    internal_preferred_audio_codec=...,
    queue_length=...,
    no_answer_timeout_rings=...,
    enable_video=...,
    play_ringing_when_offering_call=...,
    override_agent_wrap_up_time=...,
    wrap_up_seconds=...,
    enable_automatic_state_change_for_agents=...,
    agent_state_after_call=...,
    agent_unavailable_code=...,
    force_delivery_of_calls=...,
    force_delivery_wait_time_seconds=...,
    send_call_admission_notification=...,
    call_admission_timer_seconds=...,
    enable_unlimited_queue_length=...,
)

print(response)