Revision as of 14:32, March 13, 2018

SIP Endpoint

Workspace Web Edition provides the following options for managing SIP Endpoints, such as the Genesys Softphone:

sipendpoint.authenticate-using-dn-password-config

Default value: true
Valid values: true, false
Change take effect: When the session is started or restarted.
Description: If set to true, the DN where the agent is logging in has option TServer/authenticate-requests set to a valid non-empty value, Workspace configures Workspace SIP Endpoint with the value that it reads in the TServer/password DN option. If set to false, Workspace does not configure Workspace SIP Endpoint with a DN password.

sipendpoint.headset-unplugged.not-ready-reason

Default Value: ""
Valid Values: A valid Not Ready reason.
Change takes effect: When the session 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 if the value of the sipendpoint.headset-unplugged-set-not-ready option is set to true.

sipendpoint.headset-unplugged-set-not-ready

Default value: true
Valid values: true, false
Change takes effect: When the session 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.max-failed-ping

Default value: 5
Valid values: A correct integer
Change take effect: When the session is started or restarted.
Description: Number of failed pings allowed on Genesys Softphone.

sipendpoint.ping-interval

Default value: 2000
Valid values: A correct integer
Change take effect: When the session is started or restarted.
Description : Interval in milliseconds between each ping of the Genesys Softphone.

sipendpoint.register-interval

Default value: 1500
Valid values: A correct integer
Change take effect: When the session is started or restarted.
Description: Interval in milliseconds between each register on the Genesys Softphone.

sipendpoint.register-max-attempts

Default value: 10
Valid values: A correct integer
Change take effect: When the session is started or restarted.
Description: Number of failed attempts allowed on check if register is done.

sipendpoint.sip-server-address

Default value:
Valid values: Any valid IP address or host name
Change take effect: When the session is started or restarted.
Description: Address of the sip server and, optionally, the port using the <address>:<port> format. If the port is not specified, the Genesys Softphone uses DNS SRV resolution for the specified address.

In Business continuity environments, this option specifies the host name or IP address of the session border controller where the SIP REGISTER request will be sent by Workspace SIP Endpoint. If this option is empty, the SIP REGISTER request is sent to the address specified in the sip-address TServer option of the SIP Server that monitors the DN of this agent. In Business Continuity environments, this corresponds to the preferred site registration.

To set the Domain/Realm of your contact center instead of an IP address 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.sip-server-address.peer

Default value:
Valid values: Any valid IP address or host name
Change take effect: When the session is started or restarted.
Description: Address of the peer sip server and, optionally, the port using the <address>:<port> format. If the port is not specified, the Genesys Softphone uses DNS SRV resolution for the specified address. Requires Genesys Softphone 8.5.400.08 or higher.

In Business Continuity environments, this option specifies the host name or IP address of the session border controller where the peer SIP REGISTER request will be sent by Workspace SIP Endpoint. If this option is empty, the SIP REGISTER request is sent to the address specified in the sip-address TServer option of the SIP Server that monitors the DN of this agent. In Business Continuity environments, this corresponds to the peer site registration.

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

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

sipendpoint.uri

Default value:
Valid values: A correct URI
Change take effect: When the session is started or restarted.
Description : URI of the SIP endpoint.

sipendpoint.wait-user-max-attempts

Default value: 20
Valid values: An integer value greater than 0.
Change take effect: When the session is started or restarted.
Description : The number of failed waiting user actions that are allowed before timeout.

privilege.sipendpoint-can-change-microphone-volume

Default value : false
Valid values : true, false
Changes take effect : When the session is started or restarted.
Description : Allows agents to change the volume of the microphone. Depends on privilege.voice.can-use and privilege.sipendpoint.can-use.

privilege.sipendpoint-can-change-speaker-volume

Default value : false
Valid values : true, false
Changes take effect : When the session is started or restarted.
Description : Allows agents to change the volume of the speaker. Depends on privilege.voice.can-use and privilege.sipendpoint.can-use.

privilege.sipendpoint-can-mute-microphone

Default Value: false
Valid Values: true, false
Changes take effect: When the session is started or restarted.
Description: Allows agents to mute and unmute the microphone. Depends on privilege.voice.can-use and privilege.sipendpoint.can-use.

privilege.sipendpoint-can-mute-speaker

Default Value: false
Valid Values: true, false
Changes take effect: When the session is started or restarted.
Description: Allows agents to mute and unmute the speaker. Depends on privilege.voice.can-use and privilege.sipendpoint.can-use.

privilege.sipendpoint-can-use

Default value : false
Valid values : true, false
Change take effect : When the session is started or restarted.
Description : Enables use of Genesys Softphone. Depends on privilege.voice.can-use.

@@ Line 72: / Line 72: @@
 * Description : The number of failed waiting user actions that are allowed before timeout.
-====privilege.sipendpoint.can-change-microphone-volume====
+====privilege.sipendpoint-can-change-microphone-volume====
 * Default value : <tt>false</tt>
 * Valid values : <tt>true</tt>, <tt>false</tt>
 * Changes take effect : When the session is started or restarted.
-* Description : Allows agents to change the volume of the microphone. Depends on [[Voice#privilege.voice.can-use|privilege.voice.can-use]] and [[SIPEndpoint#privilege.sipendpoint.can-use|privilege.sipendpoint.can-use]].
+* Description : Allows agents to change the volume of the microphone. Depends on {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-voice-can-use}} and {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-sipendpoint-can-use}}.
-====privilege.sipendpoint.can-change-speaker-volume====
+====privilege.sipendpoint-can-change-speaker-volume====
 * Default value : <tt>false</tt>
 * Valid values : <tt>true</tt>, <tt>false</tt>
 * Changes take effect : When the session is started or restarted.
-* Description : Allows agents to change the volume of the speaker. Depends on [[Voice#privilege.voice.can-use|privilege.voice.can-use]] and [[SIPEndpoint#privilege.sipendpoint.can-use|privilege.sipendpoint.can-use]].
+* Description : Allows agents to change the volume of the speaker. Depends on {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-voice-can-use}} and {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-sipendpoint-can-use}}.
-====privilege.sipendpoint.can-mute-microphone====
+====privilege.sipendpoint-can-mute-microphone====
 * Default Value: <tt>false</tt>
 * Valid Values: <tt>true</tt>, <tt>false</tt>
 * Changes take effect: When the session is started or restarted.
-* Description: Allows agents to mute and unmute the microphone. Depends on [[Voice#privilege.voice.can-use|privilege.voice.can-use]] and [[SIPEndpoint#privilege.sipendpoint.can-use|privilege.sipendpoint.can-use]].
+* Description: Allows agents to mute and unmute the microphone. Depends on {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-voice-can-use}} and {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-sipendpoint-can-use}}.
-====privilege.sipendpoint.can-mute-speaker====
+====privilege.sipendpoint-can-mute-speaker====
 * Default Value: <tt>false</tt>
 * Valid Values: <tt>true</tt>, <tt>false</tt>
 * Changes take effect: When the session is started or restarted.
-* Description: Allows agents to mute and unmute the speaker. Depends on [[Voice#privilege.voice.can-use|privilege.voice.can-use]] and [[SIPEndpoint#privilege.sipendpoint.can-use|privilege.sipendpoint.can-use]].
+* Description: Allows agents to mute and unmute the speaker. Depends on {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-voice-can-use}} and {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-sipendpoint-can-use}}.
-====privilege.sipendpoint.can-use====
+====privilege.sipendpoint-can-use====
 * Default value : <tt>false</tt>
 * Valid values : <tt>true</tt>, <tt>false</tt>
 * Change take effect : When the session is started or restarted.
-* Description : Enables use  of Genesys Softphone. Depends on [[Voice#privilege.voice.can-use|privilege.voice.can-use]].
+* Description : Enables use  of Genesys Softphone. Depends on {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:privilege-voice-can-use}}.
 [[Category:V:HTCC:8.5.2]]