Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/actions

GET

/icws/{sessionId}/configuration/actions

Retrieves a list of actions. The results can be filtered by specifying a query. All list-based configuration object resources will have a complex property that will serve as its identity. This property is called the configurationId and consists of a {id, displayName, uri}.

The following result limits are enforced by the server regardless of the value of the Range header field:

If no properties are included (see select parameter), then all of the items will be returned.
If any properties are included (see select parameter), then a maximum of 200 items will be returned in the result.

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

Header

Range

Specifies the range of results to be returned.

Example: Range: items=10-20.

Query

select

A comma-delimited list of fields to include in the query. If no fields are specified, then only the ID of the items is returned.

Example: select=extension,defaultWorkstation

One can also specify that all of the properties should be returned by using the '*' wildcard value. This is a shortcut for specifying all of the properties' names in the parameter.

The selected properties with a NULL value will not be returned to conserve the Interaction Center server's resources.

Query

where

A comma-delimited list of conditions to filter the results of the query. Only items that satisfy all conditions will be returned.

The following operators can be used:

eq - equals
sw - starts with
ct - contains

Example: where=configurationId.id sw Value

It is supported for the following properties:

configurationId.displayName
configurationId.id
notes

Query

orderBy

The name of the field to sort the results by and an optional sort direction. The default is to sort by configurationId.displayName in ascending order. A query can only be sorted by one field and only supports one (optional) direction indicator: asc (ascending) or desc (descending).

To sort in descending order use: orderBy=configurationId.id desc

To sort in ascending order use: orderBy=configurationId.id (or orderBy=configurationId.id asc)

It is supported for the following properties:

configurationId.displayName
configurationId.id

Default value: configurationId.displayName

Query

rightsFilter

The security right to use when filtering the results.

Default value: admin

Options:

view
admin

Response

200 - OK

The result set of the query is included in the response.

Parameters

Type

Name

Comments

Header

Content-Range

Required

Specifies the range of items being returned in the result along with the total number of items.

Example: Content-Range: items 5-10/200

actions

Represents a list of action configuration objects.

Expand All Collapse All

Property

Value

Comments

items

List [Unbounded]: Complex Type: action

Required

The list of action configuration objects.

List item type documentation:

Represents the action configuration object.

configurationId

Complex Type: configurationId

The unique identifier. The value must conform to all of these criteria:

Is a value containing none of the characters '\', '"', or '|'.
Is a string with from 1 to 50 characters.

This property is required to be present in POST operations.

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

String

Required

The unique identifier used to reference this configuration object.

displayName

String

The display name of this configuration object.

This property can be null.

uri

Uri

A URI used to access this configuration object.

createdDate

DateTime

The date this configuration object was created.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

customAttributes

List [Unbounded]: Complex Type: customAttribute

The custom attributes for the configuration object.

This property can be null.

List item type documentation:

Represents a Custom Attribute value for a configuration object.

name

String

Required

The key identifying this pair.

value

String

Required

The value of this pair.

This property can be null.

lastModifiedDate

DateTime

The date this configuration object was last modified.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

notes

String

The notes for this configuration object.

This property can be null.

actionType

Enumeration: actionType

This property is required to be present in POST operations.

Property type documentation:

Represents possible values for the actionType property.

dde

customScreenPop

webBrowserScreenPop

urlAction

Complex Type: urlAction

The URL action properties to use if the actionType is URL Screen Pop. This property is unused if actionType is not URL Screen Pop.

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

A URL action and its corresponding properties.

url

String

Required

The URL to open in the browser.

popupType

Enumeration: popupType

Required

The type of popup to use for the URL action.

Property type documentation:

Represents possible values for the popupType property.

new

Pop to a new browser (only supported in Internet Explorer and Firefox).

tab

Pop to a new tab on an existing browser session (Not supported in web-based clients).

parameters

List [1,*]: Complex Type: actionParameter

The list of parameters to append to the URL.

This property can be null.

List item type documentation:

A parameter to pass with the action.

name

String

Required

The name to identify the parameter.

friendlyName

String

Required

The name displayed to the user.

override

Enumeration: attendantOverrideType

Required

Whether to allow or disallow Attendant overrides.

Property type documentation:

Represents possible values for the attendantOverrideType property.

allow

Allow override.

restrict

Allow override with restricted values(multiple choice).

disallow

Do not allow override.

defaultValue

String

The value to use when Attendant overrides are disallowed, or the default value to use then they are allowed or restricted.

This property can be null.

restrictedValues

Dictionary

The values to use when Attendant overrides are restricted. This property will be ignored unless Attendant overrides are restricted.

This property can be null.

Property type documentation:

The values to use when the Attendant override type is set to restricted.

[key]

String

Required

[value]

String

Required

400 - Bad Request

Invalid parameter value was specified.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.get.selectAll

Type: urn:inin.com:common:error

Combining the wildcard (*) and one or more specific properties in one request is not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList

Type: urn:inin.com:configuration:getObjectListError

One or more of the properties in the 'rightsFilter', 'select', 'where', or 'orderBy' query parameters are not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList.invalidSortDirection

Type: urn:inin.com:common:error

The sort direction in the 'orderBy' query parameter is not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList.invalidWhereOperator

Type: urn:inin.com:common:error

The operator in the 'where' query parameter is not supported.

Feature	Version	Obsolete Version
configuration	2

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: getObjectListError

Provides details about errors with a GET configuration object list operation.

__type

"urn:inin.com:configuration:getObjectListError"

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.

select

List [Unbounded]: String

The properties in the select query parameter that are not supported by the object type.

Property type documentation:

Represents a collection of strings.

rightsFilter

String

The properties in the rightsFilter query parameter that are not supported by the object type.

where

List [Unbounded]: String

The properties in the where query parameter that are not supported by the object type.

Property type documentation:

Represents a collection of strings.

orderBy

String

The property in the orderBy query parameter is not supported by the object type.

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
configuration	2

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

Feature	Version	Obsolete Version
configuration	2

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.

POST

/icws/{sessionId}/configuration/actions

Creates a new action resource.

Feature	Version	Obsolete Version
configuration	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

action

Represents the action configuration object.

Expand All Collapse All

Property

Value

Comments

configurationId

Complex Type: configurationId

The unique identifier. The value must conform to all of these criteria:

Is a value containing none of the characters '\', '"', or '|'.
Is a string with from 1 to 50 characters.

This property is required to be present in POST operations.

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

String

Required

The unique identifier used to reference this configuration object.

displayName

String

The display name of this configuration object.

This property can be null.

uri

Uri

A URI used to access this configuration object.

createdDate

DateTime

The date this configuration object was created.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

customAttributes

List [Unbounded]: Complex Type: customAttribute

The custom attributes for the configuration object.

This property can be null.

List item type documentation:

Represents a Custom Attribute value for a configuration object.

name

String

Required

The key identifying this pair.

value

String

Required

The value of this pair.

This property can be null.

lastModifiedDate

DateTime

The date this configuration object was last modified.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

notes

String

The notes for this configuration object.

This property can be null.

actionType

Enumeration: actionType

This property is required to be present in POST operations.

Property type documentation:

Represents possible values for the actionType property.

dde

customScreenPop

webBrowserScreenPop

urlAction

Complex Type: urlAction

The URL action properties to use if the actionType is URL Screen Pop. This property is unused if actionType is not URL Screen Pop.

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

A URL action and its corresponding properties.

url

String

Required

The URL to open in the browser.

popupType

Enumeration: popupType

Required

The type of popup to use for the URL action.

Property type documentation:

Represents possible values for the popupType property.

new

Pop to a new browser (only supported in Internet Explorer and Firefox).

tab

Pop to a new tab on an existing browser session (Not supported in web-based clients).

parameters

List [1,*]: Complex Type: actionParameter

The list of parameters to append to the URL.

This property can be null.

List item type documentation:

A parameter to pass with the action.

name

String

Required

The name to identify the parameter.

friendlyName

String

Required

The name displayed to the user.

override

Enumeration: attendantOverrideType

Required

Whether to allow or disallow Attendant overrides.

Property type documentation:

Represents possible values for the attendantOverrideType property.

allow

Allow override.

restrict

Allow override with restricted values(multiple choice).

disallow

Do not allow override.

defaultValue

String

The value to use when Attendant overrides are disallowed, or the default value to use then they are allowed or restricted.

This property can be null.

restrictedValues

Dictionary

The values to use when Attendant overrides are restricted. This property will be ignored unless Attendant overrides are restricted.

This property can be null.

Property type documentation:

The values to use when the Attendant override type is set to restricted.

[key]

String

Required

[value]

String

Required

Response

201 - Created

The request to create the action was acknowledged. The new object will be available shortly depending on the server's load. The ID provided in the request's body is returned in the response.

updateOperationResult

Represents the result from a put or post operation.

Expand All Collapse All

Property

Value

Comments

String

Required

The unique identifier used to reference this configuration object.

uri

Uri

A URI used to access this configuration object.

licenseProblems

List [1,*]: Complex Type: licenseError

List item type documentation:

Represents a license warning or error that occurred during a commit.

licenseErrorType

Enumeration: licenseErrorType

Required

Property type documentation:

Represents a license warning or error in a request to modify a configuration object.

setOK

Setting the license succeeded. This value is never sent.

setWarningExceedsThreshold

Indicates that a dynamic license was found with an assignment count that exceeds it's assignable and or concurrent thresholds. As this is only a warning to indicate problems, the license in the request was set successfully.

setErrorExceedsThreshold

Indicates that a dynamic license being set exceed it's assignable or concurrent thresholds and was not set as a result. This can be returned for any license assigned to a user or station as part of setting it's licenses because they are all checked for problems as part of the operation.

setWarningMissingQualifiers

Indicates that the ACD media level in the request did not have a corresponding set of ACD media types and the default value(s) for the level were set as a result.

license

Complex Type: configurationId

Required

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

400 - Bad Request

Invalid request was provided. If validation errors exist, they will be returned in the response.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

error.request.configuration.update

Type: urn:inin.com:configuration:configurationError

The request has one or more license or validation errors in it.

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: configurationError

Represents a validation or licensing error that occurred during a commit. It contains a list of the errors that were encountered.

__type

"urn:inin.com:configuration:configurationError"

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.

validationErrors

List [1,*]: Complex Type: validationError

List item type documentation:

Represents a validation error that occurred during a commit.

validationErrorType

Enumeration: validationErrorType

Required

Property type documentation:

Represents an error in a request to modify a configuration object.

unknownValidator

Unknown validator.

uniqueInstanceId

The value must be unique across objects of this type.

existingInstanceId

The value must represent a valid ID for a configured instance.

existingAttributeValue

The value must match a configured instance.

requiredValue

The value must be specified.

range

The value must be in the correct range.

stringLength

The value must have the correct number of characters.

regex

The value must be formatted correctly.

validValues

The value is not from the allowed set.

collectionCount

The value must have the correct number of items.

collectionItemValidator

One or more items failed to validate successfully.

validatorGroup

The value is not from the allowed set.

validFormat

The value is not in a valid format.

uniqueAttributeValue

The value must be unique across attributes of this type.

requiredAttribute

The attribute must be specified.

acgTreeValidator

The Acg Tree either could not be verified or found, or the Acg Tree depth is not supported.

pronunciationValidator

The value is not a valid pronunciation format.

wordValidator

The value must be a valid word.

rangeFloat

The value must be in the correct range.

existingAttendantProfile

The value must match a configured attendant profile instance.

extension

The value must not be an existing extension.

workstationsSharedAppearanceID

Unknown validator.

multipleOf

The value is not a valid multiple value.

invalidCharacters

The value contains invalid characters.

existingExtension

The value must be an existing extension.

existingInstanceIdWithAttributeValue

The value must represent a valid ID for a configured instance.

characterDelimitedValue

The value contains invalid characters.

analyzerKeywordCount

The number of keywords assigned to the keyword set makes the configuration exceed the maximum number of supported keywords.

workgroupAnalyzerKeywordCount

The number of keywords assigned to the workgroup is greater than the maximum number of supported keywords.

endDateTimeValidator

The end date or time of a schedule must be greater than or equal to the start date or time.

propertyNotApplicable

This property is not applicable with the current configuration.

invalidMailboxFolder

The value is not a valid mailbox.

unsupportedManufacturer

The provided phone manufacturer is unsupported.

unsupportedModel

The provided phone model is unsupported.

audioProtocol

An Audio protocol value of SRTP is only supported when the Registration Group for the configuration object has one or more registered lines with a Transport Protocol of TLS.

recorderPolicyAnalyzerKeywordCount

The number of keywords assigned to the keyword set makes at least one Recorder Policy exceed the maximum number of supported keywords.

referenceCount

The number of reference to this object is exceeding the maximum limit.

Feature	Version	Obsolete Version
configuration	8

wrapUpStatusTimeout

The values of WrapUpStatus or WrapUpTimeout are not valid.

Feature	Version	Obsolete Version
configuration	8

attributeExistence

One or more required attributes was not specified and/or one or more required absent attributes was specifed.

Feature	Version	Obsolete Version
configuration	8

otherAttributeValue

The otherAttributeValue property is expected to have (or not have) a value.

Feature	Version	Obsolete Version
configuration	8

networkAdapter

The network adapter is invalid.

Feature	Version	Obsolete Version
configuration	8

integerComparisonValidator

The integer comparison failed validation based on the comparison type selected.

Feature	Version	Obsolete Version
configuration	8

timeZoneValidator

The time zone is invalid.

Feature	Version	Obsolete Version
configuration	8

existingLanguageValues

The values provided must be languages supported by PureConnect.

Feature	Version	Obsolete Version
configuration	8

characterDelimitedKVPairs

The character delimited key-value pairs are invalid.

Feature	Version	Obsolete Version
configuration	8

objectValidationErrorMutuallyExclusive

Two configuration values are mutually exclusive.

Feature	Version	Obsolete Version
configuration	10

propertyName

String

Required

propertyValue

String

Required

licenseErrors

List [1,*]: Complex Type: licenseError

List item type documentation:

Represents a license warning or error that occurred during a commit.

licenseErrorType

Enumeration: licenseErrorType

Required

Property type documentation:

Represents a license warning or error in a request to modify a configuration object.

setOK

Setting the license succeeded. This value is never sent.

setWarningExceedsThreshold

setErrorExceedsThreshold

setWarningMissingQualifiers

Indicates that the ACD media level in the request did not have a corresponding set of ACD media types and the default value(s) for the level were set as a result.

license

Complex Type: configurationId

Required

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

403 - Forbidden

Not authorized to create this resource.

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
configuration	2

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

Feature	Version	Obsolete Version
configuration	2

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.