Skip to content

ServiceProviderDialableCallerIDGetRequest

Bases: OCIRequest

Get the service provider?s Dialable Caller ID settings and criteria list. The response is either a ServiceProviderDialableCallerIDGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderDialableCallerIDGetRequest(OCIRequest):
    """Get the service provider?s Dialable Caller ID settings and criteria list.
        The response is either a
        ServiceProviderDialableCallerIDGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the ServiceProviderDialableCallerIDGetRequest. The criteria table?s column headings are ?Active?, "Name", "Description", ?Prefix Digits?, and ?Priority?.

Attributes:

use_service_provider_criteria (bool):

ns_screening_failure_policy (str):

criteria_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderDialableCallerIDGetResponse(OCIDataResponse):
    """Response to the ServiceProviderDialableCallerIDGetRequest.
        The criteria table?s column headings are ?Active?, \"Name\", \"Description\", ?Prefix Digits?, and ?Priority?.

    Attributes:

        use_service_provider_criteria (bool):

        ns_screening_failure_policy (str):

        criteria_table (OCITable):

    """

    use_service_provider_criteria: bool = field(
        metadata={"alias": "useServiceProviderCriteria"}
    )

    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 ServiceProviderDialableCallerIDGetRequest

client = Client()

command = ServiceProviderDialableCallerIDGetRequest(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderDialableCallerIDGetRequest",
    service_provider_id=...,
)

print(response)