Interaction Center Web Services (ICWS)

/icws/{sessionId}/interactions/{interactionId}

GET

/icws/{sessionId}/interactions/{interactionId}

Gets a set of attributes from an interaction.

Feature	Version	Obsolete Version
interactions	1

Request

Parameters

Type

Name

Comments

Header

ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

Header

Required

The session cookie. With the exception of the connection request, all requests must provide a session cookie.

Template

sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

Template

interactionId

Required

The interaction ID for the interaction resource.

Query

select

A comma delimited, case insensitive list of attribute names to query on the interaction. If no fields are specified, then only the interaction ID is returned as the Eic_CallId attribute.

Example: select=Eic_RemoteName,Eic_State

These can be standard CIC attribute names or custom attribute names to support custom handlers / integrations.

Note

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.

Response

200 - OK

The interaction attributes were retrieved. Key strings are case insensitive.

interactionAttributes

Expand All Collapse All

Property

Value

Comments

attributes

Dictionary

Required

The set of attributes and their values on an interaction.

Property type documentation:

Represents a collection of key/value string pairs.

[key]

String

Required

The key identifying this pair.

[value]

String

Required

The value of this pair.

404 - Not Found

The interaction does not exist.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

403 - Forbidden

You do not have rights to the interaction.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

400 - Bad Request

The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

401 - Unauthorized

The specified session token is missing, invalid, or has expired.

Parameters

Type

Name

Comments

Header

WWW-Authenticate

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"

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

410 - Gone

This resource has been deprecated and removed from the API.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

500 - Internal Server Error

An unexpected error occurred while processing the request.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

POST

/icws/{sessionId}/interactions/{interactionId}

Updates the set of attributes on an interaction.

Feature	Version	Obsolete Version
interactions	1

Request

Parameters

Type

Name

Comments

Header

ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

Header

Required

The session cookie. With the exception of the connection request, all requests must provide a session cookie.

Template

sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

Template

interactionId

Required

The interaction ID for the interaction resource.

Representations

interactionAttributesUpdate

Expand All Collapse All

Property

Value

Comments

attributes

Dictionary

Required

The set of attributes to update on an interaction. These can be standard CIC attribute names or custom attribute names to support custom handlers / integrations.

Note

Property type documentation:

Represents a collection of key/value string pairs.

[key]

String

Required

The key identifying this pair.

[value]

String

Required

The value of this pair.

appendMode

Enumeration: appendMode

Used when attributes should append to existing values. By default attributes will replace existing values.

Feature	Version	Obsolete Version
interactions	9

Append

Appends the values to existing attribute values without a separator. This is equivalent to a simple concatenation with the existing value.

AppendWithSeperator

Appends the values to existing attribute values with the vertical bar character ( | ) as a separator between the existing value and the specified value.

Response

200 - OK

The attributes were successfully updated.

404 - Not Found

The interaction does not exist.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

403 - Forbidden

You do not have rights to the interaction.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

400 - Bad Request

The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

401 - Unauthorized

The specified session token is missing, invalid, or has expired.

Parameters

Type

Name

Comments

Header

WWW-Authenticate

Required


								WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

410 - Gone

This resource has been deprecated and removed from the API.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

500 - Internal Server Error

An unexpected error occurred while processing the request.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.