Skip to content

UserCallProcessingGetPolicyRequest23

Bases: OCIRequest

Request the user level data associated with Call Processing Policy. The response is either a UserCallProcessingGetPolicyResponse23 or an ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserCallProcessingGetPolicyRequest23(OCIRequest):
    """Request the user level data associated with Call Processing Policy.
        The response is either a UserCallProcessingGetPolicyResponse23 or an
        ErrorResponse.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to UserCallProcessingGetPolicyRequest23. The useUserCLIDSetting attribute controls the CLID settings (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride)

The useUserMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName)

The useUserCallLimitsSetting attribute controls the Call Limits setting
(useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls,
maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth,
maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests,
includeRedirectionsInMaximumNumberOfConcurrentCalls)

The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID)

The useUserPhoneListLookupSetting controls whether or not to use the group setting for the Phone List Lookup policy (enablePhoneListLookup)

The useUserTranslationRoutingSetting attribute controls the routing and translation settings (routeOverrideDomain, routeOverridePrefix)

The following elements are only used in AS data mode:
 useUserDCLIDSetting
 enableDialableCallerID
 allowConfigurableCLIDForRedirectingIdentity
 allowDepartmentCLIDNameOverride
 useUserPhoneListLookupSetting, value "false" 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.
 allowMobileDNForRedirectingIdentity,value "false" is returned in XS data mode.
 allowUserSelectionOfExternalCLIDPolicy,value "false" is returned in XS data mode.
 allowUserConfigurableCLIDModification,value "false" is returned in XS data mode.

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

The following elements are only used in XS data mode:
   useUserTranslationRoutingSetting, value "false" is returned in AS data mode.

Attributes:

use_user_clid_setting (bool):

use_user_media_setting (bool):

use_user_call_limits_setting (bool):

use_user_dclid_setting (bool):

use_user_translation_routing_setting (Optional[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]):

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):

use_group_name (bool):

block_calling_name_for_external_calls (bool):

enable_dialable_caller_id (bool):

allow_configurable_clid_for_redirecting_identity (bool):

allow_department_clid_name_override (bool):

use_user_phone_list_lookup_setting (bool):

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):

route_override_domain (Optional[str]):

route_override_prefix (Optional[str]):

allow_mobile_dn_for_redirecting_identity (bool):

allow_user_selection_of_external_clid_policy (bool):

allow_user_configurable_clid_modification (bool):
Source code in src/mercury_ocip/commands/commands.py
152629
152630
152631
152632
152633
152634
152635
152636
152637
152638
152639
152640
152641
152642
152643
152644
152645
152646
152647
152648
152649
152650
152651
152652
152653
152654
152655
152656
152657
152658
152659
152660
152661
152662
152663
152664
152665
152666
152667
152668
152669
152670
152671
152672
152673
152674
152675
152676
152677
152678
152679
152680
152681
152682
152683
152684
152685
152686
152687
152688
152689
152690
152691
152692
152693
152694
152695
152696
152697
152698
152699
152700
152701
152702
152703
152704
152705
152706
152707
152708
152709
152710
152711
152712
152713
152714
152715
152716
152717
152718
152719
152720
152721
152722
152723
152724
152725
152726
152727
152728
152729
152730
152731
152732
152733
152734
152735
152736
152737
152738
152739
152740
152741
152742
152743
152744
152745
152746
152747
152748
152749
152750
152751
152752
152753
152754
152755
152756
152757
152758
152759
152760
152761
152762
152763
152764
152765
152766
152767
152768
152769
152770
152771
152772
152773
152774
152775
152776
152777
152778
152779
152780
152781
152782
152783
152784
152785
152786
152787
152788
152789
152790
152791
152792
152793
152794
152795
152796
152797
152798
152799
152800
152801
152802
152803
152804
152805
152806
152807
152808
152809
152810
152811
152812
152813
152814
152815
152816
152817
152818
152819
152820
152821
152822
152823
152824
152825
152826
152827
152828
152829
152830
152831
152832
152833
152834
152835
152836
152837
152838
152839
152840
152841
152842
152843
152844
152845
152846
152847
152848
152849
152850
152851
152852
152853
152854
152855
152856
152857
152858
152859
152860
152861
152862
152863
152864
152865
152866
152867
152868
152869
152870
152871
152872
152873
152874
152875
152876
152877
152878
152879
152880
152881
152882
152883
152884
152885
152886
152887
152888
152889
152890
152891
152892
152893
152894
152895
@dataclass(kw_only=True)
class UserCallProcessingGetPolicyResponse23(OCIDataResponse):
    """Response to UserCallProcessingGetPolicyRequest23.
     The useUserCLIDSetting attribute controls the CLID settings
     (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride)

        The useUserMediaSetting attribute controls the Media settings
        (medisPolicySelection, supportedMediaSetName)

        The useUserCallLimitsSetting attribute controls the Call Limits setting
        (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
        useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls,
        maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth,
        maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
        useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests,
        includeRedirectionsInMaximumNumberOfConcurrentCalls)

        The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID)

        The useUserPhoneListLookupSetting controls whether or not to use the group setting for the Phone List Lookup policy (enablePhoneListLookup)

        The useUserTranslationRoutingSetting attribute controls the routing and translation settings (routeOverrideDomain, routeOverridePrefix)

        The following elements are only used in AS data mode:
         useUserDCLIDSetting
         enableDialableCallerID
         allowConfigurableCLIDForRedirectingIdentity
         allowDepartmentCLIDNameOverride
         useUserPhoneListLookupSetting, value \"false\" 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.
         allowMobileDNForRedirectingIdentity,value \"false\" is returned in XS data mode.
         allowUserSelectionOfExternalCLIDPolicy,value \"false\" is returned in XS data mode.
         allowUserConfigurableCLIDModification,value \"false\" is returned in XS data mode.

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

        The following elements are only used in XS data mode:
           useUserTranslationRoutingSetting, value \"false\" is returned in AS data mode.

    Attributes:

        use_user_clid_setting (bool):

        use_user_media_setting (bool):

        use_user_call_limits_setting (bool):

        use_user_dclid_setting (bool):

        use_user_translation_routing_setting (Optional[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]):

        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):

        use_group_name (bool):

        block_calling_name_for_external_calls (bool):

        enable_dialable_caller_id (bool):

        allow_configurable_clid_for_redirecting_identity (bool):

        allow_department_clid_name_override (bool):

        use_user_phone_list_lookup_setting (bool):

        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):

        route_override_domain (Optional[str]):

        route_override_prefix (Optional[str]):

        allow_mobile_dn_for_redirecting_identity (bool):

        allow_user_selection_of_external_clid_policy (bool):

        allow_user_configurable_clid_modification (bool):

    """

    use_user_clid_setting: bool = field(metadata={"alias": "useUserCLIDSetting"})

    use_user_media_setting: bool = field(metadata={"alias": "useUserMediaSetting"})

    use_user_call_limits_setting: bool = field(
        metadata={"alias": "useUserCallLimitsSetting"}
    )

    use_user_dclid_setting: bool = field(metadata={"alias": "useUserDCLIDSetting"})

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

    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"}
    )

    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"}
    )

    use_group_name: bool = field(metadata={"alias": "useGroupName"})

    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"}
    )

    allow_department_clid_name_override: bool = field(
        metadata={"alias": "allowDepartmentCLIDNameOverride"}
    )

    use_user_phone_list_lookup_setting: bool = field(
        metadata={"alias": "useUserPhoneListLookupSetting"}
    )

    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"}
    )

    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"}
    )

    allow_user_selection_of_external_clid_policy: bool = field(
        metadata={"alias": "allowUserSelectionOfExternalCLIDPolicy"}
    )

    allow_user_configurable_clid_modification: bool = field(
        metadata={"alias": "allowUserConfigurableCLIDModification"}
    )

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 UserCallProcessingGetPolicyRequest23

client = Client()

command = UserCallProcessingGetPolicyRequest23(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallProcessingGetPolicyRequest23",
    user_id=...,
)

print(response)