Skip to content

GroupRoutePointGetDNISRequest

Bases: OCIRequest

Get a route point's DNIS. The response is either a GroupRoutePointGetDNISResponse or an ErrorResponse.

Attributes:

dnis_key (DNISKey):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointGetDNISRequest(OCIRequest):
    """Get a route point's DNIS.
        The response is either a GroupRoutePointGetDNISResponse or an ErrorResponse.

    Attributes:

        dnis_key (DNISKey):

    """

    dnis_key: DNISKey = field(metadata={"alias": "dnisKey"})

Responses

Bases: OCIDataResponse

Response to the GroupRoutePointGetDNISRequest.

Attributes:

dnis_phone_number (Optional[str]):

extension (Optional[str]):

use_custom_clid_settings (bool):

calling_line_id_phone_number (Optional[str]):

calling_line_id_last_name (Optional[str]):

calling_line_id_first_name (Optional[str]):

use_custom_dnis_announcement_settings (bool):

allow_outgoing_acd_call (bool):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointGetDNISResponse(OCIDataResponse):
    """Response to the GroupRoutePointGetDNISRequest.

    Attributes:

        dnis_phone_number (Optional[str]):

        extension (Optional[str]):

        use_custom_clid_settings (bool):

        calling_line_id_phone_number (Optional[str]):

        calling_line_id_last_name (Optional[str]):

        calling_line_id_first_name (Optional[str]):

        use_custom_dnis_announcement_settings (bool):

        allow_outgoing_acd_call (bool):

    """

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

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

    use_custom_clid_settings: bool = field(metadata={"alias": "useCustomCLIDSettings"})

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

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

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

    use_custom_dnis_announcement_settings: bool = field(
        metadata={"alias": "useCustomDnisAnnouncementSettings"}
    )

    allow_outgoing_acd_call: bool = field(metadata={"alias": "allowOutgoingACDCall"})

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 GroupRoutePointGetDNISRequest

client = Client()

command = GroupRoutePointGetDNISRequest(
    dnis_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupRoutePointGetDNISRequest",
    dnis_key=...,
)

print(response)