Skip to content

GroupCallCenterAddInstanceRequest22

Bases: OCIRequest

Add a Call Center instance to a group. 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:
  routingType
  enableReporting
  allowCallsToAgentsInWrapUp
  overrideAgentWrapUpTime
  wrapUpSeconds
  forceDeliveryOfCalls
  forceDeliveryWaitTimeSeconds
  enableAutomaticStateChangeForAgents
  agentStateAfterCall
  agentUnavailableCode
  networkClassOfService

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfileCallCenter):

type (str):

routing_type (Optional[str]):

policy (str):

enable_video (bool):

queue_length (int):

enable_reporting (Optional[bool]):

allow_caller_to_dial_escape_digit (bool):

escape_digit (str):

reset_call_statistics_upon_entry_in_queue (bool):

allow_agent_logoff (bool):

allow_call_waiting_for_agents (bool):

allow_calls_to_agents_in_wrap_up (Optional[bool]):

override_agent_wrap_up_time (Optional[bool]):

wrap_up_seconds (Optional[int]):

force_delivery_of_calls (Optional[bool]):

force_delivery_wait_time_seconds (Optional[int]):

enable_automatic_state_change_for_agents (Optional[bool]):

agent_state_after_call (Optional[str]):

agent_unavailable_code (Optional[str]):

external_preferred_audio_codec (str):

internal_preferred_audio_codec (str):

play_ringing_when_offering_call (bool):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterAddInstanceRequest22(OCIRequest):
    """Add a Call Center instance to a group.
        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:
          routingType
          enableReporting
          allowCallsToAgentsInWrapUp
          overrideAgentWrapUpTime
          wrapUpSeconds
          forceDeliveryOfCalls
          forceDeliveryWaitTimeSeconds
          enableAutomaticStateChangeForAgents
          agentStateAfterCall
          agentUnavailableCode
          networkClassOfService

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfileCallCenter):

        type (str):

        routing_type (Optional[str]):

        policy (str):

        enable_video (bool):

        queue_length (int):

        enable_reporting (Optional[bool]):

        allow_caller_to_dial_escape_digit (bool):

        escape_digit (str):

        reset_call_statistics_upon_entry_in_queue (bool):

        allow_agent_logoff (bool):

        allow_call_waiting_for_agents (bool):

        allow_calls_to_agents_in_wrap_up (Optional[bool]):

        override_agent_wrap_up_time (Optional[bool]):

        wrap_up_seconds (Optional[int]):

        force_delivery_of_calls (Optional[bool]):

        force_delivery_wait_time_seconds (Optional[int]):

        enable_automatic_state_change_for_agents (Optional[bool]):

        agent_state_after_call (Optional[str]):

        agent_unavailable_code (Optional[str]):

        external_preferred_audio_codec (str):

        internal_preferred_audio_codec (str):

        play_ringing_when_offering_call (bool):

        network_class_of_service (Optional[str]):

    """

    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: ServiceInstanceAddProfileCallCenter = field(
        metadata={"alias": "serviceInstanceProfile"}
    )

    type: str = field(metadata={"alias": "type"})

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

    policy: str = field(metadata={"alias": "policy"})

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

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

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

    allow_caller_to_dial_escape_digit: bool = field(
        metadata={"alias": "allowCallerToDialEscapeDigit"}
    )

    escape_digit: str = field(metadata={"alias": "escapeDigit"})

    reset_call_statistics_upon_entry_in_queue: bool = field(
        metadata={"alias": "resetCallStatisticsUponEntryInQueue"}
    )

    allow_agent_logoff: bool = field(metadata={"alias": "allowAgentLogoff"})

    allow_call_waiting_for_agents: bool = field(
        metadata={"alias": "allowCallWaitingForAgents"}
    )

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

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

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

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

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

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

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

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

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

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

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 GroupCallCenterAddInstanceRequest22

client = Client()

command = GroupCallCenterAddInstanceRequest22(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    type=...,
    routing_type=...,
    policy=...,
    enable_video=...,
    queue_length=...,
    enable_reporting=...,
    allow_caller_to_dial_escape_digit=...,
    escape_digit=...,
    reset_call_statistics_upon_entry_in_queue=...,
    allow_agent_logoff=...,
    allow_call_waiting_for_agents=...,
    allow_calls_to_agents_in_wrap_up=...,
    override_agent_wrap_up_time=...,
    wrap_up_seconds=...,
    force_delivery_of_calls=...,
    force_delivery_wait_time_seconds=...,
    enable_automatic_state_change_for_agents=...,
    agent_state_after_call=...,
    agent_unavailable_code=...,
    external_preferred_audio_codec=...,
    internal_preferred_audio_codec=...,
    play_ringing_when_offering_call=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterAddInstanceRequest22",
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    type=...,
    routing_type=...,
    policy=...,
    enable_video=...,
    queue_length=...,
    enable_reporting=...,
    allow_caller_to_dial_escape_digit=...,
    escape_digit=...,
    reset_call_statistics_upon_entry_in_queue=...,
    allow_agent_logoff=...,
    allow_call_waiting_for_agents=...,
    allow_calls_to_agents_in_wrap_up=...,
    override_agent_wrap_up_time=...,
    wrap_up_seconds=...,
    force_delivery_of_calls=...,
    force_delivery_wait_time_seconds=...,
    enable_automatic_state_change_for_agents=...,
    agent_state_after_call=...,
    agent_unavailable_code=...,
    external_preferred_audio_codec=...,
    internal_preferred_audio_codec=...,
    play_ringing_when_offering_call=...,
    network_class_of_service=...,
)

print(response)