The 2016 R2 release of the Interaction Center supports the changes to the ICWS API described below.
This topic contains the following sections:
A new emailDownloadHTMLPictures property was added to the configuration.people:clientConfiguration data contract. The following APIs are impacts by this new property:
GET and PUT operations of the /icws/{sessionId}/configuration/users/{id} resourceGET and POST operations of the /icws/{sessionId}/configuration/users resource.Additionally, the emailDownloadHTMLPictures property has been added to the the configuration.people:usersMessage message, impacting the following added and changed properties of the 200 HTTP status code responses:
A new PUT /icws/{sessionId}/configuration/users/{id}/client method has been added to support updating the client configuration properties for the logged-in-user if they have the securityRights.customizeClient security right.
A new configurationId property was added to the configuration.people:scheduleRecurrences data contract to better support schedule recurrences. The following APIs are impacted by this new property:
GET and PUT operations of the /icws/{sessionId}/configuration/schedules/{id} resourceGET and POST operations of the /icws/{sessionId}/configuration/schedules resource.Additionally, the configurationId property has been added to the the configuration.people:schedulesMessage message, impacting the following added and changed properties of the 200 HTTP status code responses:
The Connection service has been extended with a new /icws/connection/single-sign-on/saml-ecp/{identityProviderId} resource to support identity providers that use the SAML SOAP binding.
A new editNumber property has been added to the directories:phoneNumber data contract. This affects various properties on the 200 HTTP status code of POST /icws/{sessionId}/directories/lookup-entries. This includes the lookupEntriesList.businessPhone, lookupEntriesList.businessPhone2, lookupEntriesList.homePhone, lookupEntriesList.homePhone2, lookupEntriesList.mobilePhone, and phoneNumber properties.
The Interactions service has been extended to support agent assistance requests:
A new appendMode property was added to the interactions:interactionAttributesUpdate data contract to support specifying how interaction attribute updates are applied. Omitting a value for this property will overwrite an interaction attribute value. This is the default behavior. Specifying a value of 1 will append the value to the current interaction attribute value, while specifying a value of 2 will first append a "|" separator, and then the value to the current interaction attribute value. This impacts the POST /icws/{sessionId}/interactions/{interactionId} method.
A small breaking change was introduced in the JavaScript Language-specific Library to improve the performance and memory utilization of data contracts at runtime. Previously, properties were declared on each data contract instance at construction time. Starting in 2016 R2, properties are declared on the prototype of each data contract constructor. As such, the properties are no longer enumerable by Object.keys nor will Object.prototype.hasOwnProperty return true against a data contract instance. Third-party libraries that depend on those functions such as _.has from Underscore.js will silently fail.
In order determine which properties a data contract instance has, DataContract.prototype.keys has been added. In order to clone a data contract, DataContract.prototype.clone has been added.
This release of the Interaction Center supports the following ICWS feature versions. See Versioning for more information about ICWS versioning, including how documentation of an API includes its required feature version and how to query the Interaction Center at run time to determine what feature versions it supports.
Only the features listed below are supported by this release of the Interaction Center. Any other feature required by later versions of ICWS is not supported. Similarly, for the listed features, this release of the Interaction Center only supports the listed version of that feature, not any higher version.