Skip to content

SystemCallProcessingPolicyProfileVoiceXMLProfileModifyRequest

Bases: OCIRequest

Modify a call processing policy profile voice XML type profile in system. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: useMaxCallsPerSecond maxCallsPerSecond

Attributes:

call_processing_policy_profile_name (str):

use_clid_policy (Optional[bool]):

clid_policy (Optional[str]):

emergency_clid_policy (Optional[str]):

allow_alternate_numbers_for_redirecting_identity (Optional[bool]):

use_group_name (Optional[bool]):

block_calling_name_for_external_calls (Optional[bool]):

allow_configurable_clid_for_redirecting_identity (Optional[bool]):

allow_department_clid_name_override (Optional[bool]):

enterprise_calls_clid_policy (Optional[str]):

enterprise_group_calls_clid_policy (Optional[str]):

service_provider_group_calls_clid_policy (Optional[str]):

use_call_limits_policy (Optional[bool]):

use_max_simultaneous_calls (Optional[bool]):

max_simultaneous_calls (Optional[int]):

use_max_simultaneous_video_calls (Optional[bool]):

max_simultaneous_video_calls (Optional[int]):

use_max_call_time_for_answered_calls (Optional[bool]):

max_call_time_for_answered_calls_minutes (Optional[int]):

use_max_call_time_for_unanswered_calls (Optional[bool]):

max_call_time_for_unanswered_calls_minutes (Optional[int]):

use_max_concurrent_redirected_calls (Optional[bool]):

max_concurrent_redirected_calls (Optional[int]):

max_redirection_depth (Optional[int]):

use_translation_routing_policy (Optional[bool]):

network_usage_selection (Optional[str]):

enable_enterprise_extension_dialing (Optional[bool]):

enforce_group_calling_line_identity_restriction (Optional[bool]):

enforce_enterprise_calling_line_identity_restriction (Optional[bool]):

allow_enterprise_group_call_typing_for_private_dialing_plan (Optional[bool]):

allow_enterprise_group_call_typing_for_public_dialing_plan (Optional[bool]):

override_clid_restriction_for_private_call_category (Optional[bool]):

use_enterprise_clid_for_private_call_category (Optional[bool]):

use_incoming_clid_policy (Optional[bool]):

enable_dialable_caller_id (Optional[bool]):

include_redirections_in_maximum_number_of_concurrent_calls (Optional[bool]):

use_user_phone_number_for_group_calls_when_internal_clid_unavailable (Optional[bool]):

use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable (Optional[bool]):

use_max_calls_per_second (Optional[bool]):

max_calls_per_second (Optional[int]):
Source code in src/mercury_ocip_fast/commands/commands.py
80851
80852
80853
80854
80855
80856
80857
80858
80859
80860
80861
80862
80863
80864
80865
80866
80867
80868
80869
80870
80871
80872
80873
80874
80875
80876
80877
80878
80879
80880
80881
80882
80883
80884
80885
80886
80887
80888
80889
80890
80891
80892
80893
80894
80895
80896
80897
80898
80899
80900
80901
80902
80903
80904
80905
80906
80907
80908
80909
80910
80911
80912
80913
80914
80915
80916
80917
80918
80919
80920
80921
80922
80923
80924
80925
80926
80927
80928
80929
80930
80931
80932
80933
80934
80935
80936
80937
80938
80939
80940
80941
80942
80943
80944
80945
80946
80947
80948
80949
80950
80951
80952
80953
80954
80955
80956
80957
80958
80959
80960
80961
80962
80963
80964
80965
80966
80967
80968
80969
80970
80971
80972
80973
80974
80975
80976
80977
80978
80979
80980
80981
80982
80983
80984
80985
80986
80987
80988
80989
80990
80991
80992
80993
80994
80995
80996
80997
80998
80999
81000
81001
81002
81003
81004
81005
81006
81007
81008
81009
81010
81011
81012
81013
81014
81015
81016
81017
81018
81019
81020
81021
81022
81023
81024
81025
81026
81027
81028
81029
81030
81031
81032
81033
81034
81035
81036
81037
81038
81039
81040
81041
81042
81043
81044
81045
81046
81047
81048
81049
81050
81051
81052
81053
81054
81055
81056
81057
81058
81059
81060
81061
81062
81063
81064
81065
81066
81067
81068
81069
81070
81071
81072
81073
81074
81075
81076
81077
81078
81079
81080
81081
81082
81083
81084
81085
81086
81087
81088
81089
81090
81091
81092
81093
81094
81095
81096
81097
81098
81099
81100
81101
81102
81103
81104
81105
81106
81107
81108
81109
81110
81111
81112
81113
81114
@dataclass(kw_only=True)
class SystemCallProcessingPolicyProfileVoiceXMLProfileModifyRequest(OCIRequest):
    """Modify a call processing policy profile voice XML type profile in system.
        The response is either a SuccessResponse or an ErrorResponse.
        The following elements are only used in AS data mode and ignored in XS data mode:
           useMaxCallsPerSecond
           maxCallsPerSecond

    Attributes:

        call_processing_policy_profile_name (str):

        use_clid_policy (Optional[bool]):

        clid_policy (Optional[str]):

        emergency_clid_policy (Optional[str]):

        allow_alternate_numbers_for_redirecting_identity (Optional[bool]):

        use_group_name (Optional[bool]):

        block_calling_name_for_external_calls (Optional[bool]):

        allow_configurable_clid_for_redirecting_identity (Optional[bool]):

        allow_department_clid_name_override (Optional[bool]):

        enterprise_calls_clid_policy (Optional[str]):

        enterprise_group_calls_clid_policy (Optional[str]):

        service_provider_group_calls_clid_policy (Optional[str]):

        use_call_limits_policy (Optional[bool]):

        use_max_simultaneous_calls (Optional[bool]):

        max_simultaneous_calls (Optional[int]):

        use_max_simultaneous_video_calls (Optional[bool]):

        max_simultaneous_video_calls (Optional[int]):

        use_max_call_time_for_answered_calls (Optional[bool]):

        max_call_time_for_answered_calls_minutes (Optional[int]):

        use_max_call_time_for_unanswered_calls (Optional[bool]):

        max_call_time_for_unanswered_calls_minutes (Optional[int]):

        use_max_concurrent_redirected_calls (Optional[bool]):

        max_concurrent_redirected_calls (Optional[int]):

        max_redirection_depth (Optional[int]):

        use_translation_routing_policy (Optional[bool]):

        network_usage_selection (Optional[str]):

        enable_enterprise_extension_dialing (Optional[bool]):

        enforce_group_calling_line_identity_restriction (Optional[bool]):

        enforce_enterprise_calling_line_identity_restriction (Optional[bool]):

        allow_enterprise_group_call_typing_for_private_dialing_plan (Optional[bool]):

        allow_enterprise_group_call_typing_for_public_dialing_plan (Optional[bool]):

        override_clid_restriction_for_private_call_category (Optional[bool]):

        use_enterprise_clid_for_private_call_category (Optional[bool]):

        use_incoming_clid_policy (Optional[bool]):

        enable_dialable_caller_id (Optional[bool]):

        include_redirections_in_maximum_number_of_concurrent_calls (Optional[bool]):

        use_user_phone_number_for_group_calls_when_internal_clid_unavailable (Optional[bool]):

        use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable (Optional[bool]):

        use_max_calls_per_second (Optional[bool]):

        max_calls_per_second (Optional[int]):

    """

    call_processing_policy_profile_name: str = field(
        metadata={"alias": "callProcessingPolicyProfileName"}
    )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 SystemCallProcessingPolicyProfileVoiceXMLProfileModifyRequest

client = Client()

command = SystemCallProcessingPolicyProfileVoiceXMLProfileModifyRequest(
    call_processing_policy_profile_name=...,
    use_clid_policy=...,
    clid_policy=...,
    emergency_clid_policy=...,
    allow_alternate_numbers_for_redirecting_identity=...,
    use_group_name=...,
    block_calling_name_for_external_calls=...,
    allow_configurable_clid_for_redirecting_identity=...,
    allow_department_clid_name_override=...,
    enterprise_calls_clid_policy=...,
    enterprise_group_calls_clid_policy=...,
    service_provider_group_calls_clid_policy=...,
    use_call_limits_policy=...,
    use_max_simultaneous_calls=...,
    max_simultaneous_calls=...,
    use_max_simultaneous_video_calls=...,
    max_simultaneous_video_calls=...,
    use_max_call_time_for_answered_calls=...,
    max_call_time_for_answered_calls_minutes=...,
    use_max_call_time_for_unanswered_calls=...,
    max_call_time_for_unanswered_calls_minutes=...,
    use_max_concurrent_redirected_calls=...,
    max_concurrent_redirected_calls=...,
    max_redirection_depth=...,
    use_translation_routing_policy=...,
    network_usage_selection=...,
    enable_enterprise_extension_dialing=...,
    enforce_group_calling_line_identity_restriction=...,
    enforce_enterprise_calling_line_identity_restriction=...,
    allow_enterprise_group_call_typing_for_private_dialing_plan=...,
    allow_enterprise_group_call_typing_for_public_dialing_plan=...,
    override_clid_restriction_for_private_call_category=...,
    use_enterprise_clid_for_private_call_category=...,
    use_incoming_clid_policy=...,
    enable_dialable_caller_id=...,
    include_redirections_in_maximum_number_of_concurrent_calls=...,
    use_user_phone_number_for_group_calls_when_internal_clid_unavailable=...,
    use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable=...,
    use_max_calls_per_second=...,
    max_calls_per_second=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemCallProcessingPolicyProfileVoiceXMLProfileModifyRequest",
    call_processing_policy_profile_name=...,
    use_clid_policy=...,
    clid_policy=...,
    emergency_clid_policy=...,
    allow_alternate_numbers_for_redirecting_identity=...,
    use_group_name=...,
    block_calling_name_for_external_calls=...,
    allow_configurable_clid_for_redirecting_identity=...,
    allow_department_clid_name_override=...,
    enterprise_calls_clid_policy=...,
    enterprise_group_calls_clid_policy=...,
    service_provider_group_calls_clid_policy=...,
    use_call_limits_policy=...,
    use_max_simultaneous_calls=...,
    max_simultaneous_calls=...,
    use_max_simultaneous_video_calls=...,
    max_simultaneous_video_calls=...,
    use_max_call_time_for_answered_calls=...,
    max_call_time_for_answered_calls_minutes=...,
    use_max_call_time_for_unanswered_calls=...,
    max_call_time_for_unanswered_calls_minutes=...,
    use_max_concurrent_redirected_calls=...,
    max_concurrent_redirected_calls=...,
    max_redirection_depth=...,
    use_translation_routing_policy=...,
    network_usage_selection=...,
    enable_enterprise_extension_dialing=...,
    enforce_group_calling_line_identity_restriction=...,
    enforce_enterprise_calling_line_identity_restriction=...,
    allow_enterprise_group_call_typing_for_private_dialing_plan=...,
    allow_enterprise_group_call_typing_for_public_dialing_plan=...,
    override_clid_restriction_for_private_call_category=...,
    use_enterprise_clid_for_private_call_category=...,
    use_incoming_clid_policy=...,
    enable_dialable_caller_id=...,
    include_redirections_in_maximum_number_of_concurrent_calls=...,
    use_user_phone_number_for_group_calls_when_internal_clid_unavailable=...,
    use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable=...,
    use_max_calls_per_second=...,
    max_calls_per_second=...,
)

print(response)