Skip to content

GroupVoiceMessagingGroupModifyVoicePortalRequest

Bases: OCIRequest

Request to modify the group voice portal information for a voice messaging group. The following elements are only used in AS data mode: networkClassOfService The following elements are only used in AS data mode and ignored in XS data mode: expressMode

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

is_active (Optional[bool]):

enable_extended_scope (Optional[bool]):

allow_identification_by_phone_number_or_voice_mail_aliases_on_login (Optional[bool]):

use_voice_portal_wizard (Optional[bool]):

voice_portal_external_routing_scope (Optional[str]):

use_external_routing (Optional[bool]):

external_routing_address (Optional[Nillable[str]]):

home_zone_name (Optional[Nillable[str]]):

network_class_of_service (Optional[str]):

express_mode (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupVoiceMessagingGroupModifyVoicePortalRequest(OCIRequest):
    """Request to modify the group voice portal information for a voice messaging group.
        The following elements are only used in AS data mode:
          networkClassOfService
        The following elements are only used in AS data mode and ignored in XS data mode:
         expressMode

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        is_active (Optional[bool]):

        enable_extended_scope (Optional[bool]):

        allow_identification_by_phone_number_or_voice_mail_aliases_on_login (Optional[bool]):

        use_voice_portal_wizard (Optional[bool]):

        voice_portal_external_routing_scope (Optional[str]):

        use_external_routing (Optional[bool]):

        external_routing_address (Optional[Nillable[str]]):

        home_zone_name (Optional[Nillable[str]]):

        network_class_of_service (Optional[str]):

        express_mode (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["external_routing_address", "home_zone_name"]
        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 GroupVoiceMessagingGroupModifyVoicePortalRequest

client = Client()

command = GroupVoiceMessagingGroupModifyVoicePortalRequest(
    service_provider_id=...,
    group_id=...,
    service_instance_profile=...,
    is_active=...,
    enable_extended_scope=...,
    allow_identification_by_phone_number_or_voice_mail_aliases_on_login=...,
    use_voice_portal_wizard=...,
    voice_portal_external_routing_scope=...,
    use_external_routing=...,
    external_routing_address=...,
    home_zone_name=...,
    network_class_of_service=...,
    express_mode=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupVoiceMessagingGroupModifyVoicePortalRequest",
    service_provider_id=...,
    group_id=...,
    service_instance_profile=...,
    is_active=...,
    enable_extended_scope=...,
    allow_identification_by_phone_number_or_voice_mail_aliases_on_login=...,
    use_voice_portal_wizard=...,
    voice_portal_external_routing_scope=...,
    use_external_routing=...,
    external_routing_address=...,
    home_zone_name=...,
    network_class_of_service=...,
    express_mode=...,
)

print(response)