Avaya Client SDK
Release 4.12
Release Notes
Issue 1.0
8 January 2021
© 2021 Avaya Inc. All Rights Reserved.
Avaya Client SDK 4.12 Release Notes
Notice (e.g., webmaster or helpdesk), an e-mail or voice mail account in
While reasonable efforts were made to ensure that the the name of a person or corporate function, or a directory entry in
information in this document was complete and accurate at the the administrative database utilized by the Product that permits
time of printing, Avaya Inc. can assume no liability for any errors. one user to interface with the Product.
Changes and corrections to the information in this document Shrinkwrap License (SR). With respect to Software that contains
might be incorporated in future releases. elements provided by third party suppliers, End User may install
and use the Software in accordance with the terms and conditions
Documentation disclaimer of the applicable license agreements, such as "shrinkwrap" or
Avaya Inc. is not responsible for any modifications, additions, or "clickwrap" license accompanying or applicable to the Software
deletions to the original published version of this documentation ("Shrinkwrap License"). The text of the Shrinkwrap License will be
unless such modifications, additions, or deletions were performed available from Avaya upon End User’s request (see “Third-party
by Avaya. Customer and/or End User agree to indemnify and hold Components" for more information).
harmless Avaya, Avaya's gents, servants and employees against all
claims, lawsuits, demands and judgments arising out of, or in Copyright
connection with, subsequent modifications, additions or deletions Except where expressly stated otherwise, the Product is protected
to this documentation to the extent made by the Customer or End by copyright and other laws respecting proprietary rights.
User. Unauthorized reproduction, transfer, and or use can be a criminal,
as well as a civil, offense under the applicable law.
Link disclaimer
Avaya Inc. is not responsible for the contents or reliability of any Third-party components
linked Web sites referenced elsewhere within this Certain software programs or portions thereof included in the
documentation, and Avaya does not necessarily endorse the Product may contain software distributed under third party
products, services, or information described or offered within agreements ("Third Party Components"), which may contain
them. We cannot guarantee that these links will work all the time terms that expand or limit rights to use certain portions of the
and we have no control over the availability of the linked pages. Product ("Third Party Terms"). Information identifying Third Party
Components and the Third Party Terms that apply to them is
Warranty available on the Avaya Support Web site:
Avaya Inc. provides a limited warranty on this product. Refer to http://support.avaya.com/ThirdPartyLicense/
your sales agreement to establish the terms of the limited
warranty. In addition, Avaya’s standard warranty language, as well Preventing toll fraud
as information regarding support for this product, while under "Toll fraud" is the unauthorized use of your telecommunications
warranty, is available through the Avaya Support Website: system by an unauthorized party (for example, a person who is
http://www.avaya.com/support not a corporate employee, agent, subcontractor, or is not working
on your company's behalf). Be aware that there can be a risk of
License toll fraud associated with your system and that, if toll fraud
USE OR INSTALLATION OF THE PRODUCT INDICATES THE END occurs, it can result in substantial additional charges for your
USER'S ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND THE telecommunications services.
GENERAL LICENSE TERMS AVAILABLE ON THE AVAYA WEB SITE
http://support.avaya.com/LicenseInfo/ ("GENERAL Avaya fraud intervention
LICENSE TERMS"). IF YOU DO NOT WISH TO BE BOUND BY THESE If you suspect that you are being victimized by toll fraud and you
TERMS, YOU MUST RETURN THE PRODUCT(S) TO THE POINT OF need technical assistance or support, call Technical Service Center
PURCHASE WITHIN TEN (10) DAYS OF DELIVERY FOR A REFUND Toll Fraud Intervention Hotline at +1-800-643-2353 for the United
OR CREDIT. Avaya grants End User a license within the scope of States and Canada. For additional support telephone numbers,
the license types described below. The applicable number of see the Avaya Support Web site:
licenses and units of capacity for which the license is granted will http://www.avaya.com/support
be one (1), unless a different number of licenses or units of
capacity is specified in the Documentation or other materials Trademarks
available to End User. "Designated Processor" means a single Avaya, the Avaya logo, and COMPAS are either registered
stand-alone computing device. "Server" means a Designated trademarks or trademarks of Avaya Inc. in the United States of
Processor that hosts a software application to be accessed by America and/or other jurisdictions. All other trademarks are the
multiple users. "Software" means the computer programs in property of their respective owners.
object code, originally licensed by Avaya and ultimately utilized by
End User, whether as stand-alone Products or pre-installed on Downloading documents
Hardware. "Hardware" means the standard hardware Products, For the most current versions of documentation, see the Avaya
originally sold by Avaya and ultimately utilized by End User. Support Web site:
http://www.avaya.com/support
License type(s)
Named User License (NU). Customer may: (i) install and use the Avaya support
Software on a single Designated Processor or Server per Avaya provides a telephone number for you to use to report
authorized Named User (defined below); or (ii) install and use the problems or to ask questions about your product. The support
Software on a Server so long as only authorized Named Users telephone number is 1-800-242-2121 in the United States. For
access and use the Software. "Named User," means a user or additional support telephone numbers, see the Avaya Support
device that has been expressly authorized by Avaya to access and Web site:
use the Software. At Avaya's sole discretion, a "Named User" may
be, without limitation, designated by name, corporate function http://www.avaya.com/support
Avaya Client SDK 4.12 Release Notes
Table of Contents
Introduction................................................................................................................................................... 4
Installation..................................................................................................................................................... 4
Product compatibility ............................................................................................................................... 4
Required patches ...................................................................................................................................... 4
SDK Packages ............................................................................................................................................. 4
What's new.................................................................................................................................................... 5
Release 4.12 .............................................................................................................................................. 5
Communication Services Package ........................................................................................................ 5
Fixes ............................................................................................................................................................... 7
Communication Services Package ........................................................................................................ 7
Known issues and workarounds ................................................................................................................... 9
Communication Services Package ........................................................................................................ 9
Documentation errata ................................................................................................................................10
Contacting support......................................................................................................................................11
Contact Support Checklist.......................................................................................................................11
Contact Support Tasks ............................................................................................................................11
Appendix B: Acronyms ................................................................................................................................12
Release Notes 3
Avaya Client SDK 4.12 Release Notes
Introduction
This document provides late-breaking information to supplement the Avaya Client SDK software and
documentation. For updated documentation, go to –
http://www.devconnectprogram.com/site/global/products_resources/avaya_client_sdk/overview/inde
x.gsp.
Installation
Product compatibility
For the latest and most accurate compatibility information go to –
https://support.avaya.com/CompatibilityMatrix/Index.aspx.
This lists compatibility information by Avaya Client SDK Package.
Required patches
Find interoperability and compatibility information at the following location: https://support.avaya.com.
SDK Packages
Documentation
API Modified
Package Updated Version Number
< Yes / No >
< Yes / No >
Communication Services - Native
Yes No 4.12 – 365.0.30
(iOS, Android, MacOS, Windows)
Communication Services - JavaScript Yes Yes 4.6 – 4.6.0.69
Desk Phone Services Yes No 4.12 – 365.0.30
Meeting Management Services No No 3.7.0.1-20190812.123037-1
Recording Management Services No No 4.3.7.1-20190812.122723-1
Customer Interaction Services Yes Yes 3.8.0-1.17.66
Customer Interaction Utilities N0 No 3.8.0.0
Data Store Services Yes Yes 3.8.0.1
Sharing Services N0 No 3.8.0.0.1010036
Release Notes 4
Avaya Client SDK 4.12 Release Notes
What's new
The following table lists the new functionality in the 4.12 release. For additional details of the content of
the Client SDK Packages see the Avaya Client Offer Definition document.
For further details see the API Reference Specification on the Avaya Client SDK Developer Hub at
http://www.devconnectprogram.com/site/global/products_resources/avaya_client_sdk/overview/inde
x.gsp.
Release 4.12
Communication Services Package
Android, iOS, MacOS and Windows Client SDK
Feature Description New /
Enhanced /
Deprecated
ClientSDK delivered a change to expose the Avaya Global Session
Avaya Attendant
ID (GSID) to attendant application via ExtraProperties as a custom Enhancement
enhancements
header.
OAuth/SAML login flow
OAuth/SAML login flow with Avaya Meeting Server 9.1.11 New
enhancement
Avaya Aura® Session Manager has implemented this interface
Session Manager toward APNs and send telephony push notification to the clients,
support for Apple Push New
eliminating the need for Avaya Aura® Web Gateway in the
Notification service
architecture
Export Messaging
functionality to export P2P or multiparty conversations in a HTML
Conversation and
file. Rich text shall be exported where available, and plain text New
conference chat to
otherwise.
HTML
Release Notes 5
Avaya Client SDK 4.12 Release Notes
JavaScript Client SDK
Feature Description New /
Enhanced /
Deprecated
Effective bandwidth If the WebRTC call is connected through TURN TCP, then the
into the calculation for packet lost can't reflect the network condition. So effective
Enhancement
the link quality bandwidth into the calculation for the link quality indicator was
indicator. added.
With the increasing usage of Spaces and Workplace Meetings
there have been a number of reports of poor performance on very
Improve handling of
low spec hardware.
hardware with very low Enhancement
specifications
This feature will help to enable usage of the JSCSDK by reducing
video quality based on performance feedback.
Release Notes 6
Avaya Client SDK 4.12 Release Notes
Fixes
The following sections are cumulative since the last major or minor release showing the most recent
release first and oldest release last.
Communication Services Package
Android, iOS, MacOS and Windows Client SDK
ID Summary Found in Fixed in
Release Release
Crash in ClientSDK when user tries to send DTMF on
CLIENTSDK-27745 4.12 4.12
External App API
CLIENTSDK-27758 External App API errors when Jabra headset 4.12 4.12
CLIENTSDK-27909 No MSS video on Chrome from 3.12 iOS client 4.10 4.12
Conference Service cannot be reached" shown for P2P
CLIENTSDK-27953 4.10 4.12
call if called party is Busy
Video blurry for call between CSDK and One-X Agent +
CLIENTSDK-27346 4.5 4.12
Media Client
CLIENTSDK-27987 Workplace crashing when sending message in Spaces 3.12 4.12
CLIENTSDK-27977 Getting error for class CSUserCredential in iOS CSDK Lite 4.12 4.11
Workplace 3.12 Windows client not able to send Audio,
CLIENTSDK-27761 4.11 4.11
but works with 3.7 version
CLIENTSDK-27775 Black sharing when adding Extended Display 4.11 4.11
Lip sync issues experienced during a conference with
CLIENTSDK-27927 4.9.1 4.11
1080p video
Choppy audio when using Workplace for Windows and
CLIENTSDK-27718 4.7 4.11
Bluetooth headset.
Workplace can't be started after installation on Samsung
CLIENTSDK-27697 4.7 4.11
Galaxy A5
Workplace for Windows fails to disconnect the call after
CLIENTSDK-27665 4.9 4.10
480 Temporarily Unavailable
Workplace for Windows fails to disconnect the call after
CLIENTSDK-27665 4.9 4.10
480 Temporarily Unavailable
Cannot dismiss Alerting in case of APN call and SIP failed
CLIENTSDK-27511 4.6 4.10
with 403 Forbidden
Call keeps ringing continuously in case of Bridged Call
CLIENTSDK-27620 4.5 4.10
appearances
DTMF payload does not set to 101 if Workplace is
CLIENTSDK-27600 4.8 4.10
configured for Other Phone mode
CLIENTSDK-27423 Crashes related to Background task handling 4.6 4.10
Release Notes 7
Avaya Client SDK 4.12 Release Notes
JavaScript Client SDK
ID Summary Found in Fixed in
Release Release
Failed to start a conf when user is blocked camera by browser
JSCSDK-5695 4.6 4.6
or without camera
JavaScript Client SDK Conference.pinVideoByParticipant() API
JSCSDK-5547 4.6 4.6
documentation is incorrect
JavaScript Client SDK Firefox Beta v76 has no remote video
JSCSDK-5668 4.6 4.6
after unhold then escalate to video call
New joined user doesn't see sharing of user who is unpausing
JSCSDK-5708 4.6 4.6
sharing
Firefox without open h.264 plugin renegotiation drops video m
JSCSDK-5705 4.6 4.6
line
Screen sharing with comet sometimes results in errors on the
JSCSDK-5714 4.6 4.6
WCS and potential image corruption
Intermittent issue - It takes remote user over 30 seconds to
JSCSDK-5830 see sharing of presenter while WCS websocket is being 4.6 4.6
disabled
Missing NotReadableError getUserMedia error during startup
JSCSDK-5827 4.6 4.6
causing microphone not found error
The call is auto ended after user tries to escalate to video
JSCSDK-5779 4.6 4.6
while camera is blocking in Security&Privacy on macOS
Receive collaboration has high CPU usage on some low end
JSCSDK-5874 4.6 4.6
platforms
JSCSDK-5844 JavaScript Client SDK is sensitive to slow pings from WCS 4.6 4.6
Keep alive request to AAWG/WebUa missing bearer token
JSCSDK-5907 4.6 4.6
resulting in pop-up
MPaaS&Econf - Participant doesn't see the application sharing
JSCSDK-5882 4.6 4.6
which is resumed then restored by presenter
JSCSDK-5991 Presence service does not get initialized fully 4.6 4.6
Conf. 9.1.11 - Public URL branch of distributed UCCS doesn't
JSCSDK-6246 4.6 4.6
work
Collaboration - Firefox - Whiteboard improperly displays after
JSCSDK-5833 user adds a new whiteboard then moves forward whiteboard 4.6 4.6
using maker tool while WCS websocket is being disabled
Comet interface - Remote user doesn't see sharing of
JSCSDK-6056 4.6 4.6
presenter under Comet
Release Notes 8
Avaya Client SDK 4.12 Release Notes
Comet interface - Whiteboard drawings display improperly
JSCSDK-5864 when user moves drawings while WCS websocket is being 4.6 4.6
disabled
JSCSDK API documentation is incorrect -
JSCSDK-5716 4.6 4.6
addOnEventConferenceStatusChangedCallback
User.stop remove redundant DEACTIVE call and presence
JSCSDK-5923 4.5 4.6
services
Equinox Conferencing 9.1.9 GA – Micro is not muted for first
JSCSDK-5878 4.5 4.6
second when SWC client joins meeting with muted mic
Presence auto presence documentation and debug log
JSCSDK-5563 4.5 4.6
deficiencies
After escalation call user has no remote video
JSCSDK-4101 4.2 4.6
Fixed in the following System Manager releases: 7.1.3.3,
8.0.1.0, and 8.1.0.0.
Sample app - There is no option to Moderator accept or deny
JSCSDK-3872 1.5 4.6
a user join locked conf
JSCSDK-5762 Cyrillic search query to AADS fails on IE 11 1.0 4.6
Web access in Firefox and Chrome has significant memory
JSCSDK-5849 leaks or another reason to increment memory usage with 1.0 4.6
speed of about 600Mb/hour.
Known issues and workarounds
The following sections are cumulative since the last major or minor release showing the most recent
release first and oldest release last.
Communication Services Package
Android, iOS, MacOS and Windows Client SDK
ID Summary Found in
Release
CLIENTSDK-27457 Drop last participant option is not available in no hold conference. 4.10
When Callee Agent logout and someone calls this agent, caller hears
CLIENTSDK-27281 4.6
remote alerting though call is failed.
When Customer Service Agent answer Incoming Agent Calls (ACD or
CLIENTSDK-27164 DAC) which is notified through Push Notifications, Agent do not show 4.6
'On A Call' state.
Release Notes 9
Avaya Client SDK 4.12 Release Notes
If HTTP_PROXY_CSDK_ENABLE = 1 or 2 in settings file, then VPN
CLIENTSDK-27100 4.5.4
gateways need to be configured same as zang.io.
One-way video after hold and unhold if AAWG uses Best Effort SRTP
CLIENTSDK-26661 policy. This issue is fixed with Equinox Conferencing 9.1.10 (AMS build 4.4
8.0.2.102 or later).
Call drops after hold when user is connected over SM and while on a
CLIENTSDK-25800 4.3
call moves from dual stack IPv6 network IPV4 only network.
JavaScript Client SDK
ID Summary Found in
Release
WCS on Spaces - presenter presents flashing screen until change on
screen.
JSCSDK-6083 4.6
Workaround is to move content on screen after sharing starts
When searching for messages a 500 Server Internal Error can occur.
JSCSDK-5676 4.6
Workaround: Do not set a query after date when performing the
search.
When using pen and brush tools to draw perfectly straight lines, the
JSCSDK-6232 lines may not be sent to other user’s white boards 4.6
Workaround is to use the line tool to draw perfectly straight lines
Sometimes moderator can't see user's video when meeting have
started.
Because we receive incorrect event from message. it's reproduced so
JSCSDK-3994 4.2
intermittently.
Workaround: Connect to meeting not at the same time.
Part of the screen doesn't get captured when sharing entire screen on
JSCSDK-6227 Firefox 1.0
Workaround is to use the Chrome browser
Documentation errata
No outstanding documentation issues.
Release Notes 10
Avaya Client SDK 4.12 Release Notes
Contacting support
Contact Support Checklist
If you are having trouble with Client SDK, you should:
1. Set log level to debug.
2. Retry the action. Carefully follow the instructions in written or online documentation.
3. Check the documentation that came with your hardware for maintenance or hardware-related
problems.
4. Note the sequence of events that led to the problem and the exact messages displayed. Have
the Avaya documentation available.
If you continue to have a problem, contact Avaya Technical Support:
1. Log in to the Avaya Technical Support Web site https://support.avaya.com/.
2. Contact Avaya Technical Support at one of the telephone numbers in the Support Directory
listings on the Avaya support Web site.
Avaya Global Services Escalation Management provides the means to escalate urgent service issues. For
more information, see the Escalation Contacts listings on the Avaya Web site.
Contact Support Tasks
You may be asked to email one or more files to Technical Support for analysis of your application and its
environment.
Release Notes 11
Avaya Client SDK 4.12 Release Notes
Appendix B: Acronyms
3PCC Third Person Call Control
AADS Avaya Aura® Device Services
AAWG Avaya Aura® Web Gateway
AEMO Avaya Equinox® Meetings Online
AMM Avaya Multimedia Messaging
API Application Program Interface
APNS Apple Push Notification Service
ASBCE Avaya Session Border Controller for Enterprise
BFCP Binary Floor Control Protocol
BLA Bridged Line Appearance
CM Avaya Aura® Communication Manager
CPU Central Processing Unit
CTI Computer Telephony Integration
DNC Distributive Numerical Control
EC500 Extend to Cellular
FP Feature Pack
GA Generally Available
GME Google Media Engine
HTTP Hyper Text Transfer Protocol
HTTP UA Hyper Text Transfer Protocol User Agent
IdP Identity Provider
IPv6 Internet Protocol version 6
LDAP Lightweight Directory Access Protocol
MDA Multiple Device Access
MSS Multi-Stream Switching
OAUTH Open Authorization
OTT Over The Top
PLC Packet Loss Concealment
POM Presentation Only Mode
PS Avaya Aura® Presence Services
SAML Security Assertion Mark-up Language
SBC Session Border Control
SDK Software Development Kit
SIP Session Initiation Protocol
SM Avaya Aura® Session Manager
SMGR Avaya Aura® System Manager
SP Service Pack
SRTP Secure Real-Time Transport Protocol
SSO Single Sign-On
TLS Transport Layer Security
UC Unified Communication
URI Uniform Resource Identifier
USB Universal Serial Bus
VDI Virtual Desktop Infrastructure
Release Notes 12
