Interaction Center Web Services (ICWS)

/icws/{sessionId}/connection/station

DELETE

/icws/{sessionId}/connection/station

Removes a station connection representation from the server. This has the effect of disconnecting the user from the station he is currently logged into.

Feature	Version	Obsolete Version
connection	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.

Response

200 - OK

The request to disconnect was successful. Any station for the session is now disconnected.

500 - Internal Server Error

The server was not able to disconnect the station connection. Details are included in the error representation.

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.

PUT

/icws/{sessionId}/connection/station

Creates, changes, or replaces a station connection representation. If a station connection already exists, it will be updated using the provided station settings. If there is no existing station connection for the session, one will be created using the station settings.

In the case that the I3_CLIENT_ACCESS license could not be obtained (either on the connected user or specified station) and the stationSettings used are not stationlessSettings, the server disconnects the session.

In order to receive ACD routed interactions, stationSettings.supportedMediaTypes must be set with at least 1 valid media type, and stationSettings.readyForInteractions must also be set to true.

Feature	Version	Obsolete Version
connection	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.

Representations

stationSettings

Expand All Collapse All

Property

Value

Comments

Multiple options:

The value can be assigned any of the following options.

[option]

Complex Type: remoteNumberSettings

__type

"urn:inin.com:connection:remoteNumberSettings"

Required

The JSON type representing this option.

supportedMediaTypes

List [1,*]: Enumeration: supportedMediaType

Specifies constants indicating what media types are supported for ACD routing on a station. The requested media types and the used media types may differ based off of licensing.

none

call

chat

generic

callback

smsMessage

workItem

directMessage

Feature	Version	Obsolete Version
connection	13

socialConversation

Feature	Version	Obsolete Version
connection	13

stationConnectionMode

Enumeration: stationConnectionMode

Used to change the station login and logout behavior with respect to the session manager session. By default the value is the 'default' value.

default

independentofSession

independentConnectionsLogoutWithSession

readyForInteractions

Boolean

After establishing a connection, the client must set this flag to true, as well as provide at least 1 valid option for supportedMediaTypes before the server will send any ACD routed interactions to the client. If the client needs to suspend ACD routed interactions, it may reset this flag to false, and then set it back to true when the client is ready to process ACD interactions again.

persistentConnection

Boolean

Specifies if a persistent connection should be set up with the station. By default the value is false.

remoteNumber

String

Required

Specifies the remote number use by the station.

[option]

Complex Type: remoteWorkstationSettings

__type

"urn:inin.com:connection:remoteWorkstationSettings"

Required

The JSON type representing this option.

supportedMediaTypes

List [1,*]: Enumeration: supportedMediaType

Specifies constants indicating what media types are supported for ACD routing on a station. The requested media types and the used media types may differ based off of licensing.

none

call

chat

generic

callback

smsMessage

workItem

directMessage

Feature	Version	Obsolete Version
connection	13

socialConversation

Feature	Version	Obsolete Version
connection	13

stationConnectionMode

Enumeration: stationConnectionMode

Used to change the station login and logout behavior with respect to the session manager session. By default the value is the 'default' value.

default

independentofSession

independentConnectionsLogoutWithSession

readyForInteractions

Boolean

workstation

String

Required

Workstation name.

remoteNumber

String

Specifies the optional RemoteNumber. By default the number configured by the administrator will be used.

[option]

Complex Type: stationlessSettings

Feature	Version	Obsolete Version
connection	2

__type

"urn:inin.com:connection:stationlessSettings"

Required

The JSON type representing this option.

supportedMediaTypes

List [1,*]: Enumeration: supportedMediaType

Specifies constants indicating what media types are supported for ACD routing on a station. The requested media types and the used media types may differ based off of licensing.

none

call

chat

generic

callback

smsMessage

workItem

directMessage

Feature	Version	Obsolete Version
connection	13

socialConversation

Feature	Version	Obsolete Version
connection	13

stationConnectionMode

Enumeration: stationConnectionMode

Used to change the station login and logout behavior with respect to the session manager session. By default the value is the 'default' value.

default

independentofSession

independentConnectionsLogoutWithSession

readyForInteractions

Boolean

[option]

Complex Type: workstationSettings

__type

"urn:inin.com:connection:workstationSettings"

Required

The JSON type representing this option.

supportedMediaTypes

List [1,*]: Enumeration: supportedMediaType

Specifies constants indicating what media types are supported for ACD routing on a station. The requested media types and the used media types may differ based off of licensing.

none

call

chat

generic

callback

smsMessage

workItem

directMessage

Feature	Version	Obsolete Version
connection	13

socialConversation

Feature	Version	Obsolete Version
connection	13

stationConnectionMode

Enumeration: stationConnectionMode

Used to change the station login and logout behavior with respect to the session manager session. By default the value is the 'default' value.

default

independentofSession

independentConnectionsLogoutWithSession

readyForInteractions

Boolean

workstation

String

Required

Workstation name.

Response

200 - OK

A station connection representation has been successfully created or updated. The URL to get the resource is specified in the Location header.

Parameters

Type

Name

Comments

Header

Location

Required

A URL specifying where a representation of the station connection can be found. In order to see effective media types for this connection a GET request must be made against this URL.

400 - Bad Request

This may indicate malformed syntax or an error validating the station request. The response body will include an error to indicate the cause of the error.

Error Responses

Error Identifier

Error Type

Error Description

error.request.connection.noLicense

Type: urn:inin.com:common:error

The station connection is not able to be created for one of these reasons:

The user or station is missing the required I3_CLIENT_ACCESS license.
The specified station is currently in use by a different user.

In the case that the I3_ACCESS_CLIENT license could not be obtained (either on the connected user or specified station), the server disconnects the session.

Feature	Version	Obsolete Version
connection	4

Type documentation:
The request failed because either the user or the station is missing a required license.

error.request.invalidRepresentation.missingRequiredParameter

Type: urn:inin.com:common:missingPropertyError

A required parameter was not present.

Feature	Version	Obsolete Version
connection	3

error.request.connection.unknownStation

Type: urn:inin.com:common:error

The logon failed because the station is unknown.

Feature	Version	Obsolete Version
connection	3

error.request.invalidRepresentation.invalidProperty

Type: urn:inin.com:common:invalidPropertyError

The request representation object contained an invalid property.

Feature	Version	Obsolete Version
connection	3

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

Multiple options:

The value can be assigned any of the following options.

[option]

Complex Type: error

Provides additional detail for an error.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

[option]

Complex Type: invalidPropertyError

Provides details about errors related to an invalid, required property.

__type

"urn:inin.com:common:invalidPropertyError"

Required

The JSON type representing this option.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

propertyName

String

The name of the invalid, required property.

[option]

Complex Type: missingPropertyError

Provides details about errors related to a missing required property.

__type

"urn:inin.com:common:missingPropertyError"

Required

The JSON type representing this option.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

propertyName

String

The name of the missing required property.

403 - Forbidden

The request was understood but the server refused to make the change. Information regarding the reason can be found in the entity body.

Error Responses

Error Identifier

Error Type

Error Description

error.request.accessDenied.noRights

Type: urn:inin.com:common:error

The request failed because the user has no rights.

Feature	Version	Obsolete Version
connection	3

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 Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

Feature	Version	Obsolete Version
connection	3

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.

GET

/icws/{sessionId}/connection/station

Retrieves the representation of an existing station connection.

Feature	Version	Obsolete Version
connection	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.

Response

200 - OK

The station connection representation was successfully retrieved. The station information representation is included in the response body.

stationInformation

Expand All Collapse All

Property

Value

Comments

canBeDialed

Boolean

Indicates whether the station can be dialed.

extension

String

Required

Indicates the station extension.

String

Required

Indicates the station ID.

ringAlways

Boolean

Indicates whether the station will always ring.

sipAddress

String

Indicates the station SIP address.

sipPassword

String

Indicates the station SIP password.

sipUser

String

Indicates the station SIP User.

remoteNumber

String

Indicates the remote number. Only available for remote number stations.

managedIPPhone

String

Required

This represents Managed IP Phone.

Feature	Version	Obsolete Version
connection	15

emergencyResponderLocationID

String

Required

This represents emergency responder location ID for the emergency address stored in station object.

Feature	Version	Obsolete Version
connection	15

stationSetting

Enumeration: stationSettingsType

Required

The station setting used to create the station connection representation.

none

workstation

remoteWorkstation

remoteNumber

allowedMediaTypes

List [1,*]: Enumeration: supportedMediaType

Indicates the media types available for ACD routing on the station. The requested media types may differ from the allowed media types based off of licensing.

Feature	Version	Obsolete Version
connection	13

none

call

chat

generic

callback

smsMessage

workItem

directMessage

Feature	Version	Obsolete Version
connection	13

socialConversation

Feature	Version	Obsolete Version
connection	13

404 - Not Found

No station connection was found for the session on this server.

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.