SystemSIPDeviceTypeAddRequest23V9
Bases: OCIRequest
Request to add a sip device type. The response is either SuccessResponse or ErrorResponse. When the optional element resellerId is specified, the device type created is at reseller level. Device type name should be unique throughout the system including all the reseller level device types.
The following elements are only used in the XS data mode and ignored in the AS data mode:
enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode
publishesOwnPresence, use value "false" in AS data mode
locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode
roamingMode, use value "None" in AS data mode
The following elements are only used in AS data mode and ignored in the XS data mode:
supportClientSessionInfo, use value "false" in XS data mode
supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode
supportCauseParameter, use value "false" in XS data mode
resellerId
supportVisualDeviceManagementAPI, use value "false" in XS data mode
deviceCategory
verstatInPAIHeader, use value "false" in XS data mode
verstatInFromHeader, use value "false" in XS data mode
supportPreferredAutoAndForcedAnswer
supportCiscoCallerIdDispositionHeader
The following values for element profile are only used in AS data mode and an error is returned in the XS data mode:
SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing
The following logic applies to these elements:
macInCert
macInNonRequestURI
The two elements are mutually exclusive.
When both are set to true, the command fails.
Attributes:
device_type (str):
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[CPEDeviceOptions22V6]):
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 (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 (bool):
publishes_own_presence (bool):
support_cause_parameter (bool):
location_network (str):
reseller_id (Optional[str]):
allow_termination_based_on_icsi (bool):
roaming_mode (str):
support_calling_party_category_in_outbound_from_header (bool):
support_visual_device_management_api (Optional[bool]):
device_category (Optional[str]):
add_to_file_server (Optional[bool]):
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
93950 93951 93952 93953 93954 93955 93956 93957 93958 93959 93960 93961 93962 93963 93964 93965 93966 93967 93968 93969 93970 93971 93972 93973 93974 93975 93976 93977 93978 93979 93980 93981 93982 93983 93984 93985 93986 93987 93988 93989 93990 93991 93992 93993 93994 93995 93996 93997 93998 93999 94000 94001 94002 94003 94004 94005 94006 94007 94008 94009 94010 94011 94012 94013 94014 94015 94016 94017 94018 94019 94020 94021 94022 94023 94024 94025 94026 94027 94028 94029 94030 94031 94032 94033 94034 94035 94036 94037 94038 94039 94040 94041 94042 94043 94044 94045 94046 94047 94048 94049 94050 94051 94052 94053 94054 94055 94056 94057 94058 94059 94060 94061 94062 94063 94064 94065 94066 94067 94068 94069 94070 94071 94072 94073 94074 94075 94076 94077 94078 94079 94080 94081 94082 94083 94084 94085 94086 94087 94088 94089 94090 94091 94092 94093 94094 94095 94096 94097 94098 94099 94100 94101 94102 94103 94104 94105 94106 94107 94108 94109 94110 94111 94112 94113 94114 94115 94116 94117 94118 94119 94120 94121 94122 94123 94124 94125 94126 94127 94128 94129 94130 94131 94132 94133 94134 94135 94136 94137 94138 94139 94140 94141 94142 94143 94144 94145 94146 94147 94148 94149 94150 94151 94152 94153 94154 94155 94156 94157 94158 94159 94160 94161 94162 94163 94164 94165 94166 94167 94168 94169 94170 94171 94172 94173 94174 94175 94176 94177 94178 94179 94180 94181 94182 94183 94184 94185 94186 94187 94188 94189 94190 94191 94192 94193 94194 94195 94196 94197 94198 94199 94200 94201 94202 94203 94204 94205 94206 94207 94208 94209 94210 94211 94212 94213 94214 94215 94216 94217 94218 94219 94220 94221 94222 94223 94224 94225 94226 94227 94228 94229 94230 94231 94232 94233 94234 94235 94236 94237 94238 94239 94240 94241 94242 94243 94244 94245 94246 94247 94248 94249 94250 94251 94252 94253 94254 94255 94256 94257 94258 94259 94260 94261 94262 94263 94264 94265 94266 94267 94268 94269 94270 94271 94272 94273 94274 94275 94276 94277 94278 94279 94280 94281 94282 94283 94284 94285 94286 | |
Responses
Example Usage
from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import SystemSIPDeviceTypeAddRequest23V9
client = Client()
command = SystemSIPDeviceTypeAddRequest23V9(
device_type=...,
number_of_ports=...,
profile=...,
registration_capable=...,
is_conference_device=...,
is_mobility_manager_device=...,
is_music_on_hold_device=...,
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=...,
device_type_configuration_option=...,
support_rfc3398=...,
static_line_ordering=...,
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=...,
reseller_id=...,
allow_termination_based_on_icsi=...,
roaming_mode=...,
support_calling_party_category_in_outbound_from_header=...,
support_visual_device_management_api=...,
device_category=...,
add_to_file_server=...,
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("SystemSIPDeviceTypeAddRequest23V9",
device_type=...,
number_of_ports=...,
profile=...,
registration_capable=...,
is_conference_device=...,
is_mobility_manager_device=...,
is_music_on_hold_device=...,
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=...,
device_type_configuration_option=...,
support_rfc3398=...,
static_line_ordering=...,
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=...,
reseller_id=...,
allow_termination_based_on_icsi=...,
roaming_mode=...,
support_calling_party_category_in_outbound_from_header=...,
support_visual_device_management_api=...,
device_category=...,
add_to_file_server=...,
verstat_in_pai_header=...,
verstat_in_from_header=...,
support_preferred_auto_and_forced_answer=...,
support_cisco_caller_id_disposition_header=...,
)
print(response)