Skip to content

ServiceProviderCallProcessingGetPolicyRequest22V3

Bases: OCIRequest

Request the service provider level data associated with Call Processing Policy. The response is either a ServiceProviderCallProcessingGetPolicyResponse22V3 or an ErrorResponse.

Attributes:

service_provider_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderCallProcessingGetPolicyRequest22V3(OCIRequest):
    """Request the service provider level data associated with Call Processing
        Policy. The response is either a
        ServiceProviderCallProcessingGetPolicyResponse22V3 or an ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to ServiceProviderCallProcessingGetPolicyRequest22V3. The following elements are not returned for a service provider: enableGatewayRoutePolicy networkCallsGatewayRouteIdentity networkURLCallsGatewayRouteIdentity emergencyCallsGatewayRouteIdentity repairCallsGatewayRouteIdentity callTypingErrorsGatewayRouteIdentity The following elements are only used in AS data mode: useServiceProviderDCLIDSetting enableDialableCallerID allowConfigurableCLIDForRedirectingIdentity enterpriseCallsCLIDPolicy, value "Use Location Code plus Extension" is returned in XS data mode. groupCallsCLIDPolicy, value "Use Extension" is returned in XS data mode. enablePhoneListLookup, value "false" is returned in XS data mode. useMaxConcurrentTerminatingAlertingRequests, value "false" is returned in XS data mode. maxConcurrentTerminatingAlertingRequests, value "10" is returned in XS data mode. includeRedirectionsInMaximumNumberOfConcurrentCalls, value "false" is returned in XS data mode. useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable, value "false" is returned in XS data mode. useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable, value "false" is returned in XS data mode. allowMobileDNForRedirectingIdentity, value "false" is returned in XS data mode. The following elements are only used in AS data mode and not returned in XS data mode: enableGatewayRoutePolicy networkCallsGatewayRouteIdentity networkURLCallsGatewayRouteIdentity emergencyCallsGatewayRouteIdentity repairCallsGatewayRouteIdentity callTypingErrorsGatewayRouteIdentity

The following elements are only used in XS data mode and not returned in AS data mode: routeOverrideDomain routeOverridePrefix

Attributes:

use_service_provider_dclid_setting (bool):

use_max_simultaneous_calls (bool):

max_simultaneous_calls (int):

use_max_simultaneous_video_calls (bool):

max_simultaneous_video_calls (int):

use_max_call_time_for_answered_calls (bool):

max_call_time_for_answered_calls_minutes (int):

use_max_call_time_for_unanswered_calls (bool):

max_call_time_for_unanswered_calls_minutes (int):

media_policy_selection (str):

supported_media_set_name (Optional[str]):

network_usage_selection (str):

enforce_group_calling_line_identity_restriction (bool):

allow_enterprise_group_call_typing_for_private_dialing_plan (bool):

allow_enterprise_group_call_typing_for_public_dialing_plan (bool):

override_clid_restriction_for_private_call_category (bool):

use_enterprise_clid_for_private_call_category (bool):

enable_enterprise_extension_dialing (bool):

enforce_enterprise_calling_line_identity_restriction (bool):

use_setting_level (str):

conference_uri (Optional[str]):

use_max_concurrent_redirected_calls (bool):

max_concurrent_redirected_calls (int):

use_max_find_me_follow_me_depth (bool):

max_find_me_follow_me_depth (int):

max_redirection_depth (int):

use_max_concurrent_find_me_follow_me_invocations (bool):

max_concurrent_find_me_follow_me_invocations (int):

clid_policy (str):

emergency_clid_policy (str):

allow_alternate_numbers_for_redirecting_identity (bool):

block_calling_name_for_external_calls (bool):

enable_dialable_caller_id (bool):

allow_configurable_clid_for_redirecting_identity (bool):

enterprise_calls_clid_policy (str):

group_calls_clid_policy (str):

enable_phone_list_lookup (bool):

use_max_concurrent_terminating_alerting_requests (bool):

max_concurrent_terminating_alerting_requests (int):

include_redirections_in_maximum_number_of_concurrent_calls (bool):

use_user_phone_number_for_group_calls_when_internal_clid_unavailable (bool):

use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable (bool):

route_override_domain (Optional[str]):

route_override_prefix (Optional[str]):

allow_mobile_dn_for_redirecting_identity (bool):

enable_gateway_route_policy (Optional[bool]):

network_calls_gateway_route_identity (Optional[str]):

network_url_calls_gateway_route_identity (Optional[str]):

emergency_calls_gateway_route_identity (Optional[str]):

repair_calls_gateway_route_identity (Optional[str]):

call_typing_errors_gateway_route_identity (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
132723
132724
132725
132726
132727
132728
132729
132730
132731
132732
132733
132734
132735
132736
132737
132738
132739
132740
132741
132742
132743
132744
132745
132746
132747
132748
132749
132750
132751
132752
132753
132754
132755
132756
132757
132758
132759
132760
132761
132762
132763
132764
132765
132766
132767
132768
132769
132770
132771
132772
132773
132774
132775
132776
132777
132778
132779
132780
132781
132782
132783
132784
132785
132786
132787
132788
132789
132790
132791
132792
132793
132794
132795
132796
132797
132798
132799
132800
132801
132802
132803
132804
132805
132806
132807
132808
132809
132810
132811
132812
132813
132814
132815
132816
132817
132818
132819
132820
132821
132822
132823
132824
132825
132826
132827
132828
132829
132830
132831
132832
132833
132834
132835
132836
132837
132838
132839
132840
132841
132842
132843
132844
132845
132846
132847
132848
132849
132850
132851
132852
132853
132854
132855
132856
132857
132858
132859
132860
132861
132862
132863
132864
132865
132866
132867
132868
132869
132870
132871
132872
132873
132874
132875
132876
132877
132878
132879
132880
132881
132882
132883
132884
132885
132886
132887
132888
132889
132890
132891
132892
132893
132894
132895
132896
132897
132898
132899
132900
132901
132902
132903
132904
132905
132906
132907
132908
132909
132910
132911
132912
132913
132914
132915
132916
132917
132918
132919
132920
132921
132922
132923
132924
132925
132926
132927
132928
132929
132930
132931
132932
132933
132934
132935
132936
132937
132938
132939
132940
132941
132942
132943
132944
132945
132946
132947
132948
132949
132950
132951
132952
132953
132954
132955
132956
132957
132958
132959
132960
132961
132962
132963
132964
132965
132966
132967
132968
132969
132970
132971
132972
132973
132974
132975
132976
132977
132978
132979
132980
132981
132982
132983
132984
132985
132986
132987
132988
132989
132990
132991
132992
132993
132994
132995
132996
132997
132998
132999
133000
133001
133002
133003
133004
133005
133006
133007
133008
133009
133010
133011
133012
133013
133014
133015
133016
133017
133018
133019
133020
133021
133022
133023
133024
133025
133026
133027
133028
133029
133030
133031
133032
133033
133034
133035
133036
133037
133038
133039
133040
133041
133042
133043
133044
133045
133046
133047
133048
133049
133050
@dataclass(kw_only=True)
class ServiceProviderCallProcessingGetPolicyResponse22V3(OCIDataResponse):
    """Response to ServiceProviderCallProcessingGetPolicyRequest22V3.
        The following elements are not returned for a service provider:
          enableGatewayRoutePolicy
          networkCallsGatewayRouteIdentity
          networkURLCallsGatewayRouteIdentity
          emergencyCallsGatewayRouteIdentity
          repairCallsGatewayRouteIdentity
          callTypingErrorsGatewayRouteIdentity
        The following elements are only used in AS data mode:
          useServiceProviderDCLIDSetting
          enableDialableCallerID
          allowConfigurableCLIDForRedirectingIdentity
          enterpriseCallsCLIDPolicy, value \"Use Location Code plus Extension\" is returned in XS data mode.
          groupCallsCLIDPolicy, value \"Use Extension\" is returned in XS data mode.
          enablePhoneListLookup, value \"false\" is returned in XS data mode.
          useMaxConcurrentTerminatingAlertingRequests, value \"false\" is returned in XS data mode.
          maxConcurrentTerminatingAlertingRequests, value \"10\" is returned in XS data mode.
          includeRedirectionsInMaximumNumberOfConcurrentCalls, value \"false\" is returned in XS data mode.
          useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable, value \"false\" is returned in XS data mode.
          useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable, value \"false\" is returned in XS data mode.
          allowMobileDNForRedirectingIdentity, value \"false\" is returned in XS data mode.
        The following elements are only used in AS data mode and not returned in XS data mode:
          enableGatewayRoutePolicy
          networkCallsGatewayRouteIdentity
          networkURLCallsGatewayRouteIdentity
          emergencyCallsGatewayRouteIdentity
          repairCallsGatewayRouteIdentity
          callTypingErrorsGatewayRouteIdentity

       The following elements are only used in XS data mode and not returned in AS data mode:
          routeOverrideDomain
          routeOverridePrefix

    Attributes:

        use_service_provider_dclid_setting (bool):

        use_max_simultaneous_calls (bool):

        max_simultaneous_calls (int):

        use_max_simultaneous_video_calls (bool):

        max_simultaneous_video_calls (int):

        use_max_call_time_for_answered_calls (bool):

        max_call_time_for_answered_calls_minutes (int):

        use_max_call_time_for_unanswered_calls (bool):

        max_call_time_for_unanswered_calls_minutes (int):

        media_policy_selection (str):

        supported_media_set_name (Optional[str]):

        network_usage_selection (str):

        enforce_group_calling_line_identity_restriction (bool):

        allow_enterprise_group_call_typing_for_private_dialing_plan (bool):

        allow_enterprise_group_call_typing_for_public_dialing_plan (bool):

        override_clid_restriction_for_private_call_category (bool):

        use_enterprise_clid_for_private_call_category (bool):

        enable_enterprise_extension_dialing (bool):

        enforce_enterprise_calling_line_identity_restriction (bool):

        use_setting_level (str):

        conference_uri (Optional[str]):

        use_max_concurrent_redirected_calls (bool):

        max_concurrent_redirected_calls (int):

        use_max_find_me_follow_me_depth (bool):

        max_find_me_follow_me_depth (int):

        max_redirection_depth (int):

        use_max_concurrent_find_me_follow_me_invocations (bool):

        max_concurrent_find_me_follow_me_invocations (int):

        clid_policy (str):

        emergency_clid_policy (str):

        allow_alternate_numbers_for_redirecting_identity (bool):

        block_calling_name_for_external_calls (bool):

        enable_dialable_caller_id (bool):

        allow_configurable_clid_for_redirecting_identity (bool):

        enterprise_calls_clid_policy (str):

        group_calls_clid_policy (str):

        enable_phone_list_lookup (bool):

        use_max_concurrent_terminating_alerting_requests (bool):

        max_concurrent_terminating_alerting_requests (int):

        include_redirections_in_maximum_number_of_concurrent_calls (bool):

        use_user_phone_number_for_group_calls_when_internal_clid_unavailable (bool):

        use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable (bool):

        route_override_domain (Optional[str]):

        route_override_prefix (Optional[str]):

        allow_mobile_dn_for_redirecting_identity (bool):

        enable_gateway_route_policy (Optional[bool]):

        network_calls_gateway_route_identity (Optional[str]):

        network_url_calls_gateway_route_identity (Optional[str]):

        emergency_calls_gateway_route_identity (Optional[str]):

        repair_calls_gateway_route_identity (Optional[str]):

        call_typing_errors_gateway_route_identity (Optional[str]):

    """

    use_service_provider_dclid_setting: bool = field(
        metadata={"alias": "useServiceProviderDCLIDSetting"}
    )

    use_max_simultaneous_calls: bool = field(
        metadata={"alias": "useMaxSimultaneousCalls"}
    )

    max_simultaneous_calls: int = field(metadata={"alias": "maxSimultaneousCalls"})

    use_max_simultaneous_video_calls: bool = field(
        metadata={"alias": "useMaxSimultaneousVideoCalls"}
    )

    max_simultaneous_video_calls: int = field(
        metadata={"alias": "maxSimultaneousVideoCalls"}
    )

    use_max_call_time_for_answered_calls: bool = field(
        metadata={"alias": "useMaxCallTimeForAnsweredCalls"}
    )

    max_call_time_for_answered_calls_minutes: int = field(
        metadata={"alias": "maxCallTimeForAnsweredCallsMinutes"}
    )

    use_max_call_time_for_unanswered_calls: bool = field(
        metadata={"alias": "useMaxCallTimeForUnansweredCalls"}
    )

    max_call_time_for_unanswered_calls_minutes: int = field(
        metadata={"alias": "maxCallTimeForUnansweredCallsMinutes"}
    )

    media_policy_selection: str = field(metadata={"alias": "mediaPolicySelection"})

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

    network_usage_selection: str = field(metadata={"alias": "networkUsageSelection"})

    enforce_group_calling_line_identity_restriction: bool = field(
        metadata={"alias": "enforceGroupCallingLineIdentityRestriction"}
    )

    allow_enterprise_group_call_typing_for_private_dialing_plan: bool = field(
        metadata={"alias": "allowEnterpriseGroupCallTypingForPrivateDialingPlan"}
    )

    allow_enterprise_group_call_typing_for_public_dialing_plan: bool = field(
        metadata={"alias": "allowEnterpriseGroupCallTypingForPublicDialingPlan"}
    )

    override_clid_restriction_for_private_call_category: bool = field(
        metadata={"alias": "overrideCLIDRestrictionForPrivateCallCategory"}
    )

    use_enterprise_clid_for_private_call_category: bool = field(
        metadata={"alias": "useEnterpriseCLIDForPrivateCallCategory"}
    )

    enable_enterprise_extension_dialing: bool = field(
        metadata={"alias": "enableEnterpriseExtensionDialing"}
    )

    enforce_enterprise_calling_line_identity_restriction: bool = field(
        metadata={"alias": "enforceEnterpriseCallingLineIdentityRestriction"}
    )

    use_setting_level: str = field(metadata={"alias": "useSettingLevel"})

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

    use_max_concurrent_redirected_calls: bool = field(
        metadata={"alias": "useMaxConcurrentRedirectedCalls"}
    )

    max_concurrent_redirected_calls: int = field(
        metadata={"alias": "maxConcurrentRedirectedCalls"}
    )

    use_max_find_me_follow_me_depth: bool = field(
        metadata={"alias": "useMaxFindMeFollowMeDepth"}
    )

    max_find_me_follow_me_depth: int = field(
        metadata={"alias": "maxFindMeFollowMeDepth"}
    )

    max_redirection_depth: int = field(metadata={"alias": "maxRedirectionDepth"})

    use_max_concurrent_find_me_follow_me_invocations: bool = field(
        metadata={"alias": "useMaxConcurrentFindMeFollowMeInvocations"}
    )

    max_concurrent_find_me_follow_me_invocations: int = field(
        metadata={"alias": "maxConcurrentFindMeFollowMeInvocations"}
    )

    clid_policy: str = field(metadata={"alias": "clidPolicy"})

    emergency_clid_policy: str = field(metadata={"alias": "emergencyClidPolicy"})

    allow_alternate_numbers_for_redirecting_identity: bool = field(
        metadata={"alias": "allowAlternateNumbersForRedirectingIdentity"}
    )

    block_calling_name_for_external_calls: bool = field(
        metadata={"alias": "blockCallingNameForExternalCalls"}
    )

    enable_dialable_caller_id: bool = field(
        metadata={"alias": "enableDialableCallerID"}
    )

    allow_configurable_clid_for_redirecting_identity: bool = field(
        metadata={"alias": "allowConfigurableCLIDForRedirectingIdentity"}
    )

    enterprise_calls_clid_policy: str = field(
        metadata={"alias": "enterpriseCallsCLIDPolicy"}
    )

    group_calls_clid_policy: str = field(metadata={"alias": "groupCallsCLIDPolicy"})

    enable_phone_list_lookup: bool = field(metadata={"alias": "enablePhoneListLookup"})

    use_max_concurrent_terminating_alerting_requests: bool = field(
        metadata={"alias": "useMaxConcurrentTerminatingAlertingRequests"}
    )

    max_concurrent_terminating_alerting_requests: int = field(
        metadata={"alias": "maxConcurrentTerminatingAlertingRequests"}
    )

    include_redirections_in_maximum_number_of_concurrent_calls: bool = field(
        metadata={"alias": "includeRedirectionsInMaximumNumberOfConcurrentCalls"}
    )

    use_user_phone_number_for_group_calls_when_internal_clid_unavailable: bool = field(
        metadata={"alias": "useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable"}
    )

    use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable: bool = field(
        metadata={
            "alias": "useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable"
        }
    )

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

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

    allow_mobile_dn_for_redirecting_identity: bool = field(
        metadata={"alias": "allowMobileDNForRedirectingIdentity"}
    )

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

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

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

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

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

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

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 ServiceProviderCallProcessingGetPolicyRequest22V3

client = Client()

command = ServiceProviderCallProcessingGetPolicyRequest22V3(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)