Skip to content

SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3

Bases: OCIRequest

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

Attributes:

call_processing_policy_profile_name (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3(OCIRequest):
    """Request to get the configuration for a call processing policy profile Trunk Group Pilot user subscriber type profile.
        The response is either a SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse22V3 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 SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3. 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_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/commands/commands.py
140997
140998
140999
141000
141001
141002
141003
141004
141005
141006
141007
141008
141009
141010
141011
141012
141013
141014
141015
141016
141017
141018
141019
141020
141021
141022
141023
141024
141025
141026
141027
141028
141029
141030
141031
141032
141033
141034
141035
141036
141037
141038
141039
141040
141041
141042
141043
141044
141045
141046
141047
141048
141049
141050
141051
141052
141053
141054
141055
141056
141057
141058
141059
141060
141061
141062
141063
141064
141065
141066
141067
141068
141069
141070
141071
141072
141073
141074
141075
141076
141077
141078
141079
141080
141081
141082
141083
141084
141085
141086
141087
141088
141089
141090
141091
141092
141093
141094
141095
141096
141097
141098
141099
141100
141101
141102
141103
141104
141105
141106
141107
141108
141109
141110
141111
141112
141113
141114
141115
141116
141117
141118
141119
141120
141121
141122
141123
141124
141125
141126
141127
141128
141129
141130
141131
141132
141133
141134
141135
141136
141137
141138
141139
141140
141141
141142
141143
141144
141145
141146
141147
141148
141149
141150
141151
141152
141153
141154
141155
141156
141157
141158
141159
141160
141161
141162
141163
141164
141165
141166
141167
141168
141169
141170
141171
141172
141173
141174
141175
141176
141177
141178
141179
141180
141181
141182
141183
141184
141185
141186
141187
141188
141189
141190
141191
141192
141193
141194
141195
141196
141197
141198
141199
141200
141201
141202
141203
141204
141205
141206
141207
141208
141209
141210
141211
141212
141213
141214
141215
141216
141217
141218
141219
141220
141221
141222
141223
141224
141225
141226
141227
141228
141229
141230
141231
141232
141233
141234
141235
141236
141237
141238
141239
141240
141241
141242
141243
141244
141245
141246
141247
141248
141249
141250
141251
141252
141253
141254
141255
141256
141257
141258
141259
141260
141261
141262
141263
141264
141265
141266
141267
141268
141269
141270
141271
141272
141273
141274
141275
141276
141277
141278
@dataclass(kw_only=True)
class SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse22V3(
    OCIDataResponse
):
    """Response to SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3.
        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_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_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/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 SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3

client = Client()

command = SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3(
    call_processing_policy_profile_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

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

print(response)