Skip to content

GroupCallParkModifyRequest

Bases: OCIRequest

Modifies the Group's Call Park settings. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

recall_timer_seconds (Optional[int]):

display_timer_seconds (Optional[int]):

enable_destination_announcement (Optional[bool]):

recall_alternate_user_id (Optional[Nillable[str]]):

recall_ring_pattern (Optional[str]):

recall_to (Optional[str]):

alternate_user_recall_timer_seconds (Optional[int]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallParkModifyRequest(OCIRequest):
    """Modifies the Group's Call Park settings.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        recall_timer_seconds (Optional[int]):

        display_timer_seconds (Optional[int]):

        enable_destination_announcement (Optional[bool]):

        recall_alternate_user_id (Optional[Nillable[str]]):

        recall_ring_pattern (Optional[str]):

        recall_to (Optional[str]):

        alternate_user_recall_timer_seconds (Optional[int]):

    """

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

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

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

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

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

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

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

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

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

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

client = Client()

command = GroupCallParkModifyRequest(
    service_provider_id=...,
    group_id=...,
    recall_timer_seconds=...,
    display_timer_seconds=...,
    enable_destination_announcement=...,
    recall_alternate_user_id=...,
    recall_ring_pattern=...,
    recall_to=...,
    alternate_user_recall_timer_seconds=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallParkModifyRequest",
    service_provider_id=...,
    group_id=...,
    recall_timer_seconds=...,
    display_timer_seconds=...,
    enable_destination_announcement=...,
    recall_alternate_user_id=...,
    recall_ring_pattern=...,
    recall_to=...,
    alternate_user_recall_timer_seconds=...,
)

print(response)