GroupDialableCallerIDGetRequest

Bases: OCIRequest

Get the Group's Dialable Caller ID settings and criteria list. The response is either a GroupDialableCallerIDGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

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

@dataclass(kw_only=True)
class GroupDialableCallerIDGetRequest(OCIRequest):
    """Get the Group's Dialable Caller ID settings and criteria list.
        The response is either a
        GroupDialableCallerIDGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

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

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

Responses

Bases: OCIDataResponse

Response to the GroupDialableCallerIDGetRequest. The criteria table's column headings are "Active", "Name", "Description", "Prefix Digits", "Priority".

Attributes:

use_group_criteria (bool):

ns_screening_failure_policy (str):

criteria_table (OCITable):

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

@dataclass(kw_only=True)
class GroupDialableCallerIDGetResponse(OCIDataResponse):
    """Response to the GroupDialableCallerIDGetRequest.
        The criteria table's column headings are \"Active\", \"Name\", \"Description\", \"Prefix Digits\", \"Priority\".

    Attributes:

        use_group_criteria (bool):

        ns_screening_failure_policy (str):

        criteria_table (OCITable):

    """

    use_group_criteria: bool = field(metadata={"alias": "useGroupCriteria"})

    ns_screening_failure_policy: str = field(
        metadata={"alias": "nsScreeningFailurePolicy"}
    )

    criteria_table: OCITable = field(metadata={"alias": "criteriaTable"})

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 GroupDialableCallerIDGetRequest

client = Client()

command = GroupDialableCallerIDGetRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupDialableCallerIDGetRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)