Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/users/{id}/client

PUT

/icws/{sessionId}/configuration/users/{id}/client

Updates the client configuration properties of a specific user resource. The difference between this and PUT /icws/{sessionId}/configuration/users/{id} is that this can be used only to modify the client configuration properties of the logged-in-user if they have the security right securityRights.customizeClient. To GET the values of these properties, use GET /icws/{sessionId}/configuration/users/{id} with the desired attributes selected.

Feature	Version	Obsolete Version
configuration	7

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

Required

The ID of the user resource.

Representations

userClientConfigurationProperties

This is not a user property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form clientConfigurationProperties.memberName. For example, clientConfigurationProperties.showStatusInSystemTray will return true if the user's status should be shown in the Windows system tray. Alternatively, one can use the '*' wildcard to select all properties of the user including these.

Expand All Collapse All

Property

Value

Comments

accountCodeSortByNumber

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

actualValue

Boolean

The value directly assigned to this configuration object. This value is required for POST and PUT operations.

This property can be null.

effectiveValue

Boolean

The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

This property can be null.

inheritedValue

Boolean

The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

This property can be null.

inheritedFrom

List [Unbounded]: Complex Type: inheritedBooleanValue

The list of where the value is inherited from. This attribute will exist only if singlePropertyInheritedValues is set to true.

This property can be null.

Property type documentation:

Represents a collection of inheritedBooleanValue.

List item type documentation:

Represents an inherited boolean value. This type contains properties that indicate where the value was inherited from.

from

Complex Type: configurationId

Required

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.

objectType

Enumeration: inheritedFromType

Required

Property type documentation:

Represents the possible object types that can be specified in an inherited from property.

none

The property was not inherited.

Workgroup

The property was inherited from a Workgroup configuration object.

Role

The property was inherited from a Role configuration object.

DefaultUser

The property was inherited from the Default User configuration object.

ClientConfigurationTemplate

The property was inherited from a Client Configuration Template configuration object.

values

Boolean

Required

activateOutOfOfficeMessage

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

alertOnSecurityBelowRequestedLevel

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

analyzeOutgoingExternalCalls

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

autoPlayVoicemail

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

autoSelectInteractionOnDisconnect

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

callForwardAll

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

callForwardAllMode

Complex Type: inheritableStringProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited string property.

actualValue

String

The value directly assigned to this configuration object. This value is required for POST and PUT operations.

This property can be null.

effectiveValue

String

The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

This property can be null.

inheritedValue

String

The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

This property can be null.

inheritedFrom

List [Unbounded]: Complex Type: inheritedString

The list of where the value is inherited from. This attribute will exist only if singlePropertyInheritedValues is set to true.

This property can be null.

Property type documentation:

Represents a collection of inherited strings.

List item type documentation:

Represents an inherited string. This type contains properties that indicate where the value was inherited from.

from

Complex Type: configurationId

Required

Property type documentation:

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

objectType

Enumeration: inheritedFromType

Required

Property type documentation:

Represents the possible object types that can be specified in an inherited from property.

none

The property was not inherited.

Workgroup

The property was inherited from a Workgroup configuration object.

Role

The property was inherited from a Role configuration object.

DefaultUser

The property was inherited from the Default User configuration object.

ClientConfigurationTemplate

The property was inherited from a Client Configuration Template configuration object.

values

String

Required

callForwardAllowChange

Complex Type: inheritableBooleanProperty

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

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

changeAlertingProperties

Complex Type: inheritableBooleanProperty

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

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

changeEfaqProperties

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

changeFollowMeProperties

Complex Type: inheritableBooleanProperty

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

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

changeQueueProperties

Complex Type: inheritableBooleanProperty

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

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

confirmDragAndDrop

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

confirmSingleClickDialing

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

eFaqSearchOption

Enumeration: eFaqSearchOptions

This property can be null.

All

Generous

Best

Strict

emailDownloadHTMLPictures

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	7

This property can be null.

Property type documentation:

Represents an inherited boolean property.

enableAdvancedDialing

Complex Type: inheritableBooleanProperty

Value that determines if the advanced dialing options are enabled.

Feature	Version	Obsolete Version
configuration	4

This property can be null.

Property type documentation:

Represents an inherited boolean property.

externalCallTimeout

Complex Type: inheritableIntProperty

The value must conform to all of these criteria:

Is a value from 1 to 1000.

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited integer property.

actualValue

Int

The value directly assigned to this configuration object. This value is required for POST and PUT operations.

This property can be null.

effectiveValue

Int

The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

This property can be null.

inheritedValue

Int

The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

This property can be null.

inheritedFrom

List [Unbounded]: Complex Type: inheritedInt

The list of where the value is inherited from. This attribute will exist only if singlePropertyInheritedValues is set to true.

This property can be null.

Property type documentation:

Represents a collection of inherited integers.

List item type documentation:

Represents an inherited integer. This type contains properties that indicate where the value was inherited from.

from

Complex Type: configurationId

Required

Property type documentation:

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

objectType

Enumeration: inheritedFromType

Required

Property type documentation:

Represents the possible object types that can be specified in an inherited from property.

none

The property was not inherited.

Workgroup

The property was inherited from a Workgroup configuration object.

Role

The property was inherited from a Role configuration object.

DefaultUser

The property was inherited from the Default User configuration object.

ClientConfigurationTemplate

The property was inherited from a Client Configuration Template configuration object.

values

Int

Required

followMe

List [Unbounded]: Complex Type: followMe

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents a collection of phone numbers for the client to call if the agent is not available.

List item type documentation:

Represents a phone number for the client to call if the agent is not available.

phoneNumber

String

Required

The phone number to call.

timeout

Int

Required

How long to ring the follow-me number before moving to the next number in the list or transferring the call to voice mail.

usePin

Boolean

Required

If true, than the call recipient will be required to enter their IC password to accept the call.

muteOnTransfer

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

openNewCallWindowForIncomingCalls

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

ringWhenOnPhone

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

screenCalls

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showStatusInSystemTray

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	3

This property can be null.

Property type documentation:

Represents an inherited boolean property.

Response

200 - OK

The user has been updated. The unchanged ID of the modified user 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 update 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.

404 - Not Found

The user 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.

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.