Skip to content

SystemCallingNameRetrievalModifyRequest20

Bases: OCIRequest

Modifies the system's calling name retrieval attributes. The response is either a SuccessResponse or an ErrorResponse.

The following attributes are only used in AS data mode and ignored in XS data mode:
  - triggerCNAMQueriesForAllNetworkCalls
  - triggerCNAMQueriesForGroupAndEnterpriseCalls
  - queryProtocol
  - queryTimeoutMilliseconds
  - sipExternalDatabaseNetAddress
  - sipExternalDatabasePort
  - sipExternalDatabaseTransport
  - soapExternalDatabaseNetAddress
  - callingNameSource
  - routeAdvanceTimer
  - retryFailedCNAMServerInterval
  - ignoreRestrictedPresentationIndicator
  - supportsDNSSRV

The following attributes are only used in XS data mode and ignored in AS data mode:
  - callFilteringProvisioningEnabled

Attributes:

trigger_cnam_queries_for_all_network_calls (Optional[bool]):

trigger_cnam_queries_for_group_and_enterprise_calls (Optional[bool]):

query_protocol (Optional[str]):

query_timeout_milliseconds (Optional[int]):

sip_external_database_net_address (Optional[Nillable[str]]):

sip_external_database_port (Optional[Nillable[int]]):

sip_external_database_transport (Optional[str]):

soap_external_database_net_address (Optional[Nillable[str]]):

calling_name_source (Optional[str]):

route_advance_timer (Optional[int]):

retry_failed_cnam_server_interval (Optional[int]):

ignore_restricted_presentation_indicator (Optional[bool]):

supports_dnssrv (Optional[bool]):

call_filtering_provisioning_enabled (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemCallingNameRetrievalModifyRequest20(OCIRequest):
    """Modifies the system's calling name retrieval attributes.
        The response is either a SuccessResponse or an ErrorResponse.

        The following attributes are only used in AS data mode and ignored in XS data mode:
          - triggerCNAMQueriesForAllNetworkCalls
          - triggerCNAMQueriesForGroupAndEnterpriseCalls
          - queryProtocol
          - queryTimeoutMilliseconds
          - sipExternalDatabaseNetAddress
          - sipExternalDatabasePort
          - sipExternalDatabaseTransport
          - soapExternalDatabaseNetAddress
          - callingNameSource
          - routeAdvanceTimer
          - retryFailedCNAMServerInterval
          - ignoreRestrictedPresentationIndicator
          - supportsDNSSRV

        The following attributes are only used in XS data mode and ignored in AS data mode:
          - callFilteringProvisioningEnabled

    Attributes:

        trigger_cnam_queries_for_all_network_calls (Optional[bool]):

        trigger_cnam_queries_for_group_and_enterprise_calls (Optional[bool]):

        query_protocol (Optional[str]):

        query_timeout_milliseconds (Optional[int]):

        sip_external_database_net_address (Optional[Nillable[str]]):

        sip_external_database_port (Optional[Nillable[int]]):

        sip_external_database_transport (Optional[str]):

        soap_external_database_net_address (Optional[Nillable[str]]):

        calling_name_source (Optional[str]):

        route_advance_timer (Optional[int]):

        retry_failed_cnam_server_interval (Optional[int]):

        ignore_restricted_presentation_indicator (Optional[bool]):

        supports_dnssrv (Optional[bool]):

        call_filtering_provisioning_enabled (Optional[bool]):

    """

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

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

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

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

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

    sip_external_database_port: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "sipExternalDatabasePort"}
    )

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "sip_external_database_net_address",
            "sip_external_database_port",
            "soap_external_database_net_address",
        ]
        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_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 SystemCallingNameRetrievalModifyRequest20

client = Client()

command = SystemCallingNameRetrievalModifyRequest20(
    trigger_cnam_queries_for_all_network_calls=...,
    trigger_cnam_queries_for_group_and_enterprise_calls=...,
    query_protocol=...,
    query_timeout_milliseconds=...,
    sip_external_database_net_address=...,
    sip_external_database_port=...,
    sip_external_database_transport=...,
    soap_external_database_net_address=...,
    calling_name_source=...,
    route_advance_timer=...,
    retry_failed_cnam_server_interval=...,
    ignore_restricted_presentation_indicator=...,
    supports_dnssrv=...,
    call_filtering_provisioning_enabled=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemCallingNameRetrievalModifyRequest20",
    trigger_cnam_queries_for_all_network_calls=...,
    trigger_cnam_queries_for_group_and_enterprise_calls=...,
    query_protocol=...,
    query_timeout_milliseconds=...,
    sip_external_database_net_address=...,
    sip_external_database_port=...,
    sip_external_database_transport=...,
    soap_external_database_net_address=...,
    calling_name_source=...,
    route_advance_timer=...,
    retry_failed_cnam_server_interval=...,
    ignore_restricted_presentation_indicator=...,
    supports_dnssrv=...,
    call_filtering_provisioning_enabled=...,
)

print(response)