Skip to content

SystemSIPDeviceTypeGetRequest23V13

Bases: OCIRequest

Request to get a sip device type. See Also: SystemDeviceTypeGetRequest The response is either SystemSIPDeviceTypeGetResponse23V13 or ErrorResponse.

Attributes:

device_type (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSIPDeviceTypeGetRequest23V13(OCIRequest):
    """Request to get a sip device type.
        See Also: SystemDeviceTypeGetRequest
        The response is either SystemSIPDeviceTypeGetResponse23V13 or ErrorResponse.

    Attributes:

        device_type (str):

    """

    device_type: str = field(metadata={"alias": "deviceType"})

Responses

Bases: OCIDataResponse

Response to SystemSIPDeviceTypeGetRequest23V13. The following elements are only used in AS data mode: supportClientSessionInfo, should be set to "false" if not used supportCallInfoConferenceSubscriptionURI, should be set to "false" if not used supportRemotePartyInfo,should be set to "false" if not used supportVisualDeviceManagementRedirectLink, should be set to "false" if not used bypassMediaTreatment, should be set to "false" if not used supportCauseParameter, should be set to "false" if not used supportCallingPartyCategoryInOutboundFromHeader, should be set to "true" if not used resellerId supportVisualDeviceManagementAPI, should be set to "false" if not used supportPreferredAutoAndForcedAnswer, should be set to "false" if not used supportCiscoCallerIdDispositionHeader

The following elements are only used in AS data mode and not returned in XS data mode:
  deviceCategory
  deviceFamily

The following elements are only used in XS data mode:
  enhancedForICS, should be set to "false" if not used
  supports3G4GContinuity, should be set to "false" if not used
  publishesOwnPresence, should be set to "false" if not used
  locationNetwork, should be set to "Fixed" if not used
  allowTerminationBasedOnICSI, should be set to "false" if not used
  roamingMode, should be set to "None" if not used

Attributes:

is_obsolete (bool):

number_of_ports (UnboundedPositiveInt):

profile (str):

registration_capable (bool):

is_conference_device (bool):

is_mobility_manager_device (bool):

is_music_on_hold_device (bool):

hold_normalization (str):

hold_announcement_method (str):

is_trusted (bool):

e164_capable (bool):

route_advance (bool):

forwarding_override (bool):

wireless_integration (bool):

web_based_config_url (Optional[str]):

is_video_capable (bool):

pbx_integration (bool):

static_registration_capable (bool):

cpe_device_options (Optional[CPEDeviceOptionsRead22V6]):

protocol_choice (List[str]):

early_media_support (str):

authenticate_refer (bool):

auto_config_soft_client (bool):

authentication_mode (str):

requires_broad_works_digit_collection (bool):

requires_broad_works_call_waiting_tone (bool):

requires_mwi_subscription (bool):

use_history_info_header_on_access_side (bool):

advice_of_charge_capable (bool):

reset_event (Optional[str]):

reset_string (Optional[str]):

support_call_center_mime_type (bool):

trunk_mode (str):

add_p_called_party_id (bool):

support_identity_in_update_and_re_invite (bool):

unscreened_presentation_identity_policy (str):

enhanced_for_ics (Optional[bool]):

support_emergency_disconnect_control (bool):

device_type_configuration_option (str):

support_rfc3398 (bool):

static_line_ordering (bool):

support_client_session_info (bool):

support_call_info_conference_subscription_uri (bool):

support_remote_party_info (bool):

support_visual_device_management_redirect_link (bool):

bypass_media_treatment (bool):

supports3_g4_g_continuity (Optional[bool]):

publishes_own_presence (Optional[bool]):

support_cause_parameter (bool):

location_network (Optional[str]):

reseller_id (Optional[str]):

allow_termination_based_on_icsi (Optional[bool]):

roaming_mode (Optional[str]):

support_calling_party_category_in_outbound_from_header (bool):

support_visual_device_management_api (Optional[bool]):

device_category (Optional[str]):

device_family (Optional[str]):

verstat_in_pai_header (Optional[bool]):

verstat_in_from_header (Optional[bool]):

support_preferred_auto_and_forced_answer (bool):

support_cisco_caller_id_disposition_header (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
147943
147944
147945
147946
147947
147948
147949
147950
147951
147952
147953
147954
147955
147956
147957
147958
147959
147960
147961
147962
147963
147964
147965
147966
147967
147968
147969
147970
147971
147972
147973
147974
147975
147976
147977
147978
147979
147980
147981
147982
147983
147984
147985
147986
147987
147988
147989
147990
147991
147992
147993
147994
147995
147996
147997
147998
147999
148000
148001
148002
148003
148004
148005
148006
148007
148008
148009
148010
148011
148012
148013
148014
148015
148016
148017
148018
148019
148020
148021
148022
148023
148024
148025
148026
148027
148028
148029
148030
148031
148032
148033
148034
148035
148036
148037
148038
148039
148040
148041
148042
148043
148044
148045
148046
148047
148048
148049
148050
148051
148052
148053
148054
148055
148056
148057
148058
148059
148060
148061
148062
148063
148064
148065
148066
148067
148068
148069
148070
148071
148072
148073
148074
148075
148076
148077
148078
148079
148080
148081
148082
148083
148084
148085
148086
148087
148088
148089
148090
148091
148092
148093
148094
148095
148096
148097
148098
148099
148100
148101
148102
148103
148104
148105
148106
148107
148108
148109
148110
148111
148112
148113
148114
148115
148116
148117
148118
148119
148120
148121
148122
148123
148124
148125
148126
148127
148128
148129
148130
148131
148132
148133
148134
148135
148136
148137
148138
148139
148140
148141
148142
148143
148144
148145
148146
148147
148148
148149
148150
148151
148152
148153
148154
148155
148156
148157
148158
148159
148160
148161
148162
148163
148164
148165
148166
148167
148168
148169
148170
148171
148172
148173
148174
148175
148176
148177
148178
148179
148180
148181
148182
148183
148184
148185
148186
148187
148188
148189
148190
148191
148192
148193
148194
148195
148196
148197
148198
148199
148200
148201
148202
148203
148204
148205
148206
148207
148208
148209
148210
148211
148212
148213
148214
148215
148216
148217
148218
148219
148220
148221
148222
148223
148224
148225
148226
148227
148228
148229
148230
148231
148232
148233
148234
148235
148236
148237
148238
148239
148240
148241
148242
148243
148244
148245
148246
148247
148248
148249
148250
148251
148252
148253
148254
148255
148256
148257
148258
148259
148260
148261
148262
148263
148264
148265
148266
148267
148268
148269
148270
148271
148272
148273
148274
148275
148276
148277
@dataclass(kw_only=True)
class SystemSIPDeviceTypeGetResponse23V13(OCIDataResponse):
    """Response to SystemSIPDeviceTypeGetRequest23V13.
        The following elements are only used in AS data mode:
          supportClientSessionInfo, should be set to \"false\" if not used
          supportCallInfoConferenceSubscriptionURI, should be set to \"false\" if not used
          supportRemotePartyInfo,should be set to \"false\" if not used
          supportVisualDeviceManagementRedirectLink, should be set to \"false\" if not used
          bypassMediaTreatment, should be set to \"false\" if not used
          supportCauseParameter, should be set to \"false\" if not used
          supportCallingPartyCategoryInOutboundFromHeader, should be set to \"true\" if not used
          resellerId
          supportVisualDeviceManagementAPI, should be set to \"false\" if not used
          supportPreferredAutoAndForcedAnswer, should be set to \"false\" if not used
          supportCiscoCallerIdDispositionHeader

        The following elements are only used in AS data mode and not returned in XS data mode:
          deviceCategory
          deviceFamily

        The following elements are only used in XS data mode:
          enhancedForICS, should be set to \"false\" if not used
          supports3G4GContinuity, should be set to \"false\" if not used
          publishesOwnPresence, should be set to \"false\" if not used
          locationNetwork, should be set to \"Fixed\" if not used
          allowTerminationBasedOnICSI, should be set to \"false\" if not used
          roamingMode, should be set to \"None\" if not used

    Attributes:

        is_obsolete (bool):

        number_of_ports (UnboundedPositiveInt):

        profile (str):

        registration_capable (bool):

        is_conference_device (bool):

        is_mobility_manager_device (bool):

        is_music_on_hold_device (bool):

        hold_normalization (str):

        hold_announcement_method (str):

        is_trusted (bool):

        e164_capable (bool):

        route_advance (bool):

        forwarding_override (bool):

        wireless_integration (bool):

        web_based_config_url (Optional[str]):

        is_video_capable (bool):

        pbx_integration (bool):

        static_registration_capable (bool):

        cpe_device_options (Optional[CPEDeviceOptionsRead22V6]):

        protocol_choice (List[str]):

        early_media_support (str):

        authenticate_refer (bool):

        auto_config_soft_client (bool):

        authentication_mode (str):

        requires_broad_works_digit_collection (bool):

        requires_broad_works_call_waiting_tone (bool):

        requires_mwi_subscription (bool):

        use_history_info_header_on_access_side (bool):

        advice_of_charge_capable (bool):

        reset_event (Optional[str]):

        reset_string (Optional[str]):

        support_call_center_mime_type (bool):

        trunk_mode (str):

        add_p_called_party_id (bool):

        support_identity_in_update_and_re_invite (bool):

        unscreened_presentation_identity_policy (str):

        enhanced_for_ics (Optional[bool]):

        support_emergency_disconnect_control (bool):

        device_type_configuration_option (str):

        support_rfc3398 (bool):

        static_line_ordering (bool):

        support_client_session_info (bool):

        support_call_info_conference_subscription_uri (bool):

        support_remote_party_info (bool):

        support_visual_device_management_redirect_link (bool):

        bypass_media_treatment (bool):

        supports3_g4_g_continuity (Optional[bool]):

        publishes_own_presence (Optional[bool]):

        support_cause_parameter (bool):

        location_network (Optional[str]):

        reseller_id (Optional[str]):

        allow_termination_based_on_icsi (Optional[bool]):

        roaming_mode (Optional[str]):

        support_calling_party_category_in_outbound_from_header (bool):

        support_visual_device_management_api (Optional[bool]):

        device_category (Optional[str]):

        device_family (Optional[str]):

        verstat_in_pai_header (Optional[bool]):

        verstat_in_from_header (Optional[bool]):

        support_preferred_auto_and_forced_answer (bool):

        support_cisco_caller_id_disposition_header (Optional[bool]):

    """

    is_obsolete: bool = field(metadata={"alias": "isObsolete"})

    number_of_ports: UnboundedPositiveInt = field(metadata={"alias": "numberOfPorts"})

    profile: str = field(metadata={"alias": "profile"})

    registration_capable: bool = field(metadata={"alias": "registrationCapable"})

    is_conference_device: bool = field(metadata={"alias": "isConferenceDevice"})

    is_mobility_manager_device: bool = field(
        metadata={"alias": "isMobilityManagerDevice"}
    )

    is_music_on_hold_device: bool = field(metadata={"alias": "isMusicOnHoldDevice"})

    hold_normalization: str = field(metadata={"alias": "holdNormalization"})

    hold_announcement_method: str = field(metadata={"alias": "holdAnnouncementMethod"})

    is_trusted: bool = field(metadata={"alias": "isTrusted"})

    e164_capable: bool = field(metadata={"alias": "E164Capable"})

    route_advance: bool = field(metadata={"alias": "routeAdvance"})

    forwarding_override: bool = field(metadata={"alias": "forwardingOverride"})

    wireless_integration: bool = field(metadata={"alias": "wirelessIntegration"})

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

    is_video_capable: bool = field(metadata={"alias": "isVideoCapable"})

    pbx_integration: bool = field(metadata={"alias": "PBXIntegration"})

    static_registration_capable: bool = field(
        metadata={"alias": "staticRegistrationCapable"}
    )

    cpe_device_options: Optional[CPEDeviceOptionsRead22V6] = field(
        default=None, metadata={"alias": "cpeDeviceOptions"}
    )

    protocol_choice: List[str] = field(metadata={"alias": "protocolChoice"})

    early_media_support: str = field(metadata={"alias": "earlyMediaSupport"})

    authenticate_refer: bool = field(metadata={"alias": "authenticateRefer"})

    auto_config_soft_client: bool = field(metadata={"alias": "autoConfigSoftClient"})

    authentication_mode: str = field(metadata={"alias": "authenticationMode"})

    requires_broad_works_digit_collection: bool = field(
        metadata={"alias": "requiresBroadWorksDigitCollection"}
    )

    requires_broad_works_call_waiting_tone: bool = field(
        metadata={"alias": "requiresBroadWorksCallWaitingTone"}
    )

    requires_mwi_subscription: bool = field(
        metadata={"alias": "requiresMWISubscription"}
    )

    use_history_info_header_on_access_side: bool = field(
        metadata={"alias": "useHistoryInfoHeaderOnAccessSide"}
    )

    advice_of_charge_capable: bool = field(metadata={"alias": "adviceOfChargeCapable"})

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

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

    support_call_center_mime_type: bool = field(
        metadata={"alias": "supportCallCenterMIMEType"}
    )

    trunk_mode: str = field(metadata={"alias": "trunkMode"})

    add_p_called_party_id: bool = field(metadata={"alias": "addPCalledPartyId"})

    support_identity_in_update_and_re_invite: bool = field(
        metadata={"alias": "supportIdentityInUpdateAndReInvite"}
    )

    unscreened_presentation_identity_policy: str = field(
        metadata={"alias": "unscreenedPresentationIdentityPolicy"}
    )

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

    support_emergency_disconnect_control: bool = field(
        metadata={"alias": "supportEmergencyDisconnectControl"}
    )

    device_type_configuration_option: str = field(
        metadata={"alias": "deviceTypeConfigurationOption"}
    )

    support_rfc3398: bool = field(metadata={"alias": "supportRFC3398"})

    static_line_ordering: bool = field(metadata={"alias": "staticLineOrdering"})

    support_client_session_info: bool = field(
        metadata={"alias": "supportClientSessionInfo"}
    )

    support_call_info_conference_subscription_uri: bool = field(
        metadata={"alias": "supportCallInfoConferenceSubscriptionURI"}
    )

    support_remote_party_info: bool = field(
        metadata={"alias": "supportRemotePartyInfo"}
    )

    support_visual_device_management_redirect_link: bool = field(
        metadata={"alias": "supportVisualDeviceManagementRedirectLink"}
    )

    bypass_media_treatment: bool = field(metadata={"alias": "bypassMediaTreatment"})

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

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

    support_cause_parameter: bool = field(metadata={"alias": "supportCauseParameter"})

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

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

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

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

    support_calling_party_category_in_outbound_from_header: bool = field(
        metadata={"alias": "supportCallingPartyCategoryInOutboundFromHeader"}
    )

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

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

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

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

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

    support_preferred_auto_and_forced_answer: bool = field(
        metadata={"alias": "supportPreferredAutoAndForcedAnswer"}
    )

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

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 SystemSIPDeviceTypeGetRequest23V13

client = Client()

command = SystemSIPDeviceTypeGetRequest23V13(
    device_type=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemSIPDeviceTypeGetRequest23V13",
    device_type=...,
)

print(response)