Release Note

SIP Endpoint SDK for .NET

8.5.x

Genesys Telecommunications Laboratories, Inc. © 2013–2018

Contents

Introduction

Release Number AIX HP-UX PA HP-UX IPF Linux Solaris Windows
8.5.200.66 [04/13/2018] – Hot Fix           X
8.5.200.62 [11/01/2016] – Hot Fix           X
8.5.200.59 [09/27/2016] – Hot Fix           X
8.5.200.58 [09/09/2016] – Hot Fix           X
8.5.200.51 [08/19/2016] – General           X
8.5.200.45 [06/14/2016] – Hot Fix           X
8.5.200.40 [04/29/2016] – Hot Fix           X
8.5.200.31 [03/16/2016] – Hot Fix           X
8.5.200.27 [01/26/2016] – Hot Fix           X
8.5.200.25 [10/28/2015] – Hot Fix           X
8.5.200.22 [10/02/2015] – Hot Fix           X
8.5.100.34 [07/16/2015] – Hot Fix           X
8.5.100.33 [04/08/2015] – Hot Fix           X
8.5.200.17 [04/02/2015] – General           X
8.5.100.32 [12/17/2014] – Hot Fix           X
8.5.100.30 [11/20/2014] – Hot Fix           X
8.5.100.25 [09/15/2014] – Hot Fix           X
8.5.100.24 [08/29/2014] – General           X
8.5.000.18 [12/20/2013] – General           X

Link to 8.1 Product Release Note (Cumulative)
Known Issues and Recommendations
Discontinued Support
Internationalization
Additional Information


Introduction

This release note applies to all 8.5 releases of SIP Endpoint SDK for .NET.

Use of Third-Party Software

Genesys follows applicable third-party redistribution policies to the extent that Genesys solutions utilize third-party functionality. For additional information about third-party software used in this product, see the Read Me. Please contact your Customer Care representative if you have any questions.


Release Number 8.5.200.66 [04/13/18] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release does not contain new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


Audio startup or shutdown problems can be resolved by using the new values added to the policy.endpoint.webrtc_audio_layer option. (SEPSDK-1460)


Top of Page


Release Number 8.5.200.62 [11/01/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

There are no corrections or modifications for this release.

Top of Page


Release Number 8.5.200.59 [09/27/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

This release includes the following corrections and modifications:


SIP Endpoint SDK for .NET now correctly processes cases where ICE setup fails because of misconfiguration or insufficient resources. Previously, this case caused the SDK to get stuck in the Gathering local candidates step and never produce a valid SDP. Now, the SDK correctly recovers from the error and produces an SDP with ICE disabled. (SEPSDK-1434)


In cases where the SDK does not find the configured audio devices or no audio devices are configured, SIP Endpoint SDK for .NET now properly sets the selected device to your Default Communication Device. (SEPSDK-1430)


Top of Page


Release Number 8.5.200.58 [09/09/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

This release includes the following corrections and modifications:


This release fixes the default value for the ice_enabled configuration setting. Now, ICE is properly disabled in cases where no such setting exists. Previously, SIP Endpoint SDK could enable ICE with experimental features that were not fully tested and caused a resource leak. (SEPSDK-1426)


SIP Endpoint SDK for .NET now correctly sends # and * characters through DTMF with the INFO method. Previously, SIP Endpoint SDK for .NET incorrectly put the numerical event code into the INFO body instead of the character event name. (SEPSDK-1423)


This release corrects an issue in SIP Endpoint SDK for .NET that could result in unexpected application shutdowns or deadlocks in cases where a call is released immediately after being established. (SEPSDK-1401)


Top of Page


Release Number 8.5.200.51 [08/19/16] – General

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Note: This version was first released as a Hot Fix on 07/20/16.

Corrections and Modifications

This release includes the following corrections and modifications:


Fixed an issue where SIP Endpoint SDK incorrectly retrieved a call from hold when a session-refresh INVITE was received for the call. (SEPSDK-1360)


This release improves the automatic selection of the local IP address. SIP Endoint SDK now takes the Metric network adapter parameter into account and correctly obtains the IP address in cases where multiple adapters are available such as when a VPN is in use. Previously, SIP Endpoint SDK could incorrectly pick up the IP address from an adapter not currently in use like a physical network adapter superseded by the VPN. (SEPSDK-1355)


Top of Page


Release Number 8.5.200.45 [06/14/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release does not contain new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


SIP Endpoint SDK for .NET now completely stops handling a media stream during a Hold operation and restarts the stream on Retrieve. Previously, the SDK suppressed the stream on the transport level. This change adds a negligible delay to hold/retrieve operations but significantly improves reliability. This change also fixes an issue where the SDK did not properly restore the media stream after a transfer, and an issue where the endpoint sometimes deadlocked on receiving re-INVITE with a telephony event in SDP. (SEPSDK-1309, SEPSDK-1248)


Fixed an issue in configuration processing that sometimes applied the wrong setting value. This fixes the issue where the application incorrectly auto-answered a call when auto_answer=0. (SEPSDK-1265)


Top of Page


Release Number 8.5.200.40 [04/29/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

This release includes the following corrections and modifications:


SIP Endpoint SDK for .NET now correctly matches the telephone-event payload type in the answer SDP. Previously, SIP Endpoint SDK may have used a previously selected payload type instead of matching the one in the new offer SDP, which is allowed by standards but might cause problems with equipment not supporting asymmetric RTP payloads. (SEPSDK-1225)


SIP Endpoint SDK for .NET no longer logs misleading error messages when making a 3pcc MakeCall using REFER. Previously, SIP Endpoint SDK for .NET incorrectly printed Wrn send-failed(err=10049) for RTP and VoECodec:SetSendCodec error 8005 messages in this scenario. (SEPSDK-1193)


Audio statistics now include remote info when is is available from the RTCP received from the remote side. (SEPSDK-1190)


Top of Page


Release Number 8.5.200.31 [03/16/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release does not contain new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


Added the domain configuration setting to specify the domain used in outgoing SIP requests:

<domain name="proxies">
	<section name="proxy0">
		<setting name="domain" value=""/>
     

Valid Values: Any valid SIP domain

SIP domain is an application layer configuration defining the management domain of a SIP proxy. The configured value should include hostport and may include uri-parameters as defined by RFC 3261. The scheme, userinfo, and transport URI parameters are included automatically.

Default Value: Empty string

If set to an empty string, SIP Endpoint SDK for .NET uses the parameters from the Connectivity section to construct the SIP domain value as it did in previous versions.

(SEPNET-1180)


Codec handling now works correctly for a 3pcc MakeCall using REFER. (SEPNET-1177)


SIP Endpoint SDK for .NET now correctly closes RTP ports when the file descriptor grows larger than 16 bits. This case can happen in Windows 8.1 when the endpoint runs long enough to handle serveral thousand calls without restarting. (SEPNET-1176)


Top of Page


Release Number 8.5.200.27 [01/26/16] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release does not contain new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


IPv6 support now works as documented. In versions 8.5.200.10 to 8.5.200.26, enabling IPv6 support required that you set the GCTI_CONN_IPV6_ON environment variable equal to "1" if you wanted to enable IPv6 support. This step was not documented and not intended to be a requirement. (SEPNET-890)


Added new configuration setting policy.endpoint.sip_port_binding to control the SIP port binding policy. The default value of 0 opens the SIP port to listen on any interface. A value of 1 binds the SIP port to the interface specified by the public_address setting and the SIP port will only listen on the specified IP address. (SEPNET-889)


SIP Endpoint SDK for .NET now detects stuck audio when the application receives RTP packets but no audio frames play in the device. In this case, SIP Endpoint SDK for .NET restarts the playback thread if configured using the policy.session.restart_audio_if_stuck setting. (SEPNET-888)


This release fixes processing of the payload_type setting in codec configuration. Previous versions ignored all values except a value of 96. (SEPNET-881)


SIP Endpoint SDK for .NET now forces the use of a high-resolution timer on start-up using the timeBeginPeriod system function. The high-resolution timer ensures smooth audio playback in systems that do not enable this timer by default. (SEPNET-835)


Top of Page


Release Number 8.5.200.25 [10/28/15] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release does not contain new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


The new device event DeviceInitFailed reports failure of an audio device's initialization when starting audio stream. The event parameter dev_type_bitmask indicates which device failed. The device failure type may be DeviceTypeMicrophone, DeviceTypeSpeaker, or DeviceTypeHeadset when both microphone and speaker fail.

The application code should take corrective action (for example, select another audio device) and call the following method to indicate which device(s) were corrected restart the audio:

void RestartFailedAudio(GSDeviceType device_added);

You can also use this method to retry device initialization but the application must limit the number of retries to avoid infinite loops.

Note: It is safe to call this method on any device update. If the audio stream did not fail, then the method has no effect. (SEPNET-839)


Methods operating with Microphone/Speaker volume and mute status now return an error if the active device is not present. Previously, these methods might return success if webrtc_audio_layer was set to 2. In addition, this release improves handling of the Windows standard WM_DEVICECHANGE event. This avoids problems when a device list is not properly updated (or partially updated) and the event is sent before OS device table is fully updated. (SEPNET-838)


Top of Page


Release Number 8.5.200.22 [10/02/2015] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


REGISTER dialog deletion no longer causes reconnection failures. In version 8.5.200.17, reconnection failures could occur when a REGISTER dialog was deleted. (SEPNET-845)


Top of Page


Release Number 8.5.100.34 [07/16/2015] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


SIP Endpoint SDK for .NET now provides the DN in the Contact SIP header. Previously, the DN was not included for incoming SIP dialogs. This change resolves issues with applications that expect the DN in the header such as the Verint recording solution. (SEPNET-816)


Top of Page


Release Number 8.5.100.33 [04/08/2015] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


This release adds the reg_match_received_rport configuration setting. This setting controls whether or not SIP Endpoint SDK should re-register itself when receiving a mismatched IP address in the received parameter of a REGISTER response. This option helps resolve the case where SIP Endpoint SDK for .NET has multiple network interfaces and obtains the wrong local IP address. A value of 0 (default) disables this feature and a value of 1 enables re-registration.

<domain name="proxies">
  <section name="proxyN">
    <setting name="reg_match_received_rport" value="0 or 1"/>

Previously, this functionality was controlled by the ice_enabled option and re-registration was enabled when ICE was enabled. Now, the ICE setting does not affect re-registration. ICE and re-registration can now be configured separately. (SEPNET-763)


This release fixes an issue where SIP Endpoint SDK for .NET would not correctly show remote video when using the H.264 codec in a scenario where a call is routed to the endpoint after video treatment is applied. (SEPNET-761)


Top of Page


Release Number 8.5.200.17 [04/02/2015] – General

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

There are no corrections or modifications for this release.

Top of Page


Release Number 8.5.100.32 [12/17/2014] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

There are no corrections or modifications for this release.

Top of Page


Release Number 8.5.100.30 [11/20/2014] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

This release includes the following corrections and modifications:


When an active call is placed on hold, the inactivity watchdog will now stop monitoring the call. Previously, a held call would be disconnected if rtp_inactivity_timeout was set. (SEPNET-674)


A potential deadlock no longer occurs in SDK-based applications (e.g. Genesys Softphone) when several standalone connections are registered at the same time. In this case, no actual registration with SIP Server is performed. (SEPNET-667)


SRTP negotiation has been fixed for cases where an SDP offer uses Microsoft non-standard extension and adds a crypto attribute to the media stream with RTP/AVP transport. Now, SIP Endpoint SDK for .NET ignores the crypto attribute (conforming to RFC 4568). Previously, SIP Endpoint SDK for .NET incorrectly turned SRTP on without providing crypto keys in the answer SDP. (SEPNET-663)


When receiving NOTIFY with the hold or talk event from SIP Server before receiving ACK for previous re-INVITE transaction, SIP Endpoint SDK for .NET now stops sending 200 response retransmissions and assumes ACK is lost in transit. Previously, SIP Endpoint SDK for .NET continued sending responses to that transaction and could result in two SDP offer-answer exchanges interfering with each other. (SEPNET-662)


Top of Page


Release Number 8.5.100.25 [09/15/2014] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

There are no corrections or modifications for this release.

Top of Page


Release Number 8.5.100.24 [08/29/2014] – General

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of SIP Endpoint SDK for .NET.

Corrections and Modifications

This release also includes the following corrections and modifications:


The following information describes how the public_address setting works:

For cases not covered above, the user can explicitly specify an IP address or host name (fully qualified or not). However, this might not be suitable for automatic deployments. (SEPNET-585)


Top of Page


Release Number 8.5.000.18 [12/20/2013] – General

Supported Operating Systems
New in This Release
Corrections and Modifications

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in the initial 8.5 release of SIP Endpoint SDK for .NET.

Corrections and Modifications

This release includes the following corrections and modifications that were made between Release 8.1 or earlier releases and the initial 8.5 release:


A user data header is now present in the second INVITE message if authentication is enabled in the SIP Server. (SEPNET-397)


SIP Endpoint SDK now redirects audio paths properly to available devices for an existing session if the devices have been disconnected during the session. (SEPNET-201)


SIP Endpoint SDK now allows the user to stop the video portion of a call while the call is in progress. Previously, if a user attempted to stop the video, the SDK would ignore that request. (SEPNET-434)


SIP Endpoint SDK now correctly handles SIP NOTIFY requests to generate DTMF tones. Previously, the SDK would reject SIP NOTIFY requests to generate DTMF tones. (SEPNET-497)


Top of Page


Known Issues and Recommendations

This section provides the latest information on known issues and recommendations associated with this product.


Using Hold/Retrieve on a call established using the NAT traversal (ICE) feature may fail and result in the call being dropped in cases where the DN doing the operation is configured in CME with sip-hold-rfc3264=false. (SEPSDK-1429)

Found In: 8.5.200.58 Fixed In: 

An endpoint may hear audio from a second endpoint if the second endpoint was muted on the device level before the call was initiated. (SEPSDK-1261)

Found In: 8.5.200.40 Fixed In: 8.5.200.52

Complete Transfer does not work with the NAT traversal (ICE) feature when the option sip-replaces-mode is configured with a non-zero value (1 or 2) on a transferred party DN or on the application level. (SEPNET-754)

Found In: 8.5.200.17 Fixed In: 

If a TURN server is used for NAT traversal using UDP (setting turn_relay_type to 0) may fail. (SEPNET-753)

Workaround: The turn_relay_type setting should be set to 1.

Found In: 8.5.200.17 Fixed In: 

In a full video-enabled environment (that is, an environment in which video codecs are configured on all endpoints and on the conference unit), performing a single step transfer or adding a third participant to an audio-only call via single-step conferencing might open a blank video for the new party. (SEPNET-593, SEPNET-617)

Found In: 8.5.100.24 Fixed In: 

Limitation: Calls cannot be answered or canceled in the middle of a call interaction when one or more of the Genesys SIP Proxies are down, due to a limitation in Genesys SIP Proxy. (SEPNET-420)

Found In: 8.1.200.23 Fixed In: 

Limitation: To start an External Video Renderer window in the QuickStart application, the Endpoint should have at least one connection registered.

(Affects Release 8.1.2 and higher)

Found In: 8.1.200.20 Fixed In: 

Limitation: Using a very high video resolution (2000x1500 and above) with an external camera may result in significant performance degradation on some systems. Use lower settings if you are experiencing a very slow refresh rate or if your application is hanging up.

(Affects Release 8.1.2 and higher)

Found In: 8.1.200.14 Fixed In: 

Top of Page


Discontinued Support

This section documents features that are no longer supported in this software. This cumulative list is in release-number order with the most recently discontinued features at the top of the list. For more information on discontinued support for operating environments and databases, see "Discontinued Support" in the Genesys Supported Operating Environment Reference Guide.


Support for the following Microsoft operating systems has been discontinued:

Discontinued As Of: 8.5.000.18

.NET Framework versions earlier than version 4.0 are no longer supported.

Discontinued As Of: 8.5.000.18

Top of Page


Internationalization

Information in this section is included for international customers.


There are no internationalization issues for this product.


Top of Page


Additional Information

Additional information on Genesys Telecommunications Laboratories, Inc. is available on our Customer Care website. The following documentation also contains information about this software. Please consult the SIP Endpoint SDK for .NET 8.5 Deployment Guide first.

Product documentation is provided on the Customer Care website,and the Genesys Documentation website.

Top of Page