Interaction Center Web Services (ICWS)

/icws/{sessionId}/messaging/subscriptions/interaction-alerting

Feature	Version	Obsolete Version
interactions	6

PUT

/icws/{sessionId}/messaging/subscriptions/interaction-alerting

Subscribes to Interaction Alerting notifications for the Interaction Center User associated with the active session, as identified by the sessionId parameter.

Feature	Version	Obsolete Version
interactions	6

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.

Representations

alertSubscriptionParameters

Expand All Collapse All

Property

Value

Comments

attributeNames

List [1,*]: String

The set of attribute names for this subscription.

Response

204 - No Content

The Interaction Alerting subscription for this Interaction Center User has been created.

Associated Message

The set of Interaction Alerting event details which are currently active for the Interaction Center User.

interactionAlertingMessage

Message representing identifying features of Interactions Alerting events being raised for a given User.

Expand All Collapse All

Property

Value

Comments

__type

"urn:inin.com:interactions:interactionAlertingMessage"

Required

The JSON type representing this option.

isDelta

Boolean

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.

alertingInteractionDetails

List [Unbounded]: Complex Type: interactionAlertDetails

Required

Property type documentation:

A collection of Interaction Alerting event details.

interactionId

String

Required

The unique identifier of the Interaction that is alerting.

interactionType

String

Required

The type of Interaction that is alerting. This will be valued with the 'objectType' Interaction attribute value.

name

String

Required

The name associated to the party that initiated the Interaction.

address

String

Required

The telephone number, telephone extension, email address, or other such origin of the Interaction.

alertType

Enumeration: interactionAlertTypes

Required

Indicates the type of Interaction Alerting event that is being raised.

None

User

Station

Workgroup

StationGroup

AcdUser

AcdStation

alertAction

Enumeration: interactionAlertActions

Required

Specifies whether the Alerting event is instructing the consumer to begin, or to end, alerting the end user.

None

StartAlerting

StopAlerting

autoAnswer

Boolean

Required

Indicates whether the alerting Interaction should be picked up automatically.

monitoredQueue

Complex Type: queueId

If valued, specifies from which monitored queue the Interaction is alerting.

Property type documentation:

A queueId containing the queue type and its name.

queueType

Enumeration: queueType

Required

The type of queue being identified.

system

A special Queue that represents interactions on a user's queue or station queue.

user

Represents a user's interactions.

workgroup

Represents a workgroup's interactions. Interactions passed to a Workgroup queue can be picked up by its member agents.

station

Represents a station's interactions.

queueName

String

Required

The name of the queue being identified.

attributes

Dictionary

A dictionary of attributes subscribed to, and a snapshot of their corresponding values at the time of this alert.

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.

403 - Forbidden

The API Consumer does not have sufficient permissions to subscribe to Interaction Alerting for the current Interaction Center User.

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.

DELETE

/icws/{sessionId}/messaging/subscriptions/interaction-alerting

Removes subscription to Interaction Alerting for the Interaction Center User associated with the active session, as identified by the sessionId parameter.

Feature	Version	Obsolete Version
interactions	6

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.

Response

204 - No Content

The subscription to Interaction Alerting for the current user has been deleted.

403 - Forbidden

The API Consumer does not have sufficient permissions to un-subscribe from Interaction Alerting for the current Interaction Center User.

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.

404 - Not Found

No Interaction Alerting subscription has yet been created for the current Interaction Center User.

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.