GroupCallCapacityManagementAddInstanceRequest

Bases: OCIRequest

Adds a Call Capacity Management group. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

name (str):

max_active_calls_allowed (int):

max_incoming_active_calls_allowed (Optional[int]):

max_outgoing_active_calls_allowed (Optional[int]):

become_default_group_for_new_users (bool):

user_id (Optional[List[str]]):

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

@dataclass(kw_only=True)
class GroupCallCapacityManagementAddInstanceRequest(OCIRequest):
    """Adds a Call Capacity Management group.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        name (str):

        max_active_calls_allowed (int):

        max_incoming_active_calls_allowed (Optional[int]):

        max_outgoing_active_calls_allowed (Optional[int]):

        become_default_group_for_new_users (bool):

        user_id (Optional[List[str]]):

    """

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

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

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

    max_active_calls_allowed: int = field(metadata={"alias": "maxActiveCallsAllowed"})

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

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

    become_default_group_for_new_users: bool = field(
        metadata={"alias": "becomeDefaultGroupForNewUsers"}
    )

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

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupCallCapacityManagementAddInstanceRequest

client = Client()

command = GroupCallCapacityManagementAddInstanceRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
    max_active_calls_allowed=...,
    max_incoming_active_calls_allowed=...,
    max_outgoing_active_calls_allowed=...,
    become_default_group_for_new_users=...,
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCallCapacityManagementAddInstanceRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
    max_active_calls_allowed=...,
    max_incoming_active_calls_allowed=...,
    max_outgoing_active_calls_allowed=...,
    become_default_group_for_new_users=...,
    user_id=...,
)

print(response)