GroupInstantGroupCallModifyInstanceRequest

Bases: OCIRequest

Request to modify an Instant Group Call service instance. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_user_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

destination_phone_number_list (Optional[Nillable[ReplacementOutgoingDNorSIPURIList]]):

is_answer_timeout_enabled (Optional[bool]):

answer_timeout_minutes (Optional[Nillable[int]]):

network_class_of_service (Optional[str]):

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

@dataclass(kw_only=True)
class GroupInstantGroupCallModifyInstanceRequest(OCIRequest):
    """Request to modify an Instant Group Call service instance.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        destination_phone_number_list (Optional[Nillable[ReplacementOutgoingDNorSIPURIList]]):

        is_answer_timeout_enabled (Optional[bool]):

        answer_timeout_minutes (Optional[Nillable[int]]):

        network_class_of_service (Optional[str]):

    """

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

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

    destination_phone_number_list: Optional[
        Nillable[ReplacementOutgoingDNorSIPURIList]
    ] = field(default=None, metadata={"alias": "destinationPhoneNumberList"})

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

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

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

    def __post_init__(self):
        nillable_fields = ["destination_phone_number_list", "answer_timeout_minutes"]
        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_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 GroupInstantGroupCallModifyInstanceRequest

client = Client()

command = GroupInstantGroupCallModifyInstanceRequest(
    service_user_id=...,
    service_instance_profile=...,
    destination_phone_number_list=...,
    is_answer_timeout_enabled=...,
    answer_timeout_minutes=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupInstantGroupCallModifyInstanceRequest",
    service_user_id=...,
    service_instance_profile=...,
    destination_phone_number_list=...,
    is_answer_timeout_enabled=...,
    answer_timeout_minutes=...,
    network_class_of_service=...,
)

print(response)