| Feature | Version | |
|---|---|---|
| interactions | 6 |
target or queueID property. Specifying or omitting both target and queueID will result in an error.| Feature | Version | |
|---|---|---|
| interactions | 6 |
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 interaction ID for the interaction resource.Conditionally Required
The target number or queue.Prior to version 13 when queueID was added, this property is required. Since version 13, if both target and queueID are specified or omitted, the server will return error.
Conditionally Required
The queue ID to transfer to.Prior to version 13 when queueID was added, the target property is required. Since version 13, if both target and queueID are specified or omitted, the server will return error.
| Feature | Version | |
|---|---|---|
| interactions | 13 |
Property 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.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.
| Feature | Version | |
|---|---|---|
| interactions | 10 |
Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.The consult was successfully created.
Required
A URL specifying where a representation of the consult transfer can be found.Required
An ID for the created consult transfer.Required
The interaction ID between the agent and the consult.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 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.Required
A message that describes the current error.Required
A message that describes the current error.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.