Skip to content

SystemCallProcessingPolicyProfileUserProfileGetRequest22V3

Bases: OCIRequest

Request to get the configuration for a call processing policy profile user subscriber type profile. The response is either a SystemCallProcessingPolicyProfileUserProfileGetResponse22V3 or an ErrorResponse.

Attributes:

call_processing_policy_profile_name (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemCallProcessingPolicyProfileUserProfileGetRequest22V3(OCIRequest):
    """Request to get the configuration for a call processing policy profile user subscriber type profile.
        The response is either a SystemCallProcessingPolicyProfileUserProfileGetResponse22V3 or an ErrorResponse.

    Attributes:

        call_processing_policy_profile_name (str):

    """

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

Responses

Bases: OCIDataResponse

Response to SystemCallProcessingPolicyProfileUserProfileGetRequest22V3. The following elements are only used in AS data mode: useMaxCallsPerSecond, value "false" is returned in XS data mode. maxCallsPerSecond, value "1" is returned in XS data mode.

Attributes:

use_clid_policy (bool):

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

allow_configurable_clid_for_redirecting_identity (bool):

allow_department_clid_name_override (bool):

enterprise_calls_clid_policy (str):

enterprise_group_calls_clid_policy (str):

service_provider_group_calls_clid_policy (str):

use_media_policy (bool):

media_policy_selection (str):

supported_media_set_name (Optional[str]):

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

use_max_concurrent_redirected_calls (bool):

max_concurrent_redirected_calls (int):

use_max_concurrent_find_me_follow_me_invocations (bool):

max_concurrent_find_me_follow_me_invocations (int):

use_max_find_me_follow_me_depth (bool):

max_find_me_follow_me_depth (int):

max_redirection_depth (int):

use_translation_routing_policy (bool):

network_usage_selection (str):

enable_enterprise_extension_dialing (bool):

enforce_group_calling_line_identity_restriction (bool):

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

use_incoming_clid_policy (bool):

enable_dialable_caller_id (bool):

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

use_user_phone_number_for_group_calls_when_internal_clid_unavailable (bool):

use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable (bool):

allow_mobile_dn_for_redirecting_identity (bool):

use_max_calls_per_second (bool):

max_calls_per_second (int):
Source code in src/mercury_ocip_fast/commands/commands.py
141285
141286
141287
141288
141289
141290
141291
141292
141293
141294
141295
141296
141297
141298
141299
141300
141301
141302
141303
141304
141305
141306
141307
141308
141309
141310
141311
141312
141313
141314
141315
141316
141317
141318
141319
141320
141321
141322
141323
141324
141325
141326
141327
141328
141329
141330
141331
141332
141333
141334
141335
141336
141337
141338
141339
141340
141341
141342
141343
141344
141345
141346
141347
141348
141349
141350
141351
141352
141353
141354
141355
141356
141357
141358
141359
141360
141361
141362
141363
141364
141365
141366
141367
141368
141369
141370
141371
141372
141373
141374
141375
141376
141377
141378
141379
141380
141381
141382
141383
141384
141385
141386
141387
141388
141389
141390
141391
141392
141393
141394
141395
141396
141397
141398
141399
141400
141401
141402
141403
141404
141405
141406
141407
141408
141409
141410
141411
141412
141413
141414
141415
141416
141417
141418
141419
141420
141421
141422
141423
141424
141425
141426
141427
141428
141429
141430
141431
141432
141433
141434
141435
141436
141437
141438
141439
141440
141441
141442
141443
141444
141445
141446
141447
141448
141449
141450
141451
141452
141453
141454
141455
141456
141457
141458
141459
141460
141461
141462
141463
141464
141465
141466
141467
141468
141469
141470
141471
141472
141473
141474
141475
141476
141477
141478
141479
141480
141481
141482
141483
141484
141485
141486
141487
141488
141489
141490
141491
141492
141493
141494
141495
141496
141497
141498
141499
141500
141501
141502
141503
141504
141505
141506
141507
141508
141509
141510
141511
141512
141513
141514
141515
141516
141517
141518
141519
141520
141521
141522
141523
141524
141525
141526
141527
141528
141529
141530
141531
141532
141533
141534
141535
141536
141537
141538
141539
141540
141541
141542
141543
141544
141545
141546
141547
141548
141549
141550
141551
141552
141553
141554
141555
141556
141557
141558
141559
141560
141561
141562
141563
141564
141565
141566
141567
141568
141569
141570
141571
141572
141573
141574
@dataclass(kw_only=True)
class SystemCallProcessingPolicyProfileUserProfileGetResponse22V3(OCIDataResponse):
    """Response to SystemCallProcessingPolicyProfileUserProfileGetRequest22V3.
        The following elements are only used in AS data mode:
          useMaxCallsPerSecond, value \"false\" is returned in XS data mode.
          maxCallsPerSecond, value \"1\" is returned in XS data mode.

    Attributes:

        use_clid_policy (bool):

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

        allow_configurable_clid_for_redirecting_identity (bool):

        allow_department_clid_name_override (bool):

        enterprise_calls_clid_policy (str):

        enterprise_group_calls_clid_policy (str):

        service_provider_group_calls_clid_policy (str):

        use_media_policy (bool):

        media_policy_selection (str):

        supported_media_set_name (Optional[str]):

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

        use_max_concurrent_redirected_calls (bool):

        max_concurrent_redirected_calls (int):

        use_max_concurrent_find_me_follow_me_invocations (bool):

        max_concurrent_find_me_follow_me_invocations (int):

        use_max_find_me_follow_me_depth (bool):

        max_find_me_follow_me_depth (int):

        max_redirection_depth (int):

        use_translation_routing_policy (bool):

        network_usage_selection (str):

        enable_enterprise_extension_dialing (bool):

        enforce_group_calling_line_identity_restriction (bool):

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

        use_incoming_clid_policy (bool):

        enable_dialable_caller_id (bool):

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

        use_user_phone_number_for_group_calls_when_internal_clid_unavailable (bool):

        use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable (bool):

        allow_mobile_dn_for_redirecting_identity (bool):

        use_max_calls_per_second (bool):

        max_calls_per_second (int):

    """

    use_clid_policy: bool = field(metadata={"alias": "useCLIDPolicy"})

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

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

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

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

    enterprise_group_calls_clid_policy: str = field(
        metadata={"alias": "enterpriseGroupCallsCLIDPolicy"}
    )

    service_provider_group_calls_clid_policy: str = field(
        metadata={"alias": "serviceProviderGroupCallsCLIDPolicy"}
    )

    use_media_policy: bool = field(metadata={"alias": "useMediaPolicy"})

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

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

    use_call_limits_policy: bool = field(metadata={"alias": "useCallLimitsPolicy"})

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

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

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

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

    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_translation_routing_policy: bool = field(
        metadata={"alias": "useTranslationRoutingPolicy"}
    )

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

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

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

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

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

    use_incoming_clid_policy: bool = field(metadata={"alias": "useIncomingCLIDPolicy"})

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

    use_phone_list_lookup_policy: bool = field(
        metadata={"alias": "usePhoneListLookupPolicy"}
    )

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

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

    use_max_calls_per_second: bool = field(metadata={"alias": "useMaxCallsPerSecond"})

    max_calls_per_second: int = field(metadata={"alias": "maxCallsPerSecond"})

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 SystemCallProcessingPolicyProfileUserProfileGetRequest22V3

client = Client()

command = SystemCallProcessingPolicyProfileUserProfileGetRequest22V3(
    call_processing_policy_profile_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemCallProcessingPolicyProfileUserProfileGetRequest22V3",
    call_processing_policy_profile_name=...,
)

print(response)