If the entire contents of an Interaction Queue is to be watched, Queue watches are more efficient than having individual Interaction watches on each Interaction in the Queue.
Feature | Version | |
---|---|---|
queues | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The ID for this subscription. This can be used to correlate future events and operations.Required
The set of queues to include in the subscription. You will have to query the respective configuration objects for determining which queues you have view rights to for the names.List item type documentation:
A queueId containing the queue type and its name.
Required
The type of queue being identified.Required
The name of the queue being identified.Required
The set of attribute names for this subscription. These can be standard CIC attribute names or custom attribute names to support custom handlers / integrations.For information about the standard attributes defined by the Interaction Center System, see the "Interaction Attributes Technical Reference"
in the Interaction Center Documentation Library. This document describes the attributes and the format of their values.
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 subscription ID that this message correlates to.List item type documentation:
An interaction containing the interaction ID and its interaction attribute values. In addition it contains a possible conference parent interaction ID.
Required
The interaction ID of the interaction.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.List item type documentation:
An interaction containing the interaction ID and its interaction attribute values.
Required
The interaction ID of the interaction.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.The interaction was replaced by another (e.g. during a consult transfer). This message will only be generated for the session creating a consult transfer or other sessions that are subscribed to queues that contain the associated interactions.
The isDelta
property will always be false
for these messages.
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 interaction's ID.Required
The new interaction ID after the morph.Feature | Version | |
---|---|---|
queues | 2 |
Feature | Version | |
---|---|---|
queues | 2 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
Required
A message that describes the current error.Required
The subscription ID that this message correlates to.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.Feature | Version | |
---|---|---|
queues | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The ID for this subscription. This can be used to correlate future events and operations.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.