Skip to content

GroupCallProcessingGetPolicyRequest22V3

Bases: OCIRequest

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

The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowDepartmentCLIDNameOverride)

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

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

The useGroupTranslationRoutingSetting attribute controls the routing and translation settings
(networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing)

Attributes:

service_provider_id (str):

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

        The useGroupCLIDSetting attribute controls the CLID settings
        (clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowDepartmentCLIDNameOverride)

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

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

        The useGroupTranslationRoutingSetting attribute controls the routing and translation settings
        (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
        allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing)

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

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

    group_id: str = field(metadata={"alias": "groupId"})

Responses

Bases: OCIDataResponse

Response to GroupCallProcessingGetPolicyRequest22V3. The following elements are not returned for a group within a service provider: enableGatewayRoutePolicy networkCallsGatewayRouteIdentity networkURLCallsGatewayRouteIdentity emergencyCallsGatewayRouteIdentity repairCallsGatewayRouteIdentity callTypingErrorsGatewayRouteIdentity

The following elements are only used in AS data mode:
  useGroupDCLIDSetting
  enableDialableCallerID
  allowConfigurableCLIDForRedirectingIdentity
  allowDepartmentCLIDNameOverride
  enterpriseCallsCLIDPolicy, value "Use Location Code plus Extension" is returned in XS data mode.
  groupCallsCLIDPolicy, value "Use Extension" is returned in XS data mode.
  useGroupPhoneListLookupSetting, 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.
  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_group_clid_setting (bool):

use_group_media_setting (bool):

use_group_call_limits_setting (bool):

use_group_translation_routing_setting (bool):

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

use_enterprise_clid_for_private_call_category (Optional[bool]):

enable_enterprise_extension_dialing (bool):

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

enterprise_calls_clid_policy (str):

group_calls_clid_policy (str):

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

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/commands/commands.py
124042
124043
124044
124045
124046
124047
124048
124049
124050
124051
124052
124053
124054
124055
124056
124057
124058
124059
124060
124061
124062
124063
124064
124065
124066
124067
124068
124069
124070
124071
124072
124073
124074
124075
124076
124077
124078
124079
124080
124081
124082
124083
124084
124085
124086
124087
124088
124089
124090
124091
124092
124093
124094
124095
124096
124097
124098
124099
124100
124101
124102
124103
124104
124105
124106
124107
124108
124109
124110
124111
124112
124113
124114
124115
124116
124117
124118
124119
124120
124121
124122
124123
124124
124125
124126
124127
124128
124129
124130
124131
124132
124133
124134
124135
124136
124137
124138
124139
124140
124141
124142
124143
124144
124145
124146
124147
124148
124149
124150
124151
124152
124153
124154
124155
124156
124157
124158
124159
124160
124161
124162
124163
124164
124165
124166
124167
124168
124169
124170
124171
124172
124173
124174
124175
124176
124177
124178
124179
124180
124181
124182
124183
124184
124185
124186
124187
124188
124189
124190
124191
124192
124193
124194
124195
124196
124197
124198
124199
124200
124201
124202
124203
124204
124205
124206
124207
124208
124209
124210
124211
124212
124213
124214
124215
124216
124217
124218
124219
124220
124221
124222
124223
124224
124225
124226
124227
124228
124229
124230
124231
124232
124233
124234
124235
124236
124237
124238
124239
124240
124241
124242
124243
124244
124245
124246
124247
124248
124249
124250
124251
124252
124253
124254
124255
124256
124257
124258
124259
124260
124261
124262
124263
124264
124265
124266
124267
124268
124269
124270
124271
124272
124273
124274
124275
124276
124277
124278
124279
124280
124281
124282
124283
124284
124285
124286
124287
124288
124289
124290
124291
124292
124293
124294
124295
124296
124297
124298
124299
124300
124301
124302
124303
124304
124305
124306
124307
124308
124309
124310
124311
124312
124313
124314
124315
124316
124317
124318
124319
124320
124321
124322
124323
124324
124325
124326
124327
124328
124329
124330
124331
124332
124333
124334
124335
124336
124337
124338
124339
124340
124341
124342
124343
124344
124345
124346
124347
124348
124349
124350
124351
124352
124353
124354
124355
124356
124357
124358
124359
124360
124361
124362
124363
124364
124365
124366
124367
124368
124369
124370
124371
124372
124373
124374
124375
124376
124377
124378
124379
124380
124381
124382
124383
124384
124385
124386
124387
124388
124389
124390
124391
124392
@dataclass(kw_only=True)
class GroupCallProcessingGetPolicyResponse22V3(OCIDataResponse):
    """Response to GroupCallProcessingGetPolicyRequest22V3.
        The following elements are not returned for a group within a service provider:
          enableGatewayRoutePolicy
          networkCallsGatewayRouteIdentity
          networkURLCallsGatewayRouteIdentity
          emergencyCallsGatewayRouteIdentity
          repairCallsGatewayRouteIdentity
          callTypingErrorsGatewayRouteIdentity

        The following elements are only used in AS data mode:
          useGroupDCLIDSetting
          enableDialableCallerID
          allowConfigurableCLIDForRedirectingIdentity
          allowDepartmentCLIDNameOverride
          enterpriseCallsCLIDPolicy, value \"Use Location Code plus Extension\" is returned in XS data mode.
          groupCallsCLIDPolicy, value \"Use Extension\" is returned in XS data mode.
          useGroupPhoneListLookupSetting, 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.
          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_group_clid_setting (bool):

        use_group_media_setting (bool):

        use_group_call_limits_setting (bool):

        use_group_translation_routing_setting (bool):

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

        use_enterprise_clid_for_private_call_category (Optional[bool]):

        enable_enterprise_extension_dialing (bool):

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

        enterprise_calls_clid_policy (str):

        group_calls_clid_policy (str):

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

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

    use_group_media_setting: bool = field(metadata={"alias": "useGroupMediaSetting"})

    use_group_call_limits_setting: bool = field(
        metadata={"alias": "useGroupCallLimitsSetting"}
    )

    use_group_translation_routing_setting: bool = field(
        metadata={"alias": "useGroupTranslationRoutingSetting"}
    )

    use_group_dclid_setting: bool = field(metadata={"alias": "useGroupDCLIDSetting"})

    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: Optional[bool] = field(
        default=None,
        metadata={"alias": "overrideCLIDRestrictionForPrivateCallCategory"},
    )

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

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

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

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

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

    use_group_phone_list_lookup_setting: bool = field(
        metadata={"alias": "useGroupPhoneListLookupSetting"}
    )

    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/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 GroupCallProcessingGetPolicyRequest22V3

client = Client()

command = GroupCallProcessingGetPolicyRequest22V3(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallProcessingGetPolicyRequest22V3",
    service_provider_id=...,
    group_id=...,
)

print(response)