Skip to content

UserCallProcessingModifyPolicyRequest14sp7

Bases: OCIRequest

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

  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 the Caller ID Lookup settings (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

  The following elements are only used in AS data mode and ignored in XS data mode:
   useUserPhoneListLookupSetting
   enablePhoneListLookup
   useMaxConcurrentTerminatingAlertingRequests
   maxConcurrentTerminatingAlertingRequests
   includeRedirectionsInMaximumNumberOfConcurrentCalls
   allowMobileDNForRedirectingIdentity
   allowUserSelectionOfExternalCLIDPolicy
   allowUserConfigurableCLIDModification


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

Attributes:

user_id (str):

use_user_clid_setting (Optional[bool]):

use_user_media_setting (Optional[bool]):

use_user_call_limits_setting (Optional[bool]):

use_user_dclid_setting (Optional[bool]):

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

media_policy_selection (Optional[str]):

supported_media_set_name (Optional[Nillable[str]]):

use_max_concurrent_redirected_calls (Optional[bool]):

max_concurrent_redirected_calls (Optional[int]):

use_max_find_me_follow_me_depth (Optional[bool]):

max_find_me_follow_me_depth (Optional[int]):

max_redirection_depth (Optional[int]):

use_max_concurrent_find_me_follow_me_invocations (Optional[bool]):

max_concurrent_find_me_follow_me_invocations (Optional[int]):

clid_policy (Optional[str]):

emergency_clid_policy (Optional[str]):

allow_alternate_numbers_for_redirecting_identity (Optional[bool]):

use_group_name (Optional[bool]):

enable_dialable_caller_id (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]):

use_user_phone_list_lookup_setting (Optional[bool]):

enable_phone_list_lookup (Optional[bool]):

use_max_concurrent_terminating_alerting_requests (Optional[bool]):

max_concurrent_terminating_alerting_requests (Optional[int]):

include_redirections_in_maximum_number_of_concurrent_calls (Optional[bool]):

route_override_domain (Optional[Nillable[str]]):

route_override_prefix (Optional[Nillable[str]]):

allow_mobile_dn_for_redirecting_identity (Optional[bool]):

allow_user_selection_of_external_clid_policy (Optional[bool]):

allow_user_configurable_clid_modification (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
104493
104494
104495
104496
104497
104498
104499
104500
104501
104502
104503
104504
104505
104506
104507
104508
104509
104510
104511
104512
104513
104514
104515
104516
104517
104518
104519
104520
104521
104522
104523
104524
104525
104526
104527
104528
104529
104530
104531
104532
104533
104534
104535
104536
104537
104538
104539
104540
104541
104542
104543
104544
104545
104546
104547
104548
104549
104550
104551
104552
104553
104554
104555
104556
104557
104558
104559
104560
104561
104562
104563
104564
104565
104566
104567
104568
104569
104570
104571
104572
104573
104574
104575
104576
104577
104578
104579
104580
104581
104582
104583
104584
104585
104586
104587
104588
104589
104590
104591
104592
104593
104594
104595
104596
104597
104598
104599
104600
104601
104602
104603
104604
104605
104606
104607
104608
104609
104610
104611
104612
104613
104614
104615
104616
104617
104618
104619
104620
104621
104622
104623
104624
104625
104626
104627
104628
104629
104630
104631
104632
104633
104634
104635
104636
104637
104638
104639
104640
104641
104642
104643
104644
104645
104646
104647
104648
104649
104650
104651
104652
104653
104654
104655
104656
104657
104658
104659
104660
104661
104662
104663
104664
104665
104666
104667
104668
104669
104670
104671
104672
104673
104674
104675
104676
104677
104678
104679
104680
104681
104682
104683
104684
104685
104686
104687
104688
104689
104690
104691
104692
104693
104694
104695
104696
104697
104698
104699
104700
104701
104702
104703
104704
104705
104706
104707
104708
104709
104710
104711
104712
104713
104714
104715
104716
104717
104718
104719
104720
104721
104722
104723
104724
104725
104726
104727
104728
104729
104730
104731
104732
104733
104734
104735
104736
104737
104738
104739
104740
104741
104742
104743
104744
104745
104746
104747
104748
104749
104750
104751
104752
104753
104754
104755
104756
104757
104758
104759
104760
104761
104762
104763
104764
104765
104766
104767
104768
104769
104770
104771
104772
104773
104774
104775
104776
104777
104778
104779
104780
104781
104782
104783
104784
104785
104786
104787
104788
104789
104790
104791
104792
104793
104794
104795
@dataclass(kw_only=True)
class UserCallProcessingModifyPolicyRequest14sp7(OCIRequest):
    """Modify the user level data associated with Call Processing Policy.
          The response is either a SuccessResponse or an ErrorResponse.

          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 the Caller ID Lookup settings (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

          The following elements are only used in AS data mode and ignored in XS data mode:
           useUserPhoneListLookupSetting
           enablePhoneListLookup
           useMaxConcurrentTerminatingAlertingRequests
           maxConcurrentTerminatingAlertingRequests
           includeRedirectionsInMaximumNumberOfConcurrentCalls
           allowMobileDNForRedirectingIdentity
           allowUserSelectionOfExternalCLIDPolicy
           allowUserConfigurableCLIDModification


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

    Attributes:

        user_id (str):

        use_user_clid_setting (Optional[bool]):

        use_user_media_setting (Optional[bool]):

        use_user_call_limits_setting (Optional[bool]):

        use_user_dclid_setting (Optional[bool]):

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

        media_policy_selection (Optional[str]):

        supported_media_set_name (Optional[Nillable[str]]):

        use_max_concurrent_redirected_calls (Optional[bool]):

        max_concurrent_redirected_calls (Optional[int]):

        use_max_find_me_follow_me_depth (Optional[bool]):

        max_find_me_follow_me_depth (Optional[int]):

        max_redirection_depth (Optional[int]):

        use_max_concurrent_find_me_follow_me_invocations (Optional[bool]):

        max_concurrent_find_me_follow_me_invocations (Optional[int]):

        clid_policy (Optional[str]):

        emergency_clid_policy (Optional[str]):

        allow_alternate_numbers_for_redirecting_identity (Optional[bool]):

        use_group_name (Optional[bool]):

        enable_dialable_caller_id (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]):

        use_user_phone_list_lookup_setting (Optional[bool]):

        enable_phone_list_lookup (Optional[bool]):

        use_max_concurrent_terminating_alerting_requests (Optional[bool]):

        max_concurrent_terminating_alerting_requests (Optional[int]):

        include_redirections_in_maximum_number_of_concurrent_calls (Optional[bool]):

        route_override_domain (Optional[Nillable[str]]):

        route_override_prefix (Optional[Nillable[str]]):

        allow_mobile_dn_for_redirecting_identity (Optional[bool]):

        allow_user_selection_of_external_clid_policy (Optional[bool]):

        allow_user_configurable_clid_modification (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "supported_media_set_name",
            "route_override_domain",
            "route_override_prefix",
        ]
        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/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 UserCallProcessingModifyPolicyRequest14sp7

client = Client()

command = UserCallProcessingModifyPolicyRequest14sp7(
    user_id=...,
    use_user_clid_setting=...,
    use_user_media_setting=...,
    use_user_call_limits_setting=...,
    use_user_dclid_setting=...,
    use_user_translation_routing_setting=...,
    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=...,
    media_policy_selection=...,
    supported_media_set_name=...,
    use_max_concurrent_redirected_calls=...,
    max_concurrent_redirected_calls=...,
    use_max_find_me_follow_me_depth=...,
    max_find_me_follow_me_depth=...,
    max_redirection_depth=...,
    use_max_concurrent_find_me_follow_me_invocations=...,
    max_concurrent_find_me_follow_me_invocations=...,
    clid_policy=...,
    emergency_clid_policy=...,
    allow_alternate_numbers_for_redirecting_identity=...,
    use_group_name=...,
    enable_dialable_caller_id=...,
    block_calling_name_for_external_calls=...,
    allow_configurable_clid_for_redirecting_identity=...,
    allow_department_clid_name_override=...,
    use_user_phone_list_lookup_setting=...,
    enable_phone_list_lookup=...,
    use_max_concurrent_terminating_alerting_requests=...,
    max_concurrent_terminating_alerting_requests=...,
    include_redirections_in_maximum_number_of_concurrent_calls=...,
    route_override_domain=...,
    route_override_prefix=...,
    allow_mobile_dn_for_redirecting_identity=...,
    allow_user_selection_of_external_clid_policy=...,
    allow_user_configurable_clid_modification=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallProcessingModifyPolicyRequest14sp7",
    user_id=...,
    use_user_clid_setting=...,
    use_user_media_setting=...,
    use_user_call_limits_setting=...,
    use_user_dclid_setting=...,
    use_user_translation_routing_setting=...,
    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=...,
    media_policy_selection=...,
    supported_media_set_name=...,
    use_max_concurrent_redirected_calls=...,
    max_concurrent_redirected_calls=...,
    use_max_find_me_follow_me_depth=...,
    max_find_me_follow_me_depth=...,
    max_redirection_depth=...,
    use_max_concurrent_find_me_follow_me_invocations=...,
    max_concurrent_find_me_follow_me_invocations=...,
    clid_policy=...,
    emergency_clid_policy=...,
    allow_alternate_numbers_for_redirecting_identity=...,
    use_group_name=...,
    enable_dialable_caller_id=...,
    block_calling_name_for_external_calls=...,
    allow_configurable_clid_for_redirecting_identity=...,
    allow_department_clid_name_override=...,
    use_user_phone_list_lookup_setting=...,
    enable_phone_list_lookup=...,
    use_max_concurrent_terminating_alerting_requests=...,
    max_concurrent_terminating_alerting_requests=...,
    include_redirections_in_maximum_number_of_concurrent_calls=...,
    route_override_domain=...,
    route_override_prefix=...,
    allow_mobile_dn_for_redirecting_identity=...,
    allow_user_selection_of_external_clid_policy=...,
    allow_user_configurable_clid_modification=...,
)

print(response)