Skip to content

GroupInstantGroupCallAddInstanceRequest14

Bases: OCIRequest

Request to add an Instant Group Call service instance to a group. The domain is required in the serviceUserId. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfile):

destination_phone_number (Optional[List[str]]):

is_answer_timeout_enabled (bool):

answer_timeout_minutes (Optional[int]):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupInstantGroupCallAddInstanceRequest14(OCIRequest):
    """Request to add an Instant Group Call service instance to a group.
        The domain is required in the serviceUserId.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfile):

        destination_phone_number (Optional[List[str]]):

        is_answer_timeout_enabled (bool):

        answer_timeout_minutes (Optional[int]):

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

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

    is_answer_timeout_enabled: bool = field(
        metadata={"alias": "isAnswerTimeoutEnabled"}
    )

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

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

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 GroupInstantGroupCallAddInstanceRequest14

client = Client()

command = GroupInstantGroupCallAddInstanceRequest14(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    destination_phone_number=...,
    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("GroupInstantGroupCallAddInstanceRequest14",
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    destination_phone_number=...,
    is_answer_timeout_enabled=...,
    answer_timeout_minutes=...,
    network_class_of_service=...,
)

print(response)