Jump to: navigation, search

Workspace SIP Endpoint options

[Modified: 8.5.101.14, 8.5.113.11, 8.5.114.08, 8.5.117.26, WSEP 8.5.113.02, 8.5.126.07]

Important
Significant changes are made to the SIP Endpoint configuration options between SIP Endpoint 8.0.2 and SIP Endpoint 8.5.0. For a list of the changes, refer to the SIP Endpoint 8.0.2 versus SIP Endpoint 8.5.0 options table. If you want to continue to use Interaction Workspace SIP Endpoint 8.0.2, use the configuration options that are described in the Interaction Workspace 8.1.4 Deployment Guide.


sipendpoint.authenticate-with-dn-password

[Modified: 8.5.117.26]

  • Default Value: false
  • Valid Values: true, false.
  • Changes take effect: At next Log Off operation or at next login.
  • Description: Specifies how Workspace Desktop Edition configures Workspace SIP Endpoint so that it can populate the password in the SIP Requests that require authentication:
    • false: If the DN where agent is logging in has the TServer/authenticate-requests option set to a valid non-empty value, Workspace Desktop Edition configures Workspace SIP Endpoint with the value that it reads in the TServer/password. DN option.
    • true: Workspace Desktop Edition configures Workspace SIP Endpoint with the DN password that is specified by the agent in the advanced Login window (activated by the login.voice.prompt-dn-password).

sipendpoint.codecs.g729/8000.fmtp

[Added: 8.5.101.14]

  • Default Value: annexb=yes
  • Valid Values: annexb=yes, annexb=no
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether the G729 codec is configured with AnnexB = Yes, or AnnexB = No.

sipendpoint.codecs.h264.fmtp

[Added: 8.5.101.14]

  • Default Value: profile-level-id=420028
  • Valid Values: The string profile-level-id= followed by a sequence of 3 hexadecimal values in the range 00 to FF, that respectively define profile_idc, profile-iop, and level-idc.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the profile of the H.264 codec. This option is applicable only if the value of the sipendpoint.policy.session.auto_accept_video option is set to 1.

sipendpoint.core-deadlock-detection-delay

[Added: WESP 8.5.113.02]

  • Default Value: 12500
  • Valid Values: A positive integer value.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the time, in milliseconds, that Workspace SIP Endpoint waits before considering itself deadlocked. When deadlock is detected, Workspace SIP Endpoint automatically restarts. Genesys recommends that you specify a value greater than 12500 ms.

sipendpoint.exit-on-voice-logoff

  • Default Value: false
  • Valid Values: true, false.
  • Changes take effect: At next Log Off operation or at next login.
  • Description: Specifies whether Workspace SIP Endpoint is unregistered and stopped if the voice channel is logged off manually by an agent. If the value of this option is set to true, the corresponding voice DN is also unregistered from SIP Server and therefore Workspace does not get notifications of any activity that occurs on it. If an agent manually Logs On to the voice channel, the corresponding DN is registered again and Workspace SIP Endpoint is restarted.

sipendpoint.headset-enforce-configured-usage

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether the SIP Endpoint must wait for the detection of the headset that is configured in the sipendpoint.genesys.device.headset_name option before finalizing initialization. The agent remains logged out until the headset is detected.

sipendpoint.headset-unplugged-set-not-ready

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether the agent SIP DN is set automatically to Not Ready when the headset that is configured for the agent is unplugged.

sipendpoint.headset-unplugged.not-ready-reason

  • Default Value: ""
  • Valid Values: A valid Not Ready reason
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Not Ready reason that is to be set for the SIP DN when the headset that is used by the agent is unplugged and sipendpoint.headset-unplugged-set-not-ready option is set to true.

sipendpoint.headset-replugged-set-ready

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether the agent SIP DN is set automatically to Ready when the headset that is used by the agent is plugged back in.

sipendpoint.init-attempt-nb

  • Default Value: 10
  • Valid Values: A positive integer value.
  • Changes take effect: When the application is started or restarted
  • Description: The maximum number of communication attempts between Workspace and Workspace SIP Endpoint during initialization. This option works in conjunction with the sipendpoint.init-attempt-timer option.

sipendpoint.init-attempt-timer

  • Default Value: 1
  • Valid Values: A positive integer value.
  • Changes take effect: When the application is started or restarted
  • Description: The interval of time, in seconds, between attempts to communicate with the Workspace SIP Endpoint during initialization. This option works in conjunction with the sipendpoint.init-attempt-nb option.

sipendpoint.log.verbose

  • Default Value: Trace
  • Valid Values: One value from the following list: All, Debug, Trace, Interaction, Standard, Alarm
  • Changes take effect: When the application is started or restarted
  • Description: Defines the level of logging for the Workspace SIP Endpoint.

sipendpoint.policy.device.audio_in_device

Added: 8.5.000.xx. Replaces: sipendpoint.genesyslab.device.audio_in_device
  • Default Value: ""
  • Valid Values: Letters A to Z and a to z, numbers 0 through 9, the underscore and space characters, and also the following regular expressions characters: (. $ ^ { [ ( | ) * + ? ).
  • Changes take effect: When the application is started or restarted.
  • Description: Device name for the agent's microphone.

sipendpoint.policy.device.audio_out_device

Added: 8.5.000.xx. Replaces: sipendpoint.genesyslab.device.audio_out_device
  • Default Value: ""
  • Valid Values: Letters A to Z and a to z, numbers 0 through 9, the underscore and space characters, and also the following regular expressions characters: (. $ ^ { [ ( | ) * + ? ).
  • Changes take effect: When the application is started or restarted.
  • Description: Device name for the agent's speakers.

sipendpoint.policy.device.capture_device

[Added: 8.5.101.14]

  • Default Value: ""
  • Valid Values: Letters A to Z and a to z, numbers 0 through 9, the underscore and space characters, and also the following regular expressions characters: (. $ ^ { [ ( | ) * + ? ).
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the regular expression used to recognize the video capture device. This option is applicable only if the value of the sipendpoint.policy.session.auto_accept_video option is set to 1. This option requires Workspace SIP Endpoint 8.5.1 or higher.

sipendpoint.policy.device.headset_name

Added: 8.5.000.xx.
  • Default Value: ""
  • Valid Values: Letters A to Z and a to z, numbers 0 through 9, the underscore and space characters, and also the following regular expressions characters: (. $ ^ { [ ( | ) * + ? ).
  • Changes take effect: When the application is started or restarted.
  • Description: The name of the agent's USB headset device. Use the "|" character to separate the names of different headsets if more than one type is supported. For example: 'Type1'|'Type2'.

sipendpoint.policy.device.use_headset

Added: 8.5.000.xx.
  • Default Value: 1
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies that a USB headset is used. The value 1 means that a USB headset is used.

sipendpoint.policy.endpoint.include_mac_address

[Added: 8.5.113.11]

  • Default Value: 0
  • Valid Values: 0 (false) or 1 (true)
  • Changes take effect: When the application is started or restarted.
  • Description: If set to 1, the MAC address is included in the Contact header of the REGISTER message of the host's network interface in a format compatible with RFC 5626.

sipendpoint.policy.endpoint.public_address

[Added: 8.5.126.07]

  • Default Value: Empty string which is fully equivalent to the $auto value.
  • Valid Values: This setting may have one of the following explicit values:
    • An IP address. For example, 192.168.16.123 for IPv4 or FE80::0202:B3FF:FE1E:8329 for IPv6.
    • A bare host name or fully qualified domain name (FQDN). For example, epsipwin2 or epsipwin2.us.example.com.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Local IP address or Fully Qualified Domain Name (FQDN) of the machine. This setting can be an explicit setting or a special value that the Workspace SIP Endpoint uses to automatically obtain the public address. This setting can have one of the following special values:
    • $auto: The SIP Endpoint selects the first valid IP address on the first network adapter that is active (status=up) and has the default gateway configured.
    • $ipv4 or $ipv6: This value has the same behavior as the $auto setting but the SIP Endpoint restricts the address to a particular IP family.
    • $host: The SIP Endpoint retrieves the standard host name for the local computer using the gethostname system function.
    • $fqdn: The SIP Endpoint retrieves the fully qualified DNS name of the local computer. The SIP Endpoint uses the GetComputerNameEx function with parameter ComputerNameDnsFullyQualified.
    • $net:subnet: The SIP Endpoint selects the first valid IP address that belongs to the specified subnet (where subnet is a full CIDR name according to RFC 4632. For example, $net:192.168.0.0/16). To support dynamic VPN connections, SIP Endpoint does not start registration attempts until the interface (configured by adapter name or subnet) is available.
    • An adapter name or part of an adapter name prefixed with $. For example, $Local Area Connection 2 or $Local. The specified name must be different from the special values $auto, $ipv4, $host, and $fqdn.

sipendpoint.policy.endpoint.rtp_inactivity_timeout

Added: 8.5.000.xx.
  • Default Value: 30
  • Valid Values: Any integer from 5 to 150.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the timeout interval for RTP inactivity. A value in the range of 5 to 150 specifies the inactivity timeout interval in seconds. The recommended value is 30 seconds. If DTX is configured on MCP, the option must be set to a higher value to prevent calls from being dropped.

sipendpoint.policy.endpoint.rtp_port_max

  • Default Value: 9999
  • Valid Values: Must be within the valid port range of 9000 to 65535.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the integer value that represents the maximum value for an RTP port range. If the minimum and maximum values are not specified or are set to an invalid value, the default minimum (9000) and maximum (9999) are used. Setting the maximum to a value that is less than the minimum is considered an error and results in a failure to initialize the endpoint.

sipendpoint.policy.endpoint.rtp_port_min

  • Default Value: 9000
  • Valid Values: Must be within the valid port range of 9000 to 65535.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the integer value that represents the minimum value for an RTP port range. If the minimum and maximum values are not specified or are set to an invalid value, the default minimum (9000) and maximum (9999) are used. Setting the minimum to a value that is larger than the maximum value is considered an error and results in a failure to initialize the endpoint.

sipendpoint.policy.endpoint.sip_port_max

  • Default Value: 5080
  • Valid Values: Must be within the valid port range of 1 to 65535.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the integer value that represents the maximum value for a SIP port range. If the minimum and maximum values are not specified or are set to an invalid value, the default minimum (5060) and maximum (minimum value + 6) are used. Setting the maximum to a value that is less than the minimum is considered an error and results in a failure to initialize the endpoint.

sipendpoint.policy.endpoint.sip_port_min

  • Default Value: 5060
  • Valid Values: Must be within the valid port range of 1 to 65535.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the integer value that represents the minimum value for a SIP port range. If the minimum and maximum values are not specified or are set to an invalid value, the default minimum (5060) and maximum (5080) are used. Setting the minimum to a value that is larger than the maximum is considered an error and results in a failure to initialize the endpoint.

sipendpoint.policy.endpoint.tcp_port_min

[Added: 8.5.113.11]

  • Default Value: 0
  • Valid Values: An integer in the range 1 to 65535 or 0.
  • Changes take effect: When the application is started or restarted.
  • Description: The minimum value for the TCP client-side port range. If set to 0, or if the configured range is not valid, SIP connections over TCP and TLS use ephemeral ports that are assigned by the operating system. This option is related to the sipendpoint.policy.endpoint.tcp_port_max option.

sipendpoint.policy.endpoint.tcp_port_max

[Added: 8.5.113.11]

  • Default Value: 0
  • Valid Values: An integer in the range 1 to 65535 or 0.
  • Changes take effect: When the application is started or restarted.
  • Description: The maximum value for a TCP client-side port range. If set to 0, or if the configured range is not valid, SIP connections over TCP and TLS use ephemeral ports, assigned by the operating system. If the value is non-zero and greater than the value of the sipendpoint.policy.endpoint.tcp_port_min option, this value specifies the maximum value for a TCP client-side SIP port range that will be used for all outgoing SIP connections over TCP and TLS transport.

sipendpoint.policy.endpoint.video_max_bitrate

[Added: 8.5.101.14]

  • Default Value: 1000
  • Valid Values: Any positive integer value greater than 0.
  • Changes take effect: When the application is started or restarted.
  • Description: The maximum video bit-rate in kb/sec.

sipendpoint.policy.endpoint.webrtc_audio_layer

[Modified: 8.5.112.08]

  • Default Value: 0
  • Valid Values: 0, 1, 2, 500, 501, 502, 1000, 1001, 1002, 2000, 2001, 2002, 3000, 3001, 3002
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies which audio layer is used for WebRTC.
    • 0: The audio layer is defined by the GCTI_AUDIO_LAYER environment variable: Core audio is used if this environment variable is not specified.
    • 1: Wave audio layer is used.
    • 2: Core audio layer is used.
    • 500: The audio layer ensures that Microsoft Windows MultiMedia Class Scheduler Service (MMCSS) is kept alive by the system independent of the actual audio activity on input and output devices. It can be combined with the values 0, 1, or 2 (500, 501, or 502) to specify the type of audio layer.
  • 1000: Instructs the audio layer to open the microphone channel when the endpoint starts up, using the audio layer type defined by option 0, and to keep it open until the endpoint is terminated. It can be combined with the values < tt>0</tt>, 1, or 2 (1000, 1001, or 1002) to specify the type of audio layer.
  • 2000: Opens the speaker channel for the life of the endpoint, using the audio layer type defined by option 0. Eliminates any delay in opening the audio device when an incoming or outgoing call is connected, for example in environments where audio device startup is slow due to a required restart of the Windows MMCSS service. It can be combined with the values 0, 1, or 2 (2000, 2001, or 2002) to specify the type of audio layer.
  • 3000: Opens the microphone and speaker channels for the life of the endpoint, using the audio layer type defined by option 0. It can be combined with the values 0, 1, or 2 (3000, 3001, or 3002) to specify the type of audio layer.

sipendpoint.policy.session.agc_mode

  • Default Value: 1
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether automatic gain control (AGC) is enabled for the outgoing headset audio stream. If set to 0, AGC is disabled; if set to 1, it is enabled.
Important
It is not possible to apply different AGC settings for different channels in multi-channel scenarios.

sipendpoint.policy.session.auto_accept_video

  • Default Value: 0
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether video calls are accepted automatically (1) or manually (0).

sipendpoint.policy.session.auto_answer

  • Default Value: 0
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether incoming SIP interactions are automatically answered. If set to 1, all incoming calls are answered automatically.

sipendpoint.policy.session.dtmf_method

  • Default Value: Rfc2833
  • Valid Values: Rfc2833, Info, or InbandRtp.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the method by which DTMF are sent.

sipendpoint.policy.session.dtx_mode

  • Default Value: 0
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether Discontinuous Transmission (DTX) is enabled. If DTX is enabled, transmission to the remote party is suspended when the application detects that the local user is not speaking. If this option is set to 1, DTX is enabled; and silence is not transmitted.

sipendpoint.policy.session.reject_session_when_headset_na

  • Default Value: 0
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether calls are rejected if a headset is unavailable. If set to 1, the SDK rejects the incoming session if a USB headset is not available.

sipendpoint.policy.session.ringback_enabled

[Added: 8.5.114.08][Modified: WSEP 8.5.115.21]

  • Default Value: 0
  • Valid Values: 0, 1, 2, 3, 4, or 6
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies how the ringback feature is enabled:
    • 0: do not play a ringback when the INVITE dialog is not yet established.
    • 1: play the incoming media stream, if provided by the media gateway in a reliable provisional response with SDP.
    • 2: play ringback from a local file only.
    • 3: always play ringback using media provided by gateway or a local file if not provided.
    • 4: same as 1, but the incoming media stream is played even if the provisional response from Media gateway is not reliable.
    • 6: the ringback is always played using either a local file or media provided by the gateway (regardless of whether the provisional response is reliable or not).

sipendpoint.policy.session.ringback_file

[Added: 8.5.114.08]

  • Default Value:
  • Valid Values: Empty or a valid path to a 16-bit 8-, 16-, or 32-Khz .wav sound file. The path may be a file name in the Workspace SIP Endpoint directory or the full path to the sound file.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the audio file that is played when the sipendpoint.policy.session.ringback_enabled option is configured to play a local file as the ringback tone.

sipendpoint.policy.session.rx_agc_mode

[Added: 8.5.126.07]

  • Default Value: 0
  • Valid Values: 0, 1
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether Receiving-side Automatic Gain Control (Rx AGC) is enabled.
    • 0: Rx AGC is disabled.
    • 1: Rx AGC is enabled; the volume of a received RTP stream is automatically adjusted, to address the problem with some calls having too low a volume for agents to hear the contact clearly.

sipendpoint.policy.session.sip_code_when_headset_na

  • Default Value: 480
  • Valid Values: Any positive integer value.
  • Changes take effect: When the application is started or restarted.
  • Description: Error code for an unavailable USB headset. The error code is sent if a call is rejected because of the unavailability of a headset. If a valid SIP error code is supplied and a USB headset is not available, the SDK rejects the incoming session with the specified SIP error code.

sipendpoint.policy.session.vad_level

  • Default Value: 0
  • Valid Values: An integer from 0 to 3.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the degree of bandwidth reduction voice activity detection (VAD). The value 0 specifies that conventional VAD is used. The value 3 specifies that "aggressive high" is used.

sipendpoint.proxies.proxy0.domain

[Added: 8.5.112.08]

  • Default Value: ""
  • Valid Values: A string representing a valid domain name.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a SIP domain (an application layer configuration that defines the management domain of a SIP proxy), including 'hostport' and an optional 'uri-parameters', as defined by RFC 3261 (but not the scheme nor 'userinfo' parts, nor 'transport' URI parameter, which are added automatically). See also the sipendpoint.proxies.proxy1.domain option.

sipendpoint.proxies.proxy0.nat.ice_enabled

  • Default Value: 0
  • Valid Values: 0, 1
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether Interactive Connectivity Establishment (ICE) is enabled or disabled for connections for Line 1.

sipendpoint.proxies.proxy0.nat.stun_server

  • Default Value: ""
  • Valid Values: Any valid host name (either with or without a Fully Qualified Domain Name) or IP Address.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Session Traversal Utilities for NAT (STUN) server address for Line 1. An empty or null value indicates this feature is not used.

sipendpoint.proxies.proxy0.nat.stun_server_port

  • Default Value: 3478
  • Valid Values: Any valid port number on the host.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Session Traversal Utilities for NAT (STUN) server port for Line 1. Relies on a value being specified for the sipendpoint.proxies.proxy0.nat.stun_server option.

sipendpoint.proxies.proxy0.nat.turn_password

  • Default Value: ""
  • Valid Values: A valid password.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the password for Traversal Using Relay NAT (TURN) authentication for Session Traversal Utilities for NAT (STUN) for Line 1. Relies on a value being specified for the sipendpoint.proxies.proxy0.nat.turn_server option.

sipendpoint.proxies.proxy0.nat.turn_relay_type

  • Default Value: 0
  • Valid Values: 0, 1
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the type of Traversal Using Relay NAT (TURN) authentication for Session Traversal Utilities for NAT (STUN) that is used for Line 1. Specify 0 for TURN over UDP, or 1 for TURN over TCP. Relies on a value being specified for the sipendpoint.proxies.proxy0.nat.turn_server option.

sipendpoint.proxies.proxy0.nat.turn_server

  • Default Value: ""
  • Valid Values: Any valid host name.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Traversal Using Relay NAT (TURN) server address for Line 1. An empty or null value indicates this feature is not used.

sipendpoint.proxies.proxy0.nat.turn_server_port

  • Default Value: 3478
  • Valid Values: Any valid port number on the host.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Traversal Using Relay NAT (TURN) server port for Line 1. Relies on a value being specified for the sipendpoint.proxies.proxy0.nat.turn_server option.

sipendpoint.proxies.proxy0.nat.turn_user_name

  • Default Value: ""
  • Valid Values: A valid user name.
  • Changes take effect: When the application is started or restarted.
  • Description: The user ID for Traversal Using Relay NAT (TURN) authorization for Line 1. Relies on a value being specified for the sipendpoint.proxies.proxy0.nat.turn_server option.

sipendpoint.proxies.proxy0.reg_interval

  • Default Value: 30
  • Valid Values: Any integer greater than or equal to 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the period, in seconds, after which the endpoint starts a new registration cycle when a SIP proxy is down for Line 1. The default value of 0 means that a new registration cycle is not allowed. If the setting is greater than 0, a new registration cycle is allowed and will start after the period specified by regInterval.

sipendpoint.proxies.proxy0.reg_timeout

  • Default Value: 1800
  • Valid Values: 0, "", or any positive integer value.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the interval of time, in seconds, after which registration should expire. A new REGISTER request is sent before expiration for Line 1. If the value is set to 0 or "" (empty/null), then registration is disabled, putting the endpoint in standalone mode.

sipendpoint.proxies.proxy1.domain

[Added: 8.5.112.08]

  • Default Value: ""
  • Valid Values: A string representing a valid domain name.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a SIP domain (an application layer configuration that defines the management domain of a SIP proxy), including 'hostport' and an optional 'uri-parameters', as defined by RFC 3261 (but not the scheme nor 'userinfo' parts, nor 'transport' URI parameter, which are added automatically). See also the sipendpoint.proxies.proxy0.domain option.

sipendpoint.proxies.proxy1.nat.ice_enabled

  • Default Value: 0
  • Valid Values: 0, 1
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether Interactive Connectivity Establishment (ICE) is enabled or disabled for Line 2 connections.

sipendpoint.proxies.proxy1.nat.stun_server

  • Default Value: ""
  • Valid Values: Any valid host name (either with or without a Fully Qualified Domain Name) or IP Address.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Session Traversal Utilities for NAT (STUN) server address for Line 2. An empty or null value indicates this feature is not used.

sipendpoint.proxies.proxy1.nat.stun_server_port

  • Default Value: 3478
  • Valid Values: Any valid port number on the host.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Session Traversal Utilities for NAT (STUN) server port for Line 2. Relies on a value being specified for the sipendpoint.proxies.proxy1.nat.stun_server option.

sipendpoint.proxies.proxy1.nat.turn_password

  • Default Value: ""
  • Valid Values: A valid password.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the password for Traversal Using Relay NAT (TURN) authentication for Session Traversal Utilities for NAT (STUN) for Line 2. Relies on a value being specified for the sipendpoint.proxies.proxy1.nat.turn_server option.

sipendpoint.proxies.proxy1.nat.turn_relay_type

  • Default Value: 0
  • Valid Values: 0, 1
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the type of Traversal Using Relay NAT (TURN) authentication for Session Traversal Utilities for NAT (STUN) that is used for Line 2. Specify 0 for TURN over UDP, or 1 for TURN over TCP. Relies on a value being specified for the sipendpoint.proxies.proxy1.nat.turn_server option.

sipendpoint.proxies.proxy1.nat.turn_server

  • Default Value: ""
  • Valid Values: Any valid host name.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Traversal Using Relay NAT (TURN) server address for Line 2. An empty or null value indicates this feature is not used.

sipendpoint.proxies.proxy1.nat.turn_server_port

  • Default Value: 3478
  • Valid Values: Any valid port number on the host.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Traversal Using Relay NAT (TURN) server port for Line 2. Relies on a value being specified for the sipendpoint.proxies.proxy1.nat.turn_server option.

sipendpoint.proxies.proxy1.nat.turn_user_name

  • Default Value: ""
  • Valid Values: A valid user name.
  • Changes take effect: When the application is started or restarted.
  • Description: The user ID for Traversal Using Relay NAT (TURN) authorization for Line 2. Relies on a value being specified for the sipendpoint.proxies.proxy1.nat.turn_server option.

sipendpoint.proxies.proxy1.reg_interval

  • Default Value: 30
  • Valid Values: Any integer greater than or equal to 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the period, in seconds, after which the endpoint starts a new registration cycle when a SIP proxy is down for Line 2. The default value of 0 means that a new registration cycle is not allowed. If the setting is greater than 0, a new registration cycle is allowed and will start after the period specified by regInterval.

sipendpoint.proxies.proxy1.reg_timeout

  • Default Value: 1800
  • Valid Values: 0, "", or any positive integer value.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the interval of time, in seconds, after which registration should expire for Line 2. A new REGISTER request is sent before expiration. If the value is set to 0 or "" (empty/null), then registration is disabled, putting the endpoint in standalone mode.

sipendpoint.retain-volume-settings-between-sessions

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether the headset and microphone volume settings are restored from the settings at the previous session login when Workspace SIP Endpoint starts.

sipendpoint.sbc-register-address

[Modified: WSEP 8.5.113.02]

  • Default Value: ""
  • Valid Values: Any valid host name (either with or without a Fully Qualified Domain Name) or DNS SRV Domain or IP Address.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the host name or DNS SRV Domain or IP Address of the Session Border Controller or SIP Proxy where the SIP REGISTER request will be sent by Workspace SIP Endpoint. If this option is empty, the SIP REGISTER request will be sent to the address specified in the TServer option sip-address of the SIP Server that monitors the DN of this agent. In Business Continuity environments, this corresponds to the preferred site registration. In environments that use a DNS SRV Domain, the value of the sipendpoint.sbc-register-port must be 0.
Tip

To set the Domain/Realm of your contact center instead of an IP when Workspace SIP Endpoint tries to register through a session border controller (SBC) device, set the value of the this option to the FQDN of your domain instead of just the IP Address.

sipendpoint.sbc-register-address.peer

[Modified: WSEP 8.5.113.02]

  • Default Value: ""
  • Valid Values: Any valid host name (either with or without a Fully Qualified Domain Name) or DNS SRV Domain or IP Address.
  • Changes take effect: When the application is started or restarted.
  • Description: In a Business Continuity environment, specifies the host name or DNS SRV Domain or IP Address of the Session Border Controller or SIP Proxy where the SIP REGISTER request is sent by Workspace SIP Endpoint. If this option is empty, the SIP REGISTER request is sent to the address specified in the TServer option sip-address of the SIP Server that monitors the DN of this agent. In Business Continuity environment this corresponds to the peer site registration. In environments that use a DNS SRV Domain, the value of the sipendpoint.sbc-register-port.peer option must be 0.
Tip

To set the Domain/Realm of your contact center instead of an IP when Workspace SIP Endpoint tries to register through a session border controller (SBC) device, set the value of the this option to the FQDN of your domain instead of just the IP Address.

sipendpoint.sbc-register-port

[Modified: WSEP 8.5.113.02]

  • Default Value: ""
  • Valid Values: Any valid port number on the host or 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the port of the Session Border Controller or SIP Proxy where the SIP REGISTER request will be sent by Workspace SIP Endpoint. If this option is empty, the SIP REGISTER request will be sent to the port that is specified in the TServer option sip-port of the SIP Server that monitors the DN of this agent. In Business Continuity environments, this corresponds to the preferred site registration. If a DNS SRV Domain is specified in the sipendpoint.sbc-register-address option, the value of this option must be 0.

sipendpoint.sbc-register-port.peer

[Modified: WSEP 8.5.113.02]

  • Default Value: ""
  • Valid Values: Any valid port number on the host or 0.
  • Changes take effect: When the application is started or restarted.
  • Description: In a Business Continuity environment, specifies the port of the Session Border Controller or SIP Proxy where the SIP REGISTER request is sent by Workspace SIP Endpoint. If this option is empty, the SIP REGISTER request is sent to the port that is specified in the TServer option sip-port of the SIP Server that monitors the DN of this agent. In Business Continuity environments, this corresponds to the peer site registration. If a DNS SRV Domain is specified in the sipendpoint.sbc-register-address.peer, the value of this option must be 0.

sipendpoint.standalone.certificate-search-value

[Added: 8.5.109.16]

  • Default Value: ""
  • Valid Values: A valid string that represents the thumbprint or a part of a certificate issuer or subject.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a string value that Workspace uses to select a certificate. This option is used only if the value of the sipendpoint.standalone.protocol option is https and the value of the sipendpoint.standalone.security-level option is set to 2 or 3. The search order with this value is:
  1. The certificate thumbprint
  2. A part of the certificate subject
  3. A part of the certificate issuer

sipendpoint.standalone.port

[Added: 8.5.109.16]

  • Default Value: 8000
  • Valid Values: A positive integer value.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the port number of the SIP Endpoint HTTP service that Workspace uses to contact the SIP Endpoint.

sipendpoint.standalone.protocol

[Added: 8.5.109.16]

  • Default Value: ""
  • Valid Values: http, https
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether Workspace should use a secure HTTPS or unsecure HTTP connection to communicate with a standalone Workspace SIP Endpoint. If no value is set, Workspace looks for a local SIP Endpoint.

sipendpoint.standalone.security-level

[Added: 8.5.109.16]

  • Default Value: 0
  • Valid Values: 0, 1, 2, or 3
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the Workspace security level for HTTPS connections. This option is applicable only if the value of the sipendpoint.standalone.protocol is https.
  • 0—Encryption without SIP Endpoint certificate validation
  • 1—Workspace makes a standard validation of SIP Endpoint certificate (certificate authority, expiration, revocation)
  • 2—Workspace makes a standard validation of SIP Endpoint certificate (certificate authority, expiration, revocation) and exposes a certificate for standard mutual TLS
  • 3—Workspace makes a personal validation of SIP Endpoint certificate (certificate authority, expiration, revocation, subject) and exposes a personal certificate for personal mutual TLS

sipendpoint.standalone.subject-criteria

[Added: 8.5.109.16]

  • Default Value: ""
  • Valid Values: A coma separated list of certificate subject fields.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a list of certificate subject fields to validate in the SIP Endpoint certificate (for example: "E,CN,OU,OU,OU,DC,DC,DC,DC"). This option is used only if the value of the sipendpoint.standalone.protocol option is https and the value of the sipendpoint.standalone.security-level option is set to 3.

sipendpoint.standalone.subject-matching-properties

[Added: 8.5.109.16]

  • Default Value: ""
  • Valid Values: A comma separated list of Active Directory Current User properties.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a list of properties of Active Directory Current User. Each defined Active Directory Current User property must match in the same order, the corresponding certificate subject fields that are specified by the value of the sipendpoint.standalone.subject-criteria. For example: "mail,cn,distinguishedName.OU,distinguishedName.OU,distinguishedName.OU,distinguishedName.DC,distinguishedName.DC,distinguishedName.DC,distinguishedName.DC". This option is used only if the value of the sipendpoint.standalone.protocol option is https and the value of the sipendpoint.standalone.security-level option is set to 3.

sipendpoint.standalone.vdi-detection-model

[Added: 8.5.109.16]

  • Default Value: auto
  • Valid Values: auto, xenapp, xendesktop, vmware-horizon, or rdp
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the type of Virtual Desktop Infrastructure (VDI) environment Workspace is running, and determines the address detection model used by Workspace to connect to the Standalone SIP Endpoint that is running on the local physical workstation. This option is used only if sipendpoint.standalone.protocol option is not empty. The following VDI environments are supported:
  • auto—Workspace automatically detects the VDI type
  • xenapp—The VDI type is Citrix XenApp
  • xendesktop—The VDI type is Citrix XenDesktop
  • vmware-horizon—The VDI type is VMware Horizon
  • rdp—The VDI type is Microsoft Remote Desktop Protocol (RDP)

sipendpoint.system.diagnostics.enable_logging

  • Default Value: 1
  • Valid Values: 1, 0.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether logging is enabled for Workspace SIP Endpoint. A value of 1 enables this feature.

sipendpoint.system.diagnostics.log_filter

[Added: 8.5.114.08]

  • Default Value:
  • Valid Values: dtmf or blank.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of keys of SIP Messages for which the value should be hidden in the log files.

sipendpoint.system.diagnostics.log_level

Modified: 8.5.000.xx.
  • Default Value: Error
  • Valid Values: 0, 1, 2, 3, or 4
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the log level for Workspace SIP Endpoint.
    • 0 = "Fatal"
    • 1 = "Error"
    • 2 = "Warning"
    • 3 = "Info"
    • 4 = "Debug"

sipendpoint.system.diagnostics.log_options_provider

  • Default Value: gsip=2, webrtc=(warning)
  • Valid Values: A comma-separated list of log levels for webrtc from the following list: warning, state, api, debug, info, error, critical.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the log level for webrtc. For example: gsip=2, webrtc=(error,critical)

sipendpoint.system.security.cert_file

  • Default Value: ""
  • Valid Values: A valid certificate thumbprint.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the thumbprint value of the Public endpoint certificate file, which is used as a client-side certificate for outgoing TLS connection and server-side certificate for incoming TLS connections. For example: 78 44 34 36 7a c2 22 48 bd 5c 76 6b 00 84 5d 66 83 f5 85 d5

sipendpoint.system.security.tls_enabled

  • Default Value: 0
  • Valid Values: 0, 1.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies with TLS transport is registered. If the value is set to 1, the connection with TLS transport is registered.

sipendpoint.system.security.use_srtp

[Modified: 8.5.112.08, 8.5.126.07]

  • Default Value: optional
  • Valid Values: One of the following values: optional, allowed, disabled, off, elective, both, enabled, force, mandatory
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether to use SRTP (Secure Real-Time Transport Protocol)
    • optional or allowed: Do not send secure offers, but accept them.
    • disabled or off: Do not send secure offers and reject incoming secure offers.
    • elective or both: Send both secure and non-secure offers and accept either.
    • enabled: Send secure offers, accept both secure and non-secure offers.
    • force or mandatory: Send secure offers, reject incoming non-secure offers.
    Adding either ',UNENCRYPTED_SRTCP' (long form) or ',UEC' (short form) to any value (for example, 'enabled,UEC'), adds the UNENCRYPTED_SRTCP parameter to that offer. When this parameter is negotiated, RTCP packets are not encrypted but are still authenticated.
    Note: Workspace SIP Endpoint supports only the Session Description Protocol Security Descriptions (SDES) method to negotiate SRTP keys.

sipendpoint.transport-protocol

  • Default Value: UDP
  • Valid Values: UDP, TCP, TLS
  • Changes take effect: When the application is started or restarted.
  • Description: Specify whether UDP, TCP, or TLS is used for the SIP transport protocol.

sipendpoint.video.always-on-top

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether the Video Window, when it is displayed, is displayed on top of all the other windows of end user workstation without the possibility to put it in the background.

sipendpoint.video.auto-activate

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies whether or not the video window is populated automatically when an incoming interaction, which has a video component, is connected. If the value false is specified, the video can be activated later by using the 'Start Video' button.

sipendpoint.video.camera-frame-rate

  • Default Value: 30
  • Valid Values: An integer that specifies the rate, in frame per second, of the video camera capture.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the video capture rate, in frame per second, of the local video camera.

sipendpoint.video.camera-frame-size

  • Default Value: 352x288
  • Valid Values: A string that specifies the width and height, separated by an 'x', of the camera frame capture (for example: 353x288).
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the frame size capture of the local video camera. To determine the list of available resolutions, consult the specifications of your device or check the Workspace SIP Endpoint logs, which prints the list of available frame sizes.

sipendpoint.video.camera-render-format

  • Default Value: 6
  • Valid Values: A integer between 0 and 13 that specifies the render format of camera capture.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the video format of the local video camera. To determine the list of available formats, consult the specifications of your device or check Workspace SIP Endpoint logs, which prints the list of available video formats. The following values correspond to the supported video formats:
    • 0 = i420
    • 1 = YV12
    • 2 = YUY2
    • 3 = UYVY
    • 4 = IYUV
    • 5 = ARGB
    • 6 = RGB24
    • 7 = RGB565
    • 8 = ARGB4444
    • 9 = ARGB1555
    • 10 = MJPEG
    • 11 = NV12
    • 12 = NV21
    • 13 = BGRA

sipendpoint.video.thumbnail-ratio

  • Default Value: 0.25
  • Valid Values: A floating point value.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the size ratio of the thumbnail to the video in the SIP video window when both local and remote video are displayed.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on October 26, 2018, at 06:33.