Skip to content

GroupTrunkGroupGetInstanceRequest23

Bases: OCIRequest

Get a Trunk Group Instance's profile. The response is either a GroupTrunkGroupGetInstanceResponse23 or an ErrorResponse. The response contains a hosted user table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".

Attributes:

trunk_group_key (TrunkGroupKey):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupTrunkGroupGetInstanceRequest23(OCIRequest):
    """Get a Trunk Group Instance's profile.
        The response is either a GroupTrunkGroupGetInstanceResponse23 or an ErrorResponse.
        The response contains a hosted user table with column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\", \"Phone Number\", \"Extension\",
        \"Department\", \"Email Address\".

    Attributes:

        trunk_group_key (TrunkGroupKey):

    """

    trunk_group_key: TrunkGroupKey = field(metadata={"alias": "trunkGroupKey"})

Responses

Bases: OCIDataResponse

Response to GroupTrunkGroupGetInstanceRequest23. Returns the profile information for the Trunk Group. Contains a hosted user table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". Following attributes are only used in IMS mode: implicitRegistrationSetSupportPolicy useSystemImplicitRegistrationSetSupportPolicy sipIdentityForPilotAndProxyTrunkModesPolicy useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy

Attributes:

pilot_user_id (Optional[str]):

department (Optional[DepartmentKey]):

access_device (Optional[AccessDevice]):

max_active_calls (int):

max_incoming_calls (Optional[int]):

max_outgoing_calls (Optional[int]):

enable_bursting (bool):

bursting_max_active_calls (Optional[int]):

bursting_max_incoming_calls (Optional[int]):

bursting_max_outgoing_calls (Optional[int]):

capacity_exceeded_action (Optional[str]):

capacity_exceeded_forward_address (Optional[str]):

capacity_exceeded_reroute_trunk_group_key (Optional[TrunkGroupKey]):

capacity_exceeded_trap_initial_calls (int):

capacity_exceeded_trap_offset_calls (int):

unreachable_destination_action (Optional[str]):

unreachable_destination_forward_address (Optional[str]):

unreachable_destination_reroute_trunk_group_key (Optional[TrunkGroupKey]):

invitation_timeout (int):

require_authentication (bool):

sip_authentication_user_name (Optional[str]):

hosted_user_table (Optional[OCITable]):

trunk_group_identity (Optional[str]):

otg_dtg_identity (Optional[str]):

allow_termination_to_trunk_group_identity (bool):

allow_termination_to_dtg_identity (bool):

include_trunk_group_identity (bool):

include_dtg_identity (bool):

include_trunk_group_identity_for_network_calls (bool):

include_otg_identity_for_network_calls (bool):

enable_network_address_identity (bool):

allow_unscreened_calls (bool):

allow_unscreened_emergency_calls (bool):

pilot_user_calling_line_identity_for_external_calls_policy (str):

pilot_user_charge_number_policy (str):

call_forwarding_always_action (Optional[str]):

call_forwarding_always_forward_address (Optional[str]):

call_forwarding_always_reroute_trunk_group_key (Optional[TrunkGroupKey]):

peering_domain (Optional[str]):

route_to_peering_domain (bool):

prefix_enabled (bool):

prefix (Optional[str]):

stateful_rerouting_enabled (bool):

send_continuous_options_message (bool):

continuous_options_sending_interval_seconds (int):

failure_options_sending_interval_seconds (int):

failure_threshold_counter (int):

success_threshold_counter (int):

invite_failure_threshold_counter (int):

invite_failure_threshold_window_seconds (int):

trunk_group_state (str):

pilot_user_calling_line_asserted_identity_policy (str):

use_system_calling_line_asserted_identity_policy (bool):

total_active_incoming_calls (int):

total_active_outgoing_calls (int):

pilot_user_call_optimization_policy (str):

clid_source_for_screened_calls_policy (str):

use_system_clid_source_for_screened_calls_policy (bool):

user_lookup_policy (str):

use_system_user_lookup_policy (bool):

pilot_user_calling_line_identity_for_emergency_calls_policy (str):

implicit_registration_set_support_policy (str):

use_system_implicit_registration_set_support_policy (bool):

sip_identity_for_pilot_and_proxy_trunk_modes_policy (str):

use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy (bool):

use_system_support_connected_identity_policy (bool):

support_connected_identity_policy (str):

use_system_options_message_response_status_codes (bool):

options_message_response_status_code (Optional[List[str]]):
Source code in src/mercury_ocip/commands/commands.py
129815
129816
129817
129818
129819
129820
129821
129822
129823
129824
129825
129826
129827
129828
129829
129830
129831
129832
129833
129834
129835
129836
129837
129838
129839
129840
129841
129842
129843
129844
129845
129846
129847
129848
129849
129850
129851
129852
129853
129854
129855
129856
129857
129858
129859
129860
129861
129862
129863
129864
129865
129866
129867
129868
129869
129870
129871
129872
129873
129874
129875
129876
129877
129878
129879
129880
129881
129882
129883
129884
129885
129886
129887
129888
129889
129890
129891
129892
129893
129894
129895
129896
129897
129898
129899
129900
129901
129902
129903
129904
129905
129906
129907
129908
129909
129910
129911
129912
129913
129914
129915
129916
129917
129918
129919
129920
129921
129922
129923
129924
129925
129926
129927
129928
129929
129930
129931
129932
129933
129934
129935
129936
129937
129938
129939
129940
129941
129942
129943
129944
129945
129946
129947
129948
129949
129950
129951
129952
129953
129954
129955
129956
129957
129958
129959
129960
129961
129962
129963
129964
129965
129966
129967
129968
129969
129970
129971
129972
129973
129974
129975
129976
129977
129978
129979
129980
129981
129982
129983
129984
129985
129986
129987
129988
129989
129990
129991
129992
129993
129994
129995
129996
129997
129998
129999
130000
130001
130002
130003
130004
130005
130006
130007
130008
130009
130010
130011
130012
130013
130014
130015
130016
130017
130018
130019
130020
130021
130022
130023
130024
130025
130026
130027
130028
130029
130030
130031
130032
130033
130034
130035
130036
130037
130038
130039
130040
130041
130042
130043
130044
130045
130046
130047
130048
130049
130050
130051
130052
130053
130054
130055
130056
130057
130058
130059
130060
130061
130062
130063
130064
130065
130066
130067
130068
130069
130070
130071
130072
130073
130074
130075
130076
130077
130078
130079
130080
130081
130082
130083
130084
130085
130086
130087
130088
130089
130090
130091
130092
130093
130094
130095
130096
130097
130098
130099
130100
130101
130102
130103
130104
130105
130106
130107
130108
130109
130110
130111
130112
130113
130114
130115
130116
130117
130118
130119
130120
130121
130122
130123
130124
130125
130126
130127
130128
130129
130130
130131
130132
130133
130134
130135
130136
130137
130138
130139
130140
130141
130142
130143
130144
130145
130146
130147
130148
130149
130150
130151
130152
130153
130154
130155
130156
130157
130158
130159
130160
130161
130162
130163
130164
130165
130166
130167
130168
130169
130170
130171
130172
130173
130174
130175
130176
130177
130178
130179
130180
130181
130182
130183
130184
130185
130186
130187
130188
130189
130190
130191
130192
130193
130194
130195
130196
130197
130198
130199
130200
130201
130202
130203
130204
130205
130206
130207
130208
130209
130210
130211
130212
130213
130214
130215
130216
130217
130218
130219
130220
130221
130222
@dataclass(kw_only=True)
class GroupTrunkGroupGetInstanceResponse23(OCIDataResponse):
    """Response to GroupTrunkGroupGetInstanceRequest23.
        Returns the profile information for the Trunk Group.
        Contains a hosted user table with column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\", \"Phone Number\",
        \"Extension\", \"Department\", \"Email Address\".
        Following attributes are only used in IMS mode:
          implicitRegistrationSetSupportPolicy
          useSystemImplicitRegistrationSetSupportPolicy
          sipIdentityForPilotAndProxyTrunkModesPolicy
          useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy

    Attributes:

        pilot_user_id (Optional[str]):

        department (Optional[DepartmentKey]):

        access_device (Optional[AccessDevice]):

        max_active_calls (int):

        max_incoming_calls (Optional[int]):

        max_outgoing_calls (Optional[int]):

        enable_bursting (bool):

        bursting_max_active_calls (Optional[int]):

        bursting_max_incoming_calls (Optional[int]):

        bursting_max_outgoing_calls (Optional[int]):

        capacity_exceeded_action (Optional[str]):

        capacity_exceeded_forward_address (Optional[str]):

        capacity_exceeded_reroute_trunk_group_key (Optional[TrunkGroupKey]):

        capacity_exceeded_trap_initial_calls (int):

        capacity_exceeded_trap_offset_calls (int):

        unreachable_destination_action (Optional[str]):

        unreachable_destination_forward_address (Optional[str]):

        unreachable_destination_reroute_trunk_group_key (Optional[TrunkGroupKey]):

        invitation_timeout (int):

        require_authentication (bool):

        sip_authentication_user_name (Optional[str]):

        hosted_user_table (Optional[OCITable]):

        trunk_group_identity (Optional[str]):

        otg_dtg_identity (Optional[str]):

        allow_termination_to_trunk_group_identity (bool):

        allow_termination_to_dtg_identity (bool):

        include_trunk_group_identity (bool):

        include_dtg_identity (bool):

        include_trunk_group_identity_for_network_calls (bool):

        include_otg_identity_for_network_calls (bool):

        enable_network_address_identity (bool):

        allow_unscreened_calls (bool):

        allow_unscreened_emergency_calls (bool):

        pilot_user_calling_line_identity_for_external_calls_policy (str):

        pilot_user_charge_number_policy (str):

        call_forwarding_always_action (Optional[str]):

        call_forwarding_always_forward_address (Optional[str]):

        call_forwarding_always_reroute_trunk_group_key (Optional[TrunkGroupKey]):

        peering_domain (Optional[str]):

        route_to_peering_domain (bool):

        prefix_enabled (bool):

        prefix (Optional[str]):

        stateful_rerouting_enabled (bool):

        send_continuous_options_message (bool):

        continuous_options_sending_interval_seconds (int):

        failure_options_sending_interval_seconds (int):

        failure_threshold_counter (int):

        success_threshold_counter (int):

        invite_failure_threshold_counter (int):

        invite_failure_threshold_window_seconds (int):

        trunk_group_state (str):

        pilot_user_calling_line_asserted_identity_policy (str):

        use_system_calling_line_asserted_identity_policy (bool):

        total_active_incoming_calls (int):

        total_active_outgoing_calls (int):

        pilot_user_call_optimization_policy (str):

        clid_source_for_screened_calls_policy (str):

        use_system_clid_source_for_screened_calls_policy (bool):

        user_lookup_policy (str):

        use_system_user_lookup_policy (bool):

        pilot_user_calling_line_identity_for_emergency_calls_policy (str):

        implicit_registration_set_support_policy (str):

        use_system_implicit_registration_set_support_policy (bool):

        sip_identity_for_pilot_and_proxy_trunk_modes_policy (str):

        use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy (bool):

        use_system_support_connected_identity_policy (bool):

        support_connected_identity_policy (str):

        use_system_options_message_response_status_codes (bool):

        options_message_response_status_code (Optional[List[str]]):

    """

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

    department: Optional[DepartmentKey] = field(
        default=None, metadata={"alias": "department"}
    )

    access_device: Optional[AccessDevice] = field(
        default=None, metadata={"alias": "accessDevice"}
    )

    max_active_calls: int = field(metadata={"alias": "maxActiveCalls"})

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

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

    enable_bursting: bool = field(metadata={"alias": "enableBursting"})

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

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

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

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

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

    capacity_exceeded_reroute_trunk_group_key: Optional[TrunkGroupKey] = field(
        default=None, metadata={"alias": "capacityExceededRerouteTrunkGroupKey"}
    )

    capacity_exceeded_trap_initial_calls: int = field(
        metadata={"alias": "capacityExceededTrapInitialCalls"}
    )

    capacity_exceeded_trap_offset_calls: int = field(
        metadata={"alias": "capacityExceededTrapOffsetCalls"}
    )

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

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

    unreachable_destination_reroute_trunk_group_key: Optional[TrunkGroupKey] = field(
        default=None, metadata={"alias": "unreachableDestinationRerouteTrunkGroupKey"}
    )

    invitation_timeout: int = field(metadata={"alias": "invitationTimeout"})

    require_authentication: bool = field(metadata={"alias": "requireAuthentication"})

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

    hosted_user_table: Optional[OCITable] = field(
        default=None, metadata={"alias": "hostedUserTable"}
    )

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

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

    allow_termination_to_trunk_group_identity: bool = field(
        metadata={"alias": "allowTerminationToTrunkGroupIdentity"}
    )

    allow_termination_to_dtg_identity: bool = field(
        metadata={"alias": "allowTerminationToDtgIdentity"}
    )

    include_trunk_group_identity: bool = field(
        metadata={"alias": "includeTrunkGroupIdentity"}
    )

    include_dtg_identity: bool = field(metadata={"alias": "includeDtgIdentity"})

    include_trunk_group_identity_for_network_calls: bool = field(
        metadata={"alias": "includeTrunkGroupIdentityForNetworkCalls"}
    )

    include_otg_identity_for_network_calls: bool = field(
        metadata={"alias": "includeOtgIdentityForNetworkCalls"}
    )

    enable_network_address_identity: bool = field(
        metadata={"alias": "enableNetworkAddressIdentity"}
    )

    allow_unscreened_calls: bool = field(metadata={"alias": "allowUnscreenedCalls"})

    allow_unscreened_emergency_calls: bool = field(
        metadata={"alias": "allowUnscreenedEmergencyCalls"}
    )

    pilot_user_calling_line_identity_for_external_calls_policy: str = field(
        metadata={"alias": "pilotUserCallingLineIdentityForExternalCallsPolicy"}
    )

    pilot_user_charge_number_policy: str = field(
        metadata={"alias": "pilotUserChargeNumberPolicy"}
    )

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

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

    call_forwarding_always_reroute_trunk_group_key: Optional[TrunkGroupKey] = field(
        default=None, metadata={"alias": "callForwardingAlwaysRerouteTrunkGroupKey"}
    )

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

    route_to_peering_domain: bool = field(metadata={"alias": "routeToPeeringDomain"})

    prefix_enabled: bool = field(metadata={"alias": "prefixEnabled"})

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

    stateful_rerouting_enabled: bool = field(
        metadata={"alias": "statefulReroutingEnabled"}
    )

    send_continuous_options_message: bool = field(
        metadata={"alias": "sendContinuousOptionsMessage"}
    )

    continuous_options_sending_interval_seconds: int = field(
        metadata={"alias": "continuousOptionsSendingIntervalSeconds"}
    )

    failure_options_sending_interval_seconds: int = field(
        metadata={"alias": "failureOptionsSendingIntervalSeconds"}
    )

    failure_threshold_counter: int = field(
        metadata={"alias": "failureThresholdCounter"}
    )

    success_threshold_counter: int = field(
        metadata={"alias": "successThresholdCounter"}
    )

    invite_failure_threshold_counter: int = field(
        metadata={"alias": "inviteFailureThresholdCounter"}
    )

    invite_failure_threshold_window_seconds: int = field(
        metadata={"alias": "inviteFailureThresholdWindowSeconds"}
    )

    trunk_group_state: str = field(metadata={"alias": "trunkGroupState"})

    pilot_user_calling_line_asserted_identity_policy: str = field(
        metadata={"alias": "pilotUserCallingLineAssertedIdentityPolicy"}
    )

    use_system_calling_line_asserted_identity_policy: bool = field(
        metadata={"alias": "useSystemCallingLineAssertedIdentityPolicy"}
    )

    total_active_incoming_calls: int = field(
        metadata={"alias": "totalActiveIncomingCalls"}
    )

    total_active_outgoing_calls: int = field(
        metadata={"alias": "totalActiveOutgoingCalls"}
    )

    pilot_user_call_optimization_policy: str = field(
        metadata={"alias": "pilotUserCallOptimizationPolicy"}
    )

    clid_source_for_screened_calls_policy: str = field(
        metadata={"alias": "clidSourceForScreenedCallsPolicy"}
    )

    use_system_clid_source_for_screened_calls_policy: bool = field(
        metadata={"alias": "useSystemCLIDSourceForScreenedCallsPolicy"}
    )

    user_lookup_policy: str = field(metadata={"alias": "userLookupPolicy"})

    use_system_user_lookup_policy: bool = field(
        metadata={"alias": "useSystemUserLookupPolicy"}
    )

    pilot_user_calling_line_identity_for_emergency_calls_policy: str = field(
        metadata={"alias": "pilotUserCallingLineIdentityForEmergencyCallsPolicy"}
    )

    implicit_registration_set_support_policy: str = field(
        metadata={"alias": "implicitRegistrationSetSupportPolicy"}
    )

    use_system_implicit_registration_set_support_policy: bool = field(
        metadata={"alias": "useSystemImplicitRegistrationSetSupportPolicy"}
    )

    sip_identity_for_pilot_and_proxy_trunk_modes_policy: str = field(
        metadata={"alias": "sipIdentityForPilotAndProxyTrunkModesPolicy"}
    )

    use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy: bool = field(
        metadata={"alias": "useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy"}
    )

    use_system_support_connected_identity_policy: bool = field(
        metadata={"alias": "useSystemSupportConnectedIdentityPolicy"}
    )

    support_connected_identity_policy: str = field(
        metadata={"alias": "supportConnectedIdentityPolicy"}
    )

    use_system_options_message_response_status_codes: bool = field(
        metadata={"alias": "useSystemOptionsMessageResponseStatusCodes"}
    )

    options_message_response_status_code: Optional[List[str]] = field(
        default=None, metadata={"alias": "optionsMessageResponseStatusCode"}
    )

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 GroupTrunkGroupGetInstanceRequest23

client = Client()

command = GroupTrunkGroupGetInstanceRequest23(
    trunk_group_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupTrunkGroupGetInstanceRequest23",
    trunk_group_key=...,
)

print(response)