Skip to content

SystemSIPDeviceTypeModifyRequest22V7

Bases: OCIRequest

Request to modify a sip device type. The response is either SuccessResponse or ErrorResponse.

The following elements are not changeable:
  SignalingAddressType
  isConferenceDevice
  isMusicOnHoldDevice
  isMobilityManagerDevice
  deviceTypeConfigurationOption
  staticLineOrdering

The following elements are only used in AS data mode and ignored in XS data mode:
  supportClientSessionInfo
  supportCallInfoConferenceSubscriptionURI
  supportRemotePartyInfo
  supportVisualDeviceManagementRedirectLink
  bypassMediaTreatment
  supportCauseParameter
  supportCallingPartyCategoryInOutboundFromHeader
  supportVisualDeviceManagementAPI
  deviceCategory
  verstatInPAIHeader
  verstatInFromHeader
  supportPreferredAutoAndForcedAnswer
  supportCiscoCallerIdDispositionHeader

The following elements are only used in XS data mode and ignored in AS mode:
  enhancedForICS
  supports3G4GContinuity
  publishesOwnPresence
  locationNetwork
  allowTerminationBasedOnICSI
  roamingMode

The following logic applies to these elements:
  macInCert
  macInNonRequestURI
  The two elements are mutually exclusive.
  When both are set to true, the command fails.
  When macInCert is set to true, macInNonRequestURI will be reset to false.
  When macInNonRequestURI is set to true, macInCert will be reset to false.

Attributes:

device_type (str):

number_of_ports (Optional[UnboundedPositiveInt]):

is_obsolete (Optional[bool]):

registration_capable (Optional[bool]):

hold_normalization (Optional[str]):

hold_announcement_method (Optional[str]):

is_trusted (Optional[bool]):

e164_capable (Optional[bool]):

route_advance (Optional[bool]):

forwarding_override (Optional[bool]):

wireless_integration (Optional[bool]):

web_based_config_url (Optional[Nillable[str]]):

is_video_capable (Optional[bool]):

pbx_integration (Optional[bool]):

static_registration_capable (Optional[bool]):

cpe_device_options (Optional[CPEDeviceModifyOptions22V3]):

early_media_support (Optional[str]):

authenticate_refer (Optional[bool]):

auto_config_soft_client (Optional[bool]):

authentication_mode (Optional[str]):

requires_broad_works_digit_collection (Optional[bool]):

requires_broad_works_call_waiting_tone (Optional[bool]):

requires_mwi_subscription (Optional[bool]):

use_history_info_header_on_access_side (Optional[bool]):

advice_of_charge_capable (Optional[bool]):

reset_event (Optional[Nillable[str]]):

reset_string (Optional[Nillable[str]]):

support_call_center_mime_type (Optional[bool]):

trunk_mode (Optional[str]):

add_p_called_party_id (Optional[bool]):

support_identity_in_update_and_re_invite (Optional[bool]):

unscreened_presentation_identity_policy (Optional[str]):

enhanced_for_ics (Optional[bool]):

support_emergency_disconnect_control (Optional[bool]):

support_rfc3398 (Optional[bool]):

support_client_session_info (Optional[bool]):

support_call_info_conference_subscription_uri (Optional[bool]):

support_remote_party_info (Optional[bool]):

support_visual_device_management_redirect_link (Optional[bool]):

bypass_media_treatment (Optional[bool]):

supports3_g4_g_continuity (Optional[bool]):

publishes_own_presence (Optional[bool]):

support_cause_parameter (Optional[bool]):

location_network (Optional[str]):

allow_termination_based_on_icsi (Optional[bool]):

roaming_mode (Optional[str]):

support_calling_party_category_in_outbound_from_header (Optional[bool]):

support_visual_device_management_api (Optional[bool]):

device_category (Optional[str]):

verstat_in_pai_header (Optional[bool]):

verstat_in_from_header (Optional[bool]):

support_preferred_auto_and_forced_answer (Optional[bool]):

support_cisco_caller_id_disposition_header (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
94692
94693
94694
94695
94696
94697
94698
94699
94700
94701
94702
94703
94704
94705
94706
94707
94708
94709
94710
94711
94712
94713
94714
94715
94716
94717
94718
94719
94720
94721
94722
94723
94724
94725
94726
94727
94728
94729
94730
94731
94732
94733
94734
94735
94736
94737
94738
94739
94740
94741
94742
94743
94744
94745
94746
94747
94748
94749
94750
94751
94752
94753
94754
94755
94756
94757
94758
94759
94760
94761
94762
94763
94764
94765
94766
94767
94768
94769
94770
94771
94772
94773
94774
94775
94776
94777
94778
94779
94780
94781
94782
94783
94784
94785
94786
94787
94788
94789
94790
94791
94792
94793
94794
94795
94796
94797
94798
94799
94800
94801
94802
94803
94804
94805
94806
94807
94808
94809
94810
94811
94812
94813
94814
94815
94816
94817
94818
94819
94820
94821
94822
94823
94824
94825
94826
94827
94828
94829
94830
94831
94832
94833
94834
94835
94836
94837
94838
94839
94840
94841
94842
94843
94844
94845
94846
94847
94848
94849
94850
94851
94852
94853
94854
94855
94856
94857
94858
94859
94860
94861
94862
94863
94864
94865
94866
94867
94868
94869
94870
94871
94872
94873
94874
94875
94876
94877
94878
94879
94880
94881
94882
94883
94884
94885
94886
94887
94888
94889
94890
94891
94892
94893
94894
94895
94896
94897
94898
94899
94900
94901
94902
94903
94904
94905
94906
94907
94908
94909
94910
94911
94912
94913
94914
94915
94916
94917
94918
94919
94920
94921
94922
94923
94924
94925
94926
94927
94928
94929
94930
94931
94932
94933
94934
94935
94936
94937
94938
94939
94940
94941
94942
94943
94944
94945
94946
94947
94948
94949
94950
94951
94952
94953
94954
94955
94956
94957
94958
94959
94960
94961
94962
94963
94964
94965
94966
94967
94968
94969
94970
94971
94972
94973
94974
94975
94976
94977
94978
94979
94980
94981
94982
94983
94984
94985
94986
94987
94988
94989
94990
94991
94992
94993
94994
94995
94996
94997
94998
94999
95000
95001
95002
95003
95004
95005
95006
95007
95008
95009
95010
95011
95012
95013
95014
95015
95016
95017
95018
95019
95020
95021
95022
95023
95024
95025
95026
95027
95028
95029
95030
95031
95032
95033
95034
95035
95036
95037
95038
95039
95040
95041
95042
95043
95044
95045
95046
95047
95048
95049
95050
95051
95052
95053
95054
@dataclass(kw_only=True)
class SystemSIPDeviceTypeModifyRequest22V7(OCIRequest):
    """Request to modify a sip device type.
        The response is either SuccessResponse or ErrorResponse.

        The following elements are not changeable:
          SignalingAddressType
          isConferenceDevice
          isMusicOnHoldDevice
          isMobilityManagerDevice
          deviceTypeConfigurationOption
          staticLineOrdering

        The following elements are only used in AS data mode and ignored in XS data mode:
          supportClientSessionInfo
          supportCallInfoConferenceSubscriptionURI
          supportRemotePartyInfo
          supportVisualDeviceManagementRedirectLink
          bypassMediaTreatment
          supportCauseParameter
          supportCallingPartyCategoryInOutboundFromHeader
          supportVisualDeviceManagementAPI
          deviceCategory
          verstatInPAIHeader
          verstatInFromHeader
          supportPreferredAutoAndForcedAnswer
          supportCiscoCallerIdDispositionHeader

        The following elements are only used in XS data mode and ignored in AS mode:
          enhancedForICS
          supports3G4GContinuity
          publishesOwnPresence
          locationNetwork
          allowTerminationBasedOnICSI
          roamingMode

        The following logic applies to these elements:
          macInCert
          macInNonRequestURI
          The two elements are mutually exclusive.
          When both are set to true, the command fails.
          When macInCert is set to true, macInNonRequestURI will be reset to false.
          When macInNonRequestURI is set to true, macInCert will be reset to false.

    Attributes:

        device_type (str):

        number_of_ports (Optional[UnboundedPositiveInt]):

        is_obsolete (Optional[bool]):

        registration_capable (Optional[bool]):

        hold_normalization (Optional[str]):

        hold_announcement_method (Optional[str]):

        is_trusted (Optional[bool]):

        e164_capable (Optional[bool]):

        route_advance (Optional[bool]):

        forwarding_override (Optional[bool]):

        wireless_integration (Optional[bool]):

        web_based_config_url (Optional[Nillable[str]]):

        is_video_capable (Optional[bool]):

        pbx_integration (Optional[bool]):

        static_registration_capable (Optional[bool]):

        cpe_device_options (Optional[CPEDeviceModifyOptions22V3]):

        early_media_support (Optional[str]):

        authenticate_refer (Optional[bool]):

        auto_config_soft_client (Optional[bool]):

        authentication_mode (Optional[str]):

        requires_broad_works_digit_collection (Optional[bool]):

        requires_broad_works_call_waiting_tone (Optional[bool]):

        requires_mwi_subscription (Optional[bool]):

        use_history_info_header_on_access_side (Optional[bool]):

        advice_of_charge_capable (Optional[bool]):

        reset_event (Optional[Nillable[str]]):

        reset_string (Optional[Nillable[str]]):

        support_call_center_mime_type (Optional[bool]):

        trunk_mode (Optional[str]):

        add_p_called_party_id (Optional[bool]):

        support_identity_in_update_and_re_invite (Optional[bool]):

        unscreened_presentation_identity_policy (Optional[str]):

        enhanced_for_ics (Optional[bool]):

        support_emergency_disconnect_control (Optional[bool]):

        support_rfc3398 (Optional[bool]):

        support_client_session_info (Optional[bool]):

        support_call_info_conference_subscription_uri (Optional[bool]):

        support_remote_party_info (Optional[bool]):

        support_visual_device_management_redirect_link (Optional[bool]):

        bypass_media_treatment (Optional[bool]):

        supports3_g4_g_continuity (Optional[bool]):

        publishes_own_presence (Optional[bool]):

        support_cause_parameter (Optional[bool]):

        location_network (Optional[str]):

        allow_termination_based_on_icsi (Optional[bool]):

        roaming_mode (Optional[str]):

        support_calling_party_category_in_outbound_from_header (Optional[bool]):

        support_visual_device_management_api (Optional[bool]):

        device_category (Optional[str]):

        verstat_in_pai_header (Optional[bool]):

        verstat_in_from_header (Optional[bool]):

        support_preferred_auto_and_forced_answer (Optional[bool]):

        support_cisco_caller_id_disposition_header (Optional[bool]):

    """

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

    number_of_ports: Optional[UnboundedPositiveInt] = field(
        default=None, metadata={"alias": "numberOfPorts"}
    )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["web_based_config_url", "reset_event", "reset_string"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 SystemSIPDeviceTypeModifyRequest22V7

client = Client()

command = SystemSIPDeviceTypeModifyRequest22V7(
    device_type=...,
    number_of_ports=...,
    is_obsolete=...,
    registration_capable=...,
    hold_normalization=...,
    hold_announcement_method=...,
    is_trusted=...,
    e164_capable=...,
    route_advance=...,
    forwarding_override=...,
    wireless_integration=...,
    web_based_config_url=...,
    is_video_capable=...,
    pbx_integration=...,
    static_registration_capable=...,
    cpe_device_options=...,
    early_media_support=...,
    authenticate_refer=...,
    auto_config_soft_client=...,
    authentication_mode=...,
    requires_broad_works_digit_collection=...,
    requires_broad_works_call_waiting_tone=...,
    requires_mwi_subscription=...,
    use_history_info_header_on_access_side=...,
    advice_of_charge_capable=...,
    reset_event=...,
    reset_string=...,
    support_call_center_mime_type=...,
    trunk_mode=...,
    add_p_called_party_id=...,
    support_identity_in_update_and_re_invite=...,
    unscreened_presentation_identity_policy=...,
    enhanced_for_ics=...,
    support_emergency_disconnect_control=...,
    support_rfc3398=...,
    support_client_session_info=...,
    support_call_info_conference_subscription_uri=...,
    support_remote_party_info=...,
    support_visual_device_management_redirect_link=...,
    bypass_media_treatment=...,
    supports3_g4_g_continuity=...,
    publishes_own_presence=...,
    support_cause_parameter=...,
    location_network=...,
    allow_termination_based_on_icsi=...,
    roaming_mode=...,
    support_calling_party_category_in_outbound_from_header=...,
    support_visual_device_management_api=...,
    device_category=...,
    verstat_in_pai_header=...,
    verstat_in_from_header=...,
    support_preferred_auto_and_forced_answer=...,
    support_cisco_caller_id_disposition_header=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemSIPDeviceTypeModifyRequest22V7",
    device_type=...,
    number_of_ports=...,
    is_obsolete=...,
    registration_capable=...,
    hold_normalization=...,
    hold_announcement_method=...,
    is_trusted=...,
    e164_capable=...,
    route_advance=...,
    forwarding_override=...,
    wireless_integration=...,
    web_based_config_url=...,
    is_video_capable=...,
    pbx_integration=...,
    static_registration_capable=...,
    cpe_device_options=...,
    early_media_support=...,
    authenticate_refer=...,
    auto_config_soft_client=...,
    authentication_mode=...,
    requires_broad_works_digit_collection=...,
    requires_broad_works_call_waiting_tone=...,
    requires_mwi_subscription=...,
    use_history_info_header_on_access_side=...,
    advice_of_charge_capable=...,
    reset_event=...,
    reset_string=...,
    support_call_center_mime_type=...,
    trunk_mode=...,
    add_p_called_party_id=...,
    support_identity_in_update_and_re_invite=...,
    unscreened_presentation_identity_policy=...,
    enhanced_for_ics=...,
    support_emergency_disconnect_control=...,
    support_rfc3398=...,
    support_client_session_info=...,
    support_call_info_conference_subscription_uri=...,
    support_remote_party_info=...,
    support_visual_device_management_redirect_link=...,
    bypass_media_treatment=...,
    supports3_g4_g_continuity=...,
    publishes_own_presence=...,
    support_cause_parameter=...,
    location_network=...,
    allow_termination_based_on_icsi=...,
    roaming_mode=...,
    support_calling_party_category_in_outbound_from_header=...,
    support_visual_device_management_api=...,
    device_category=...,
    verstat_in_pai_header=...,
    verstat_in_from_header=...,
    support_preferred_auto_and_forced_answer=...,
    support_cisco_caller_id_disposition_header=...,
)

print(response)