Skip to content

GroupRoutePointAddInstanceRequest23

Bases: OCIRequest

Add a Route Point instance to a group. The Route Point is a Call Center queue that performs the same function but allows an external system to perform the distribution of calls instead of making those decisions itself. The domain is required in the serviceUserId. 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_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfile):

network_class_of_service (Optional[str]):

external_preferred_audio_codec (str):

internal_preferred_audio_codec (str):

queue_length (int):

no_answer_timeout_rings (int):

enable_video (bool):

play_ringing_when_offering_call (bool):

override_agent_wrap_up_time (bool):

wrap_up_seconds (Optional[int]):

enable_automatic_state_change_for_agents (bool):

agent_state_after_call (str):

agent_unavailable_code (Optional[str]):

force_delivery_of_calls (bool):

force_delivery_wait_time_seconds (Optional[int]):

send_call_admission_notification (bool):

call_admission_timer_seconds (int):

enable_unlimited_queue_length (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointAddInstanceRequest23(OCIRequest):
    """Add a Route Point instance to a group.
        The Route Point is a Call Center queue that performs the same function but
        allows an external system to perform the distribution of calls instead of making
        those decisions itself.
        The domain is required in the serviceUserId.
        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_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfile):

        network_class_of_service (Optional[str]):

        external_preferred_audio_codec (str):

        internal_preferred_audio_codec (str):

        queue_length (int):

        no_answer_timeout_rings (int):

        enable_video (bool):

        play_ringing_when_offering_call (bool):

        override_agent_wrap_up_time (bool):

        wrap_up_seconds (Optional[int]):

        enable_automatic_state_change_for_agents (bool):

        agent_state_after_call (str):

        agent_unavailable_code (Optional[str]):

        force_delivery_of_calls (bool):

        force_delivery_wait_time_seconds (Optional[int]):

        send_call_admission_notification (bool):

        call_admission_timer_seconds (int):

        enable_unlimited_queue_length (Optional[bool]):

    """

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

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

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

    service_instance_profile: ServiceInstanceAddProfile = field(
        metadata={"alias": "serviceInstanceProfile"}
    )

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

    external_preferred_audio_codec: str = field(
        metadata={"alias": "externalPreferredAudioCodec"}
    )

    internal_preferred_audio_codec: str = field(
        metadata={"alias": "internalPreferredAudioCodec"}
    )

    queue_length: int = field(metadata={"alias": "queueLength"})

    no_answer_timeout_rings: int = field(metadata={"alias": "noAnswerTimeoutRings"})

    enable_video: bool = field(metadata={"alias": "enableVideo"})

    play_ringing_when_offering_call: bool = field(
        metadata={"alias": "playRingingWhenOfferingCall"}
    )

    override_agent_wrap_up_time: bool = field(
        metadata={"alias": "overrideAgentWrapUpTime"}
    )

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

    enable_automatic_state_change_for_agents: bool = field(
        metadata={"alias": "enableAutomaticStateChangeForAgents"}
    )

    agent_state_after_call: str = field(metadata={"alias": "agentStateAfterCall"})

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

    force_delivery_of_calls: bool = field(metadata={"alias": "forceDeliveryOfCalls"})

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

    send_call_admission_notification: bool = field(
        metadata={"alias": "sendCallAdmissionNotification"}
    )

    call_admission_timer_seconds: int = field(
        metadata={"alias": "callAdmissionTimerSeconds"}
    )

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

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 GroupRoutePointAddInstanceRequest23

client = Client()

command = GroupRoutePointAddInstanceRequest23(
    service_provider_id=...,
    group_id=...,
    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("GroupRoutePointAddInstanceRequest23",
    service_provider_id=...,
    group_id=...,
    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)