The 2017 R3 release of the Interaction Center supports the changes to the ICWS API described below.
This topic contains the following sections:
A new effectiveStation property was added to the connectionResponse data contract. This data contract is returned from the 201 HTTP status code response from a successful call to POST /icws/connection. Additionally, a new effectiveStationChangeMessage message was added for when a logged in user's effective station changes. The effectiveStation property and the effectiveStationChangeMessage message will only be returned if you specify effective-station as part of your include query for the POST /icws/connection call.
A new purecloudIntegration.webRTCIntegrationEnabled property was added to the connectionResponse data contract. This data contract is returned from the 201 HTTP status code response from a successful call to POST /icws/connection. The purecloudIntegration property will only be returned if you specify purecloud-integration as part of your include query for the POST /icws/connection call.
Support has been added to query the IC Server switchover status via GET /icws/{sessionId}/connection/switchover-status.
Subscription support has been added for the Login Authentication configuration object. Subscriptions can be managed via calls to DELETE /icws/{sessionId}/messaging/subscriptions/configuration/login-authentication/{subscriptionId} and PUT /icws/{sessionId}/messaging/subscriptions/configuration/login-authentication/{subscriptionId}
A new location property was added to the users data contract. This data contract is used for the following:
user representation for calls to POST /icws/{sessionId}/configuration/users and PUT /icws/{sessionId}/configuration/users/{id}.The Transaction service was added. This service provides consumers a way to suspend server-side rights calculations while making configuration requests. There are several objects that support transactions, and configuration requests that should be included in these transactions will need to specify the ININ-ICWS-Transaction-Id header with the associated transaction ID. Transactions are started with a call to POST /icws/{sessionId}/configuration/transaction, and stopped with a call to POST /icws/{sessionId}/configuration/transaction/{transactionId}/transaction-end. The following configuration operations can have the ININ-ICWS-Transaction-Idheader specified:
Support for retrieving subsystem certificates was added via GET /icws/{sessionId}/configuration/certificates/subsystem-certificates. Subsystem certificates can also be trusted with a call to PUT /icws/{sessionId}/configuration/certificates/trust-subsystem-certificate.
A new enableSnippetRecording property was added to the interactionRecorderConfiguration data contract. This property allows configuration of the ability to perform recording snippets. See /icws/{sessionId}/interactions/{interactionId}/record-snippet resource for more information on recording snippets.
New snipLineQueue, snipStationQueue, snipUserQueue, and snipWorkgroupQueue Access Control rights were added to support configuring of recording snippets. These access rights can be used while making configuration queries on the following objects via the rightsFilter for:
Support for adding, updating, and deleting Line Groups configuration objects has been added via POST /icws/{sessionId}/configuration/line-groups, PUT /icws/{sessionId}/configuration/line-groups/{id}, and DELETE /icws/{sessionId}/configuration/line-groups/{id}.
Support for adding, updating, and deleting Lines configuration objects has been added via POST /icws/{sessionId}/configuration/lines, PUT /icws/{sessionId}/configuration/lines/{id}, and DELETE /icws/{sessionId}/configuration/lines/{id}.
Support for adding Location configuration objects has been added via POST /icws/{sessionId}/configuration/locations.
Support for adding, updating, and deleting IC Data Sources configuration objects has been added via POST /icws/{sessionId}/configuration/ic-data-sources, PUT /icws/{sessionId}/configuration/ic-data-sources/{id}, and DELETE /icws/{sessionId}/configuration/ic-data-sources/{id}.
Support for the following new configuration objects has been added:
A new primaryNumberDesignation property was added to the directoryMessage data contract. The primaryNumberDesignation property represents the contact property that is determined to be the primary number. This data contract is received by watching for messages after a successful directory subscription is made via a call to PUT /icws/{sessionId}/messaging/subscriptions/directories/{subscriptionId}.
The editNumber property on the phoneNumber data contract has been marked obsolete, and a new numberInfo property has been added to the phoneNumber data contract. This new numberInfo property contains a parsed version of the editNumber value, and is broken up into baseNumber, extension, and autoDialable properties. This change affects a wide number of properties within the Directories service. An example of this change can be found on the contactEntry.homePhone property of the directoryMessage. The directoryMessage data contract can be watched for after a successful subscription call to PUT /icws/{sessionId}/messaging/subscriptions/directories/{subscriptionId} is made.
The queueID and target properties of the transferParameters and createConsultParameters data contracts have been changed to now be Conditionally Required. For these data contracts, either queueID or target should be specified. Specifying both at the same time will result in an error from the server. These properties are used for calls to POST /icws/{sessionId}/interactions/{interactionId}/consult, POST /icws/{sessionId}/interactions/{interactionId}/park, and POST /icws/{sessionId}/interactions/{interactionId}/transfer-to-voicemail.
Support has been added to invite party members to conferences via POST /icws/{sessionId}/interactions/conferences/{conferenceId}/invite-party.
Support has been added to invite other parties to a specified call interaction via POST /icws/{sessionId}/interactions/{interactionId}/invite-party.
Support for creating recording snippets has been added via POST /icws/{sessionId}/interactions/{interactionId}/record-snippet.
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.
| Feature | Version | Previously Released Version |
|---|---|---|
| activations | 1 | 1 |
| configuration | 11 (Updated) | 10 |
| connection | 11 (Updated) | 9 |
| dialer | 2 | 2 |
| directories | 8 (Updated) | 6 |
| interactions | 13 (Updated) | 12 |
| ipa | 1 | 1 |
| licenses | 2 | 2 |
| messaging | 3 | 3 |
| phone-numbers | 3 | 3 |
| queues | 1 | 1 |
| security | 2 | 2 |
| session | 1 | 1 |
| statistics | 4 | 4 |
| status | 2 | 2 |
| system | 2 | 2 |
| wfm | 4 | 4 |