Feature | Version | |
---|---|---|
connection | 1 |
Required
The Accept-Language
parameter is used by the server to determine the primary language of the client.
This header determines the language for any human-readable text, as well as formats for time, dates, and money.
The client must create a new connection with a different value of Accept-Language
to change the primary language.
A comma-delimited list of additional fields to include in the response. Options are:
version
features
server-time
- Added in version 4.default-workstation
- Added in version 5.purecloud-integration
- Added in version 8.effective-station
- Added in version 10.Feature | Version | |
---|---|---|
connection | 3 |
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.Required
Used by the Interaction Center and Interaction Center applications to display an association between an Interaction Center session and an application. It is part of the information that is exposed by thesessionInformation
message of the Session API.
The PureConnect MarketPlace application's license name. Only for use in MarketPlace applications.
When setting this, the marketPlaceApplicationCode
property should also be set.
This value can be obtained from the MarketPlace application's registration information.
The PureConnect MarketPlace application code. Only for use in MarketPlace applications.
When setting this, the marketPlaceApplicationLicenseName
property should also be set.
This value can be obtained from the MarketPlace application's registration information.
Required
This seed will be used in the generation of the auth token. It should be generated by the caller. The seed is encoded as a part of the returned auth token.
Required
The auth token is used to create a new session. This can be aquired from POST /icws/{sessionId}/connection/unique-auth-token.
Required
The Session ID of the session that was used to generate the auth token.
Feature | Version | |
---|---|---|
connection | 3 |
Required
The JSON type representing this option.Required
Used by the Interaction Center and Interaction Center applications to display an association between an Interaction Center session and an application. It is part of the information that is exposed by thesessionInformation
message of the Session API.
The PureConnect MarketPlace application's license name. Only for use in MarketPlace applications.
When setting this, the marketPlaceApplicationCode
property should also be set.
This value can be obtained from the MarketPlace application's registration information.
The PureConnect MarketPlace application code. Only for use in MarketPlace applications.
When setting this, the marketPlaceApplicationLicenseName
property should also be set.
This value can be obtained from the MarketPlace application's registration information.
Required
The Interaction Center user ID to log in with.
Required
The Interaction Center password for the supplied user ID.
Feature | Version | |
---|---|---|
connection | 3 |
Required
The JSON type representing this option.Required
Used by the Interaction Center and Interaction Center applications to display an association between an Interaction Center session and an application. It is part of the information that is exposed by thesessionInformation
message of the Session API.
The PureConnect MarketPlace application's license name. Only for use in MarketPlace applications.
When setting this, the marketPlaceApplicationCode
property should also be set.
This value can be obtained from the MarketPlace application's registration information.
The PureConnect MarketPlace application code. Only for use in MarketPlace applications.
When setting this, the marketPlaceApplicationLicenseName
property should also be set.
This value can be obtained from the MarketPlace application's registration information.
Required
A connection has been successfully created. The URL to get the resource is specified in the Location
header.
Required
The ININ session token necessary for all calls that require a security or user context.Required
The ININ session ID necessary for all calls that require a security or user context.Required
A URL specifying where a representation of the connection can be found.Required
The session cookie. This cookie is consumed by browsers automatically. Non-browser client applications may need to manually extract this cookie and pass it as the header parameter Cookie
in subsequent calls.
Required
The CSRF Token is an ININ session token for the session that was just established. All authenticated calls must include the CSRF Token in the ININ-ICWS-CSRF-Token request header.
Required
The Session ID is an ININ session identifier for the session that was just established. All authenticated calls for this session must include the Session ID in the URI.
A list of hosts that can be used for switchovers and/or load balancing. See Connecting to a Switchover Pair or Off-Server Session Managers for more information on how to handle this list.
Property type documentation:
An ordered list of alternate hosts to try to connect to. See Connecting to a Switchover Pair or Off-Server Session Managers for more information on how to handle this list.
The Interaction Center user ID that was logged in.
The display name of the user that was logged in.
The name of the IC Server for this session.
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 3 |
Represents the version information for the connected server. This information is the same as provided by GET /icws/connection/version but is provided here for convenience.
This property will only be included if version
is specified in the include
query string parameter.
Feature | Version | |
---|---|---|
connection | 3 |
Required
The product's two-digit release year. For the release"CIC 2015 R1"
this value will be "15"
.Required
The product's release number. For the release"CIC 2015 R1"
this value will be "1"
.Required
The patch number of the release. The value"0"
indicates the release without any patches.
For the release "CIC 2015 R1"
this value will be "0"
,
and for the release "CIC 2015 R1 Patch2"
this value will be "2"
.Required
The build number.Required
The product line identifier.Required
The codebase identifier.Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Represents the version of all features supported by the connected server. This information is the same as provided by GET /icws/connection/features but is provided here for convenience.
This property will only be included if features
is specified in the include
query string parameter.
Feature | Version | |
---|---|---|
connection | 3 |
Required
An identifier specifying a feature of the service.
Required
A positive integer value for representing the version of a feature.
Represents the UTC time information for the connected IC server.
This property will only be included if server-time
is specified in the include
query string parameter.
Feature | Version | |
---|---|---|
connection | 4 |
Required
The IC server's UTC time.Represents the identifier for the default workstation assigned to the connected user. This string is as the same as the defaultWorkstation.id
property provided by GET /icws/{sessionId}/configuration/users/{id} but is provided here for convenience.
If this value is null
, the user does not have an assigned default workstation.
This property will only be included if default-workstation
is specified in the include
query string parameter.
Feature | Version | |
---|---|---|
connection | 5 |
This property can be null.
Respresents the effective station for the connected user. EffectiveStation is the information about the station that the user is logged into using another application.
If this value is null
, the user does not logged into a station anywhere and will be updated after the session user logs into a station.
This property will only be included if effective-station
is specified in the include
query string parameter.
Feature | Version | |
---|---|---|
connection | 10 |
This property can be null.
Required
The ID of the station for the session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The unique identifier used to reference this configuration object.This property can be null.
Represents the PureCloud integration configuration for the connected IC server.
This property will only be included if purecloud-integration
is specified in the include
query string parameter.
Feature | Version | |
---|---|---|
connection | 8 |
Required
Indicates whether PureCloud integration is enabled.Feature | Version | |
---|---|---|
connection | 11 |
Required
The JSON type representing this option.Required
When true
, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false
, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false
to indicate the cache should be initialized with the data provided.
Required
The state of the connection before the change.Required
The state of the connection after the connection change.Required
A description of the condition that caused the change in connection state.newConnectionState
is set to down
, an unspecified value should be
assumed to be false
.
Feature | Version | |
---|---|---|
connection | 3 |
This message will be sent to the stationless application, if the user is logged in to a station using another application or logs out from the station. This message is returned only if the effective-station was requested on the connection request.
Feature | Version | |
---|---|---|
connection | 10 |
Required
The JSON type representing this option.Required
When true
, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false
, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false
to indicate the cache should be initialized with the data provided.
Required
New effective station information.This property can be null.
Required
The ID of the station for the session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The unique identifier used to reference this configuration object.This property can be null.
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 3 |
Feature | Version | |
---|---|---|
connection | 9 |
Required
A message that describes the current error.Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 2 |
Feature | Version | |
---|---|---|
connection | 5 |
Required
Property type documentation:
An ordered list of alternate hosts to try to connect to. See Connecting to a Switchover Pair or Off-Server Session Managers for more information on how to handle this list.
Required
A message that describes the current error.Required
A message that describes the current error.