Jump to: navigation, search

sipendpoint.video.thumbnail-ratio

Section: interaction-workspace
Default Value: 0.25
Valid Values: A float value.
Changes Take Effect: When the application is started or restarted.


Specifies the size ratio of the thumbnail to the video in the SIP video window when both local and remote video are displayed.

sipendpoint.video.camera-render-format

Section: interaction-workspace
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.


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.camera-frame-size

Section: interaction-workspace
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.


Specifies the frame size capture of the local video camera. To determine the list of available resolutions, consult the specificatio​ns of your device or check the Workspace SIP Endpoint logs, which prints the list of available frame sizes.

sipendpoint.video.camera-frame-rate

Section: interaction-workspace
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.


Specifies the video capture rate, in frame per second, of the local video camera.

sipendpoint.video.auto-activate

Section: interaction-workspace
Default Value: true
Valid Values: true false
Changes Take Effect: When the application is started or restarted.


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.always-on-top

Section: interaction-workspace
Default Value: true
Valid Values: true false
Changes Take Effect: When the application is started or restarted.


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.transport-protocol

Section: interaction-workspace
Default Value: UDP
Valid Values: A value from the following list: UDP,TCP,TLS.
Changes Take Effect: When the application is started or restarted.


Specifies the transport protocol that is used by Workspace SIP Endpoint for SIP Communication. This option can be used with Interaction Workspace SIP Endpoint 8.0.204 and above.

sipendpoint.system.security.use_srtp

Section: interaction-workspace
Default Value: optional
Valid Values: One value from the following list: optional, allowed, disabled, off, elective, both, enabled, force, mandatory
Changes Take Effect: When the application is started or restarted.
Modified: 8.5.112.08, 8.5.126.07

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.system.security.tls_enabled

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


Specifies with TLS transport is registered. If the value is set to 1, the connection with TLS transport is registered.

sipendpoint.system.security.cert_file

Section: interaction-workspace
Default Value:
Valid Values: A valid certificate thumbprint.
Changes Take Effect: When the application is started or restarted.


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.diagnostics.log_options_provider

Section: interaction-workspace
Default Value: gsip=2, webrtc=(warning)
Valid Values: gsip=x (where x is a valid value for gsip) + , + webrtc=(y) (where valid values for y are warning, state, api, debug, info, error, and/or critical). For example: gsip=2, webrtc=(error,critical)
Changes Take Effect: When the application is started or restarted.


Specifies the log level for webrtc. For example: gsip=2, webrtc=(error,critical)

sipendpoint.system.diagnostics.log_level

Section: interaction-workspace
Default Value: 0
Valid Values: 0, 1, 2, 3, or 4
Changes Take Effect: When the application is started or restarted.


Specifies the log level for Workspace SIP Endpoint.

  • 0 = "Fatal"
  • 1 = "Error"
  • 2 = "Warning"
  • 3 = "Info"
  • 4 = "Debug"

sipendpoint.system.diagnostics.log_filter

Section: interaction-workspace
Default Value:
Valid Values: dtmf or blank.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.114.08

Specifies the list of keys of SIP Messages for which the value should be hidden in the log files.

sipendpoint.system.diagnostics.enable_logging

Section: interaction-workspace
Default Value: 1
Valid Values: 1, 0
Changes Take Effect: When the application is started or restarted.


Specifies whether logging is enabled for Workspace SIP Endpoint. A value of 1 enables this feature. This option applies to Workspace SIP Endpoint 8.0.2.

sipendpoint.standalone.vdi-detection-model

Section: interaction-workspace
Default Value: auto
Valid Values: One value from the list: auto,xenapp,xendesktop,vmware-horizon,rdp,localhost
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.standalone.protocol
Introduced: 8.5.109.16
Modified: 8.5.131.07

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 (for Workspace SIP End Point only)
  • xenapp—The VDI type is Citrix XenApp (for Workspace SIP End Point only)
  • xendesktop—The VDI type is Citrix XenDesktop (for Workspace SIP End Point only)
  • vmware-horizon—The VDI type is VMware Horizon (for Workspace SIP End Point only)
  • rdp—The VDI type is Microsoft Remote Desktop Protocol (RDP) (for Workspace SIP End Point only)
  • localhost—The SIP Endpoint is running on the VDI server along with Workspace (applicable only when the SIP Endpoint is Genesys Softphone, which must be deployed specifically for VDI environments)

sipendpoint.standalone.subject-matching-properties

Section: interaction-workspace
Default Value:
Valid Values: A comma separated list of Active Directory Current User properties.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.standalone.subject-criteria, sipendpoint.standalone.protocol, sipendpoint.standalone.security-level
Introduced: 8.5.109.16

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.subject-criteria

Section: interaction-workspace
Default Value:
Valid Values: A coma separated list of certificate subject fields.
Changes Take Effect: At next application start.
Dependencies: sipendpoint.standalone.protocol, sipendpoint.standalone.security-level
Introduced: 8.5.109.16

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.security-level

Section: interaction-workspace
Default Value: 0
Valid Values: One value from the list: 0, 1, 2, 3
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.standalone.protocol
Introduced: 8.5.109.16

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.protocol

Section: interaction-workspace
Default Value:
Valid Values: http, https
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.109.16

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.port

Section: interaction-workspace
Default Value: 8000
Valid Values: A positive integer value.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.109.16

Specifies the port number of the SIP Endpoint HTTP service that Workspace uses to contact the SIP Endpoint.

sipendpoint.standalone.certificate-search-value

Section: interaction-workspace
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.
Dependencies: sipendpoint.standalone.protocol, sipendpoint.standalone.security-level
Introduced: 8.5.109.16

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.sbc-register-port.peer

Section: interaction-workspace
Default Value:
Valid Values: Any valid port number on the host or 0.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.sbc-register-address.peer
Modified: Workspace SIP Endpoint 8.5.113.02

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.sbc-register-port

Section: interaction-workspace
Default Value:
Valid Values: Any valid port number on the host.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.sbc-register-address
Modified: Workspace SIP Endpoint 8.5.113.02

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-address.peer

Section: interaction-workspace
Default Value:
Valid Values: Any valid port number on the host or 0.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.sbc-register-address.peer
Modified: Workspace SIP Endpoint 8.5.113.02

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 for the peer site. If this option is empty, the SIP REGISTER request is sent to the address that is 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 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.

Note: 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

Section: interaction-workspace
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.
Modified: Workspace SIP Endpoint 8.5.113.02
Related Options: sipendpoint.sbc-register-port

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.

Note: 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.retain-volume-settings-between-sessions

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.


Specifies whether the headset and microphone volume settings are restored from the settings at the previous session login when Workspace SIP Endpoint starts.

sipendpoint.proxies.proxy1.reg_timeout

Section: interaction-workspace
Default Value: 1800
Valid Values: Integers greater than or equal to 0.
Changes Take Effect: When the application is started or restarted.


Specifies the interval of time, in seconds, after which registration should expire on Line 2. A new REGISTER request is sent before expiration. If the setting is 0 or empty/null, then registration is disabled, putting the endpoint in standalone mode.

sipendpoint.proxies.proxy1.reg_interval

Section: interaction-workspace
Default Value: 30
Valid Values: An integer greater than or equal to 0.
Changes Take Effect: When the application is started or restarted.


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.nat.turn_user_name

Section: interaction-workspace
Default Value:
Valid Values: A valid user name.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy1.nat.turn_server

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.nat.turn_server_port

Section: interaction-workspace
Default Value: 3478
Valid Values: A valid port number.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy1.nat.turn_server

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_server

Section: interaction-workspace
Default Value:
Valid Values: A valid host name.
Changes Take Effect: When the application is started or restarted.


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.proxy1.nat.turn_relay_type

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (TURN over UDP) or 1 (TURN over TCP)
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy0.nat.turn_server

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.proxy1.nat.turn_password

Section: interaction-workspace
Default Value:
Valid Values: A valid password.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy1.nat.turn_server

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.stun_server_port

Section: interaction-workspace
Default Value: 3478
Valid Values: Any valid port number on the host.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy1.nat.stun_server

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.stun_server

Section: interaction-workspace
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.


Specifies the Session Traversal Utilities for NAT (STUN) server address of Line 2. An empty or null value indicates this feature is not used.

sipendpoint.proxies.proxy1.nat.ice_enabled

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


Specifies whether Interactive Connectivity Establishment (ICE) is enabled or disabled for connections on line 2.

sipendpoint.proxies.proxy1.domain

Section: interaction-workspace
Default Value:
Valid Values: A valid domain name.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.112.08
Related Options: sipendpoint.proxies.proxy0.domain

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.proxy0.reg_timeout

Section: interaction-workspace
Default Value: 1800
Valid Values: Integers greater than or equal to 0.
Changes Take Effect: When the application is started or restarted.


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.proxy0.reg_interval

Section: interaction-workspace
Default Value: 30
Valid Values: An integer greater than or equal to 0.
Changes Take Effect: When the application is started or restarted.


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.nat.turn_user_name

Section: interaction-workspace
Default Value:
Valid Values: A valid user name.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy0.nat.turn_server

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.nat.turn_server_port

Section: interaction-workspace
Default Value: 3478
Valid Values: Any valid port number on the host.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy0.nat.turn_server

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_server

Section: interaction-workspace
Default Value:
Valid Values: A valid host name.
Changes Take Effect: When the application is started or restarted.


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_relay_type

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (TURN over UDP) or 1 (TURN over TCP)
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy0.nat.turn_server

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_password

Section: interaction-workspace
Default Value:
Valid Values: A valid password.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy0.nat.turn_server

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.stun_server_port

Section: interaction-workspace
Default Value: 3478
Valid Values: Any valid port number on the host.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.proxies.proxy0.nat.stun_server

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.stun_server

Section: interaction-workspace
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.


Specifies the Session Traversal Utilities for NAT (STUN) server address of Line 1. An empty or null value indicates this feature is not used.

sipendpoint.proxies.proxy0.nat.ice_enabled

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


Specifies whether Interactive Connectivity Establishment (ICE) is enabled or disabled for connections on line 1.

sipendpoint.proxies.proxy0.domain

Section: interaction-workspace
Default Value:
Valid Values: A valid domain name.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.112.08
Related Options: sipendpoint.proxies.proxy1.domain

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.policy.session.vad_level

Section: interaction-workspace
Default Value: 0
Valid Values: An integer from 0 to 3.
Changes Take Effect: When the application is started or restarted.


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.policy.session.sip_code_when_headset_na

Section: interaction-workspace
Default Value: 480
Valid Values: Any positive integer value.
Changes Take Effect: When the application is started or restarted.


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.rx_agc_mode

Section: interaction-workspace
Default Value: 0
Valid Values: 0, 1
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.126.07

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.ringback_file

Section: interaction-workspace
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.
Dependencies: sipendpoint.policy.session.ringback_enabled
Introduced: 8.5.114.08

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.ringback_enabled

Section: interaction-workspace
Default Value: 0
Valid Values: 0, 1, 2, 3, 4, or 6
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.114.08
Modified: WSEP 8.5.115.21
Related Options: sipendpoint.policy.session.ringback_file

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.reject_session_when_headset_na

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


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.noise_suppression

Section: interaction-workspace
Default Value: 0
Valid Values: 0, 1
Changes Take Effect: Immediately.


Specifies whether headset noise suppression is disabled (0) or enabled (1) for the session.

sipendpoint.policy.session.echo_control

Section: interaction-workspace
Default Value: 0
Valid Values: 0, 1
Changes Take Effect: Immediately.


Specifies whether headset echo control is disabled (0) or enabled (1) for the session.

sipendpoint.policy.session.dtx_mode

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


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.dtmf_method

Section: interaction-workspace
Default Value: rfc2833
Valid Values: One value from this list: rfc2833, Info, InbandRtp.
Changes Take Effect: When the application is started or restarted.


Specifies the method by which DTMF are sent.

sipendpoint.policy.session.auto_answer

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


Specifies whether incoming SIP interactions are automatically answered. If set to 1, all incoming calls are answered automatically.

sipendpoint.policy.session.auto_accept_video

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


Specifies whether video calls are accepted automatically (1) or manually (0).

sipendpoint.policy.session.agc_mode

Section: interaction-workspace
Default Value: 1
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


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.

Note: It is not possible to apply different AGC settings for different channels in multi-channel scenarios.

sipendpoint.policy.endpoint.webrtc_audio_layer

Section: interaction-workspace
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.
Modified: 8.5.112.08

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 0, 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.endpoint.video_max_bitrate

Section: interaction-workspace
Default Value: 1000
Valid Values: Any positive integer value greater than 0.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.101.14

The maximum video bit-rate in kb/sec.

sipendpoint.policy.endpoint.tcp_port_max

Section: interaction-workspace
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.
Dependencies: sipendpoint.policy.endpoint.tcp_port_min
Introduced: 8.5.113.11

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.tcp_port_min

Section: interaction-workspace
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.
Dependencies: sipendpoint.policy.endpoint.tcp_port_max
Introduced: 8.5.113.11

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.sip_port_min

Section: interaction-workspace
Default Value: 5060
Valid Values: An integer of the range 1-65535
Changes Take Effect: When the application is started or restarted.
Related Options: sipendpoint.policy.endpoint.sip_port_max

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.sip_port_max

Section: interaction-workspace
Default Value: 5080
Valid Values: An integer of the range 1-65535
Changes Take Effect: When the application is started or restarted.
Related Options: sipendpoint.policy.endpoint.sip_port_min

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 (5080) 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

Section: interaction-workspace
Default Value: 9000
Valid Values: An integer of the range 9000-65535
Changes Take Effect: When the application is started or restarted.
Related Options: sipendpoint.policy.endpoint.rtp_port_max

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.rtp_port_max

Section: interaction-workspace
Default Value: 9999
Valid Values: An integer of the range 1-65535
Changes Take Effect: When the application is started or restarted.
Related Options: sipendpoint.policy.endpoint.rtp_port_min

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_inactivity_timeout

Section: interaction-workspace
Default Value: 30
Valid Values: Any integer from 5 to 150.
Changes Take Effect: When the application is started or restarted.


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.public_address

Section: interaction-workspace
Default Value: Empty string which is fully equivalent to the $auto value.
Valid Values: Refer to the description.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.126.07

  • 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.
  • 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.include_mac_address

Section: interaction-workspace
Default Value: 0
Valid Values: 0 (false) or 1 (true)
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.113.11

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.defer_device_release

Section: interaction-workspace
Default Value: 200
Valid Values: Any positive integer
Changes Take Effect: When the application is started or restarted.
Introduced: WSEP 8.5.115.27

Specifies a time in milliseconds before releasing audio devices after the audio stream has been stopped. Deferring device release avoids potential service interruptions if the audio will be restarted quickly and if audio device operations are too slow on the user workstation or has other problems with restart. The value 0 disables deferred device release.

sipendpoint.policy.device.use_headset

Section: interaction-workspace
Default Value: 1
Valid Values: 0 (for false), 1 (for true)
Changes Take Effect: When the application is started or restarted.


Specifies that a USB headset is used. The value 1 means that a USB headset is used.

sipendpoint.policy.device.headset_name

Section: interaction-workspace
Default Value:
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters. And also Regular expressions characters (. $ ^ { [ ( | ) * + ? \).
Changes Take Effect: When the application is started or restarted.


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.capture_device

Section: interaction-workspace
Default Value:
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters. And also Regular expressions characters (. $ ^ { [ ( | ) * + ? \).
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.policy.session.auto_accept_video
Introduced: 8.5.101.14

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.audio_out_device

Section: interaction-workspace
Default Value:
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters. And also Regular expressions characters (. $ ^ { [ ( | ) * + ? \).
Changes Take Effect: When the application is started or restarted.


Specifies the regular expression used to recognize device name for the agent's speakers. This option requires Workspace SIP Endpoint 8.5.1 or above.

sipendpoint.policy.device.audio_in_device

Section: interaction-workspace
Default Value:
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters. And also Regular expressions characters (. $ ^ { [ ( | ) * + ? \).
Changes Take Effect: When the application is started or restarted.


Specifies the regular expression used to recognize the device name for the agent's microphone. This option requires Workspace SIP Endpoint 8.5.1 or above.

sipendpoint.log.verbose

Section: interaction-workspace
Default Value: Trace
Valid Values: Select a value from the following list: All, Debug, Trace, Interaction, Standard, Alarm, None.
Changes Take Effect: When the application is started or restarted.


Defines the level of logging for the Workspace SIP Endpoint. If set to None, no log file is created for Workspace SIP Endpoint.

sipendpoint.init-attempt-timer

Section: interaction-workspace
Default Value: 1
Valid Values: A positive integer value.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.init-attempt-nb

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.init-attempt-nb

Section: interaction-workspace
Default Value: 10
Valid Values: A positive integer value.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.init-attempt-timer

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.headset-replugged-set-ready

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.


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.headset-unplugged.not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid Not Ready reason.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.headset-unplugged-set-not-ready

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-unplugged-set-not-ready

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.


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-enforce-configured-usage

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.genesys.device.headset_name

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.exit-on-voice-logoff

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At next Log Off operation or at next login.


Specifies whether Interaction 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 Interaction 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 Interaction Workspace SIP Endpoint is restarted.

sipendpoint.core-deadlock-detection-delay

Section: interaction-workspace
Default Value: 12500
Valid Values: Any positive integer value.
Changes Take Effect: When the application is started or restarted.


Specifies the time, in milliseconds, that Workspace SIP Endpoint waits when it detects that its main subsystem has become unresponsive before considering itself deadlocked. When Workspace SIP Endpoint considers itself deadlocked, it automatically restarts. Genesys recommends that you specify a value greater than 12500 ms.

sipendpoint.codecs.h264.fmtp

Section: interaction-workspace
Default Value: profile-level-id=420028
Valid Values: The string 'profile-level-id=' followed by a sequence of 3 hexadecimal values in the '00'-'FF' range that respectively define the profile_idc, profile-iop and level-idc.
Changes Take Effect: When the application is started or restarted.
Dependencies: sipendpoint.policy.session.auto_accept_video
Introduced: 8.5.101.14

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.codecs.g729/8000.fmtp

Section: interaction-workspace
Default Value: annexb=yes
Valid Values: annexb=yes, annexb=no
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.101.14

Specifies whether the G729 codec is configured with AnnexB = Yes or AnnexB = No.

sipendpoint.authenticate-with-dn-password

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At next Log Off operation or at next login.
Modified: 8.5.117.26
Related Options: login.voice.prompt-dn-password

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).

Workspace SIP Endpoint options

Tip
For the most up to date Workspace Desktop Edition configuration options, see the Genesys Configuration Option Database.
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.

Related Resources

The following topics discuss the implementation of these options:

This page was last edited on June 7, 2021, at 17:50.
blog comments powered by Disqus