Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/defaults/workgroup

GET

/icws/{sessionId}/configuration/defaults/workgroup

Returns an initialized workgroup object with default values.

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.

Response

200 - OK

An initialized workgroup object with defaults is in the response.

workgroup

Represents the workgroup 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.

accessControlGroupAssignment

Complex Type: configurationId

The access control group assignment for this configuration object. The value of this is required only when access control groups are in use. The reason for this is because most users will not have the necessary rights to assign an object to the root access control group, which is the default assignment for a newly created object. If access control groups are not in use, then this property is optional because the server will assign it to the root access control group which always exists. The value must conform to all of these criteria:

An instance of the Access Control Group object type.

Property type documentation:

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

accessRights

Complex Type: accessRightsProperties

The collection of properties that make up the access control rights for a User, Role, Workgroup, or the Default User.

This property can be null.

Property type documentation:

This is not a property of them. 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 accessRights.memberName. For example, accessRights.viewUserQueue will return the objects's view user queue access rights. Alternatively, one can use the '*' wildcard to select all properties of the object including these.

activateOthers

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

actualValue

List [Unbounded]: Complex Type: groupedConfigurationId

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

This property can be null.

Property type documentation:

Represents a collection of groupedConfigurationId's.

List item type documentation:

Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.

String

The unique identifier used to reference this configuration object. The value of this can be null when the grouping of this value is All. Otherwise, it is required.

This property can be null.

displayName

String

The display name of this configuration object.

This property can be null.

uri

Uri

A URI used to access this configuration object.

This property can be null.

objectType

Enumeration: objectType

Required

The object type that this configuration ID represents.

Property type documentation:

Represents the possible object types that can be specified in a groupedConfigurationId.

none

Represents no object type.

acg

Represents an ACG object type.

workgroup

Represents the workgroup object type.

lineGroup

Represents the lineGroup object type.

feedbackSurveyGroup

Represents the feedbackSurveyGroup object type.

grouping

Enumeration: configurationIdGrouping

Required

The grouping for this configuration ID.

Property type documentation:

Represents the possible groupings that can be specified in a groupedConfigurationId.

all

Represents all possible ConfigurationIds.

single

Represents a single ConfigurationId.

group

Represents a grouping of ConfigurationIds where each ConfigurationId is a member of some other Aggregate (Workgroup, Role, ...).

effectiveValue

List [Unbounded]: Complex Type: groupedConfigurationId

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.

Property type documentation:

Represents a collection of groupedConfigurationId's.

List item type documentation:

Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.

inheritedValue

List [Unbounded]: Complex Type: groupedConfigurationId

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

This property can be null.

Property type documentation:

Represents a collection of groupedConfigurationId's.

List item type documentation:

Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.

inheritedFrom

List [Unbounded]: Complex Type: inheritedGroupedConfigurationId

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 inheritedGroupedConfigurationIds.

List item type documentation:

Represents an inherited groupedConfigurationIdCollection. 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

List [Unbounded]: Complex Type: groupedConfigurationId

Required

Property type documentation:

Represents a collection of groupedConfigurationId's.

List item type documentation:

Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.

activateSelf

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

canEditAccessRights

Complex Type: inheritableBooleanProperty

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.

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

changeUserStatus

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

clientButtons

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Client Button objects.
An instance of the Client Button object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

coachLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

coachStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

coachUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

coachWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createOptimizerForecasts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createSchedulingUnitAgentConstraints

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createSchedulingUnitAgentGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createSchedulingUnitSchedules

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createSchedulingUnitShiftRotations

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createSchedulingUnitShifts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

createSchedulingUnitTimeoffRequests

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteOptimizerForecasts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteSchedulingUnitAgentConstraints

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteSchedulingUnitAgentGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteSchedulingUnitSchedules

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteSchedulingUnitShiftRotations

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteSchedulingUnitShifts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

deleteSchedulingUnitTimeoffRequests

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

disconnectLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

disconnectStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

disconnectUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

disconnectWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

eFaqs

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All E Faq objects.
An instance of the E Faq object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

followMePhoneNumberClassifications

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Dial Plan Classification objects.
An instance of the Dial Plan Classification object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

forwardPhoneNumberClassifications

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Dial Plan Classification objects.
An instance of the Dial Plan Classification object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

holdStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

holdUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionClientPlugins

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Client Plugin objects.
An instance of the Interaction Client Plugin object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionConferenceRestrictRooms

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Conference Room objects.
An instance of the Interaction Conference Room object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

joinLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

joinStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

joinUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

joinWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

launchableProcessList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Process Automation Process objects.
An instance of the Interaction Process Automation Process object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

listAccountCodes

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Account Code objects.
An instance of the Account Code object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

listenLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

listenStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

listenUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

listenWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

loginStation

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

manageProcessList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Process Automation Process objects.
An instance of the Interaction Process Automation Process object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

miscellaneous

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Miscellaneous Item objects.
An instance of the Miscellaneous Item object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyAttendantEmailProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Email Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyAttendantInboundProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Inbound Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyAttendantOperatorProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Operator Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyAttendantOutboundProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Outbound Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyCampaignList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Campaign Acl objects.
An instance of the Interaction Dialer Campaign Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyFeedbackSurveys

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Feedback Survey objects.
An instance of the Feedback Survey object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyOptimizerForecasts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifyRecorderQuestionnaires

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Recorder Questionnaire objects.
An instance of the Interaction Recorder Questionnaire object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitAgentConstraints

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitAgentGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitConfiguration

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitListRealTimeAdherence

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitSchedules

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitShiftRotations

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitShifts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

modifySchedulingUnitTimeoffRequests

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

muteStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

muteUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

phoneNumberClassifications

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Dial Plan Classification objects.
An instance of the Dial Plan Classification object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

pickupLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

pickupStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

pickupUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

pickupWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

previewEmailUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

previewEmailWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

recordLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

recordStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

recordUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

recordWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

responseManagementDocuments

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Response Management Document objects.
An instance of the Response Management Document object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

snipLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

Feature	Version	Obsolete Version
configuration	11

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

snipStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

Feature	Version	Obsolete Version
configuration	11

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

snipUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

Feature	Version	Obsolete Version
configuration	11

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

snipWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

Feature	Version	Obsolete Version
configuration	11

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

statusMessages

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Status Message objects.
An instance of the Status Message object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

substituteQueueControlColumns

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Queue Column objects.
An instance of the Queue Column object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

transferLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

transferStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

transferUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

transferWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

tuiPhoneNumberClassifications

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Dial Plan Classification objects.
An instance of the Dial Plan Classification object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAnalyticsDashboards

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An AnalyticsDashboard objects.
An instance of the AnalyticsDashboard object type.

Feature	Version	Obsolete Version
configuration	14

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantEmailProfileInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Email Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantEmailProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Email Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantInboundProfileInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Inbound Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantInboundProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Inbound Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantOperatorProfileInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Operator Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantOperatorProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Operator Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantOutboundProfileInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Outbound Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewAttendantOutboundProfiles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Attendant Outbound Profile objects.
Is a value representing an existing Attendant profile of the correct type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewCampaignList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Campaign Acl objects.
An instance of the Interaction Dialer Campaign Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewDataSource

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Ic Data Source objects.
An instance of the Ic Data Source object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewFeedbackSurveys

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Feedback Survey objects.
An instance of the Feedback Survey object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewGeneralDirectories

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Contact List Source objects.
An instance of the Contact List Source object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewHistoricalReports

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Historical Report objects.
An instance of the Historical Report object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewIndividualStatistics

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewLayoutList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Layout objects.
An instance of the Layout object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewLineQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
A instance of the Line Group object type with a group type of Line Group
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewModifyOptimizerAll

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewOptimizerForecasts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewOptimizerSchedulingUnits

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewPositionsList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Position objects.
An instance of the Position object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewProcessList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Process Automation Process objects.
An instance of the Interaction Process Automation Process object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewQueueControlColumns

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Queue Column objects.
An instance of the Queue Column object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewRecorderQuestionnaires

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Recorder Questionnaire objects.
An instance of the Interaction Recorder Questionnaire object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewReport

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Legacy Historical Report objects.
An instance of the Legacy Historical Report object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitAgentConstraints

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitAgentGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitConfiguration

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitIntradayMonitoring

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitListRealTimeAdherence

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitSchedulePreferences

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitSchedules

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitShiftRotations

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitShifts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSchedulingUnitTimeoffRequests

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Optimizer Scheduling Unit objects.
An instance of the Interaction Optimizer Scheduling Unit object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewSkillList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Skill objects.
An instance of the Skill object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewStationGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Station Group objects.
An instance of the Station Group object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewStationGroupsInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Station Group objects.
An instance of the Station Group object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewStationQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewStationQueueInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewStatusColumns

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Status Column objects.
An instance of the Status Column object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewUserInteractionHistory

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewUserQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewWorkgroup

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewWorkgroupQueue

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewWorkgroupQueueInSearch

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

viewWorkgroupStatistics

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

acdDisconnectedAction

Complex Type: configurationId

The value must conform to all of these criteria:

Is a configuration ID reference to an existing instance in the server's 'Action' collection, where 'Type' is 'DDE'.

This property can be null.

Property type documentation:

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

acdIncomingAction

Complex Type: configurationId

The value must conform to all of these criteria:

Is a configuration ID reference to an existing instance in the server's 'Action' collection, where 'Type' is 'DDE'.

This property can be null.

Property type documentation:

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

acdOfferingAction

Complex Type: configurationId

The value must conform to all of these criteria:

An instance of the Action object type.

This property can be null.

Property type documentation:

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

acdSaveRepliesToSentItemsFolder

Boolean

Setting this property to null will set it to its default value.

Default value: false

acdTransferAction

Complex Type: configurationId

The value must conform to all of these criteria:

Is a configuration ID reference to an existing instance in the server's 'Action' collection, where 'Type' is 'DDE'.

This property can be null.

Property type documentation:

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

acdUseAvailablityTime

Boolean

Setting this property to null will set it to its default value.

Default value: true

administrativeRights

Complex Type: administrativeRightsProperties

The collection of properties that make up the administrative rights for a User, Role, Workgroup, or the Default User.

This property can be null.

Property type documentation:

This is not a property of them. 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 administrativeRights.memberName. For example, administrativeRights.masterAdministrator will return the objects's master administrator right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.

accountCodeList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Account Code objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Account Code object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

accumulatorList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Accumulator objects.
An instance of the Accumulator object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

actions

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Action objects.
An instance of the Action object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

analyticsConfiguration

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	14

This property can be null.

Property type documentation:

Represents an inherited boolean property.

attendantDefaults

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

audioSources

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Audio Source objects.
An instance of the Audio Source object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

botsConfiguration

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	18

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canEditAdministrativeRights

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canPublishClientTemplates

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

clientButtons

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Client Button objects.
An instance of the Client Button object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

clientConfigurationConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

clientConfigurationTemplates

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Client Configuration Template objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Client Configuration Template object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

collective

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

contactListSources

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Contact List Source objects.
An instance of the Contact List Source object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

dataManagerConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

defaultIPPhoneConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

defaultLocationConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

defaultStationConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

defaultUserConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

dnisMappingsConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

eFaq

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All E Faq objects.
An instance of the E Faq object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

faxConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

faxGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Fax Group objects.
An instance of the Fax Group object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

handlers

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Handler objects.
An instance of the Handler object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

iCDataSources

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Ic Data Source objects.
An instance of the Ic Data Source object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

imageResources

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Image Resource objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Image Resource object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

initializationFunctions

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Initialization Function objects.
An instance of the Initialization Function object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionAnalyzerKeywordSets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Keyword Set objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Keyword Set object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionConferenceConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionConferenceRooms

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Conference Room objects.
An instance of the Interaction Conference Room object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerCallLists

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Call List Acl objects.
An instance of the Interaction Dialer Call List Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerCampaigns

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Campaign Acl objects.
An instance of the Interaction Dialer Campaign Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionDialerPolicySets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Policy Set Acl objects.
An instance of the Interaction Dialer Policy Set Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerRuleSets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Rule Set Acl objects.
An instance of the Interaction Dialer Rule Set Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerSchedules

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Schedule Acl objects.
An instance of the Interaction Dialer Schedule Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerScripts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Script Acl objects.
An instance of the Interaction Dialer Script Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerSkillSets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Skill Set Acl objects.
An instance of the Interaction Dialer Skill Set Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerStageSets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Stage Set Acl objects.
An instance of the Interaction Dialer Stage Set Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionDialerZoneSets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Dialer Zone Set Acl objects.
An instance of the Interaction Dialer Zone Set Acl object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionFeedbackConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionOptimizerAdvancedConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionOptimizerAgentsConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionProcessAutomation

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionProcessorTables

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Interaction Processor Table objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Interaction Processor Table object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

interactionRecorderConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionTrackerConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

iPPhoneRegistrationGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An IpPhoneProxyGroup objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the IpPhoneProxyGroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

iPPhoneRingSets

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An IpPhoneRingSet objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the IpPhoneRingSet object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

iPPhones

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An IpPhone objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the IpPhone object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

iPPhoneTemplates

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An IpPhoneTemplate objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the IpPhoneTemplate object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

layouts

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Layout objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Layout object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

licensesAllocationConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

lineGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line Group objects.
An instance of the Line Group object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

lines

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Line objects.
An instance of the Line object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

locations

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Location objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Location object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

logRetrievalAssistantConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

mailConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

masterAdministrator

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

mediaServersConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

mrcpConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

passwordPolicies

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Password Policy objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Password Policy object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

passwordPoliciesConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

peerSitesConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

phoneNumbersConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

positions

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Position objects.
An instance of the Position object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

problemReporterConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

queueControlColumns

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Queue Column objects.
An instance of the Queue Column object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

reportLogs

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Report Log objects.
An instance of the Report Log object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

reports

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Legacy Historical Report objects.
An instance of the Legacy Historical Report object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

responseManagement

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Response Management Document objects.
An instance of the Response Management Document object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

roles

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Role objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Role object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

salesforceCtis

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Salesforce Cti Configuration objects.
An instance of the Salesforce Cti Configuration object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

sametimeConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

schedules

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Schedule objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Schedule object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

secureInputForms

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Secure Input Form objects.
An instance of the Secure Input Form object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

selectionRuleList

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Selection Rule objects.
An instance of the Selection Rule object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

serverParameter

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Server Parameter objects.
An instance of the Server Parameter object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

serversConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

sessionManagerServerConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

singleSignOnIdentityProviders

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Single Sign On Identity Provider objects.
An instance of the Single Sign On Identity Provider object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

singleSignOnSecureTokenServer

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

sipBridge

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Sip Bridge objects.
An instance of the Sip Bridge object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

sipProxyConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

skillCategories

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Skill Category objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Skill Category object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

skills

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Skill objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Skill object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

smsBroker

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Sms Broker objects.
An instance of the Sms Broker object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

smsConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

socialMedia

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

speechRecognitionConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

stationGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Station Group objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Station Group object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

stations

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An Station objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Station object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

stationTemplates

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

An StationTemplate objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the StationTemplate object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

statisticGroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Statistic Parameter Group objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Statistic Parameter Group object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

statusMessages

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Status Message objects.
An instance of the Status Message object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

structuredParameters

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Structured Parameter objects.
An instance of the Structured Parameter object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

systemConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

systemParameters

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All System Parameter objects.
An instance of the System Parameter object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

users

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All User objects.
A instance of the Workgroup object type with a group type of Workgroup
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the User object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

webServicesParameters

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Web Services Parameter objects.
An instance of the Web Services Parameter object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

widgetsConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

workgroups

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Workgroup objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Workgroup object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

wrapUpCategories

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Wrap Up Category objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Wrap Up Category object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

wrapUpCodes

Complex Type: inheritableGroupedConfigurationIdCollection

Is a collection of items that each conform to at least one of these criteria:

All Wrap Up Code objects.
A instance of the Access Control Group object type with a group type of Access Control Group
An instance of the Wrap Up Code object type.

This property can be null.

Property type documentation:

Represents an inherited property consisting of a collection of ConfigurationId's.

agentScoreChange

Int

The value must conform to all of these criteria:

Is a value from -1000 to 1000.

Setting this property to null will set it to its default value.

Default value: -10

callbackMaxRetry

Int

The value must conform to all of these criteria:

Is a value of at least 0.

Setting this property to null will set it to its default value.

Default value: 0

callbackServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: [300, 600, 900, 1800, 3600, 7200, 14400, 28800]

Property type documentation:

Represents a collection of durations.

callbackServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: 14400

callbackSnoozeDuration

Int

The value must conform to all of these criteria:

Is a value of at least 0.

Setting this property to null will set it to its default value.

Default value: 0

callServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: [5, 10, 20, 30, 40, 50, 60, 120]

Property type documentation:

Represents a collection of durations.

callServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: 30

callStatisticsPeriod

Int

The value must conform to all of these criteria:

Is a value from 5 to 480.

Setting this property to null will set it to its default value.

Default value: 30

captureInRecordings

Boolean

Setting this property to null will set it to its default value.

Default value: false

chatServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: [10, 20, 30, 45, 60, 90, 120, 240]

Property type documentation:

Represents a collection of durations.

chatServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: 30

clientWaitTimeout

Int

The value must conform to all of these criteria:

Is a value from 0 to 60.

Setting this property to null will set it to its default value.

Default value: 30

emailServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: [300, 600, 1200, 1800, 3600, 7200, 14400, 28800]

Property type documentation:

Represents a collection of durations.

emailServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: 14400

estimatedCallTimeInterval

Int

The value must conform to all of these criteria:

Is a value from 5 to 480.

Setting this property to null will set it to its default value.

Default value: 30

executeTransferActionOnUserTransfer

Boolean

Setting this property to null will set it to its default value.

Default value: true

extension

String

The value must conform to all of these criteria:

Is a value representing a valid Extension.

This property can be null.

faxCapability

Boolean

Setting this property to null will set it to its default value.

Default value: false

genericServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: [10, 20, 30, 45, 60, 90, 120, 240]

Property type documentation:

Represents a collection of durations.

genericServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: 30

gracePeriodBeforeNew

Int

The value must conform to all of these criteria:

Is a value from 0 to 120.

Setting this property to null will set it to its default value.

Default value: 10

hasQueue

Boolean

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

Setting this property to null will set it to its default value.

Default value: false

interactionDisconnectedAction

Complex Type: configurationId

The value must conform to all of these criteria:

Is a configuration ID reference to an existing instance in the server's 'Action' collection, where 'Type' is 'DDE'.

This property can be null.

Property type documentation:

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

interactionOfferingAction

Complex Type: configurationId

The value must conform to all of these criteria:

An instance of the Action object type.

This property can be null.

Property type documentation:

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

interactionOfferingTimeout

Complex Type: inheritableDurationProperty

The value must conform to all of these criteria:

Is a value of at least 7.

This property can be null.

Property type documentation:

Represents an inherited duration property.

actualValue

Duration

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

This property can be null.

effectiveValue

Duration

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

Duration

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

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 durations.

List item type documentation:

Represents an inherited duration. 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

Duration

Required

isAcdEmailRoutingActive

Boolean

Setting this property to null will set it to its default value.

Default value: false

isActive

Boolean

Setting this property to null will set it to its default value.

Default value: true

isCallbackEnabled

Boolean

Setting this property to null will set it to its default value.

Default value: false

isExemptHeldInteractionsEnabled

Boolean

Setting this property to null will set it to its default value.

Default value: false

isWrapUpActive

Boolean

Setting this property to null will set it to its default value.

Default value: false

keypadWaitTimeout

Int

The value must conform to all of these criteria:

Is a value from 0 to 60.

Setting this property to null will set it to its default value.

Default value: 30

maximumChatReponseTime

Int

The value must conform to all of these criteria:

Is a value from 0 to 3600.

This property can be null.

maxNumberOfExempt

Int

The value must conform to all of these criteria:

Is a value from 1 to 100.

Setting this property to null will set it to its default value.

Default value: 1

members

List [Unbounded]: Complex Type: configurationId

Is a collection of items that each conform to all of these criteria:

An instance of the User object type.

This property can be null.

Property type documentation:

Represents a collection of configurationId's.

List item type documentation:

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

membersSpanSites

Boolean

This value can only be set to true if the homesite is participating in multi-site configuration. The value must conform to all of these criteria:

Is a value referring to an existing configured item.

Setting this property to null will set it to its default value.

Default value: false

monitoredMailboxes

List [Unbounded]: Complex Type: monitoredMailbox

This property can be null.

Property type documentation:

Represents a list of monitoredMailbox configuration objects.

List item type documentation:

Represents the monitoredMailbox configuration object.

canReceiveEncryptedEmail

Boolean

Setting this property to null will set it to its default value.

Default value: false

configurationId

Complex Type: configurationId

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

Is a value matching the regular expression '(^\d+$)'.
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.

emailAddress

String

This property is required to be present in POST operations.

inboundFolder

String

For inbound mailbox types, this folder must exist in the configured mailbox. For non-inbound mailboxes, this must be null. An Invalid Folder validation error will be returned otherwise. The value must conform to all of these criteria:

The ACD mailbox inbound folder must exist or be set to null.

This property can be null.

mailboxMoniker

String

When this value is changed for inbound mailboxes, the current Inbound Folder must exist in the new mailbox or an Invalid Folder validation error will be returned with the folder name. The value must conform to all of these criteria:

The ACD mailbox inbound folder must exist or be set to null.

This property is required to be present in POST operations.

mailboxType

Enumeration: monitoredMailboxType

When this is changed to an inbound type, the configured Inbound Folder must exist in the mailbox. When the Mailbox Type is changed to a non-inbound type, the configured Inbound Folder must be null. An Invalid Folder validation error will be returned with the folder name otherwise. The value must conform to all of these criteria:

The ACD mailbox inbound folder must exist or be set to null.

This property is required to be present in POST operations.

inbound

outbound

outboundAndInbound

nameSpellingsAsr

List [Unbounded]: String

This property can be null.

Property type documentation:

Represents a collection of strings.

nameSpellingTts

String

This property can be null.

noAnswerStatus

Complex Type: configurationId

The value must conform to all of these criteria:

An instance of the Status Message object type.

This property can be null.

Property type documentation:

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

onCallStatus

Complex Type: configurationId

The value must conform to all of these criteria:

An instance of the Status Message object type.

This property can be null.

Property type documentation:

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

onHoldMessage

String

This property can be null.

onHoldMusic

String

This property can be null.

operatorTarget

String

This property can be null.

parkedCallExtension

Complex Type: inheritableStringProperty

The value must conform to all of these criteria:

Is a value representing an existing Extension of an appropriate type for the setting.

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

parkedCallTimeout

Complex Type: inheritableDurationProperty

The value must conform to all of these criteria:

Is a value of at least 60.
Is a value that is a multiple of 60.

This property can be null.

Property type documentation:

Represents an inherited duration property.

parkedChatExtension

Complex Type: inheritableStringProperty

The value must conform to all of these criteria:

Is a value representing an existing Extension of an appropriate type for the setting.

This property can be null.

Property type documentation:

Represents an inherited string property.

parkedChatTimeout

Complex Type: inheritableDurationProperty

The value must conform to all of these criteria:

Is a value of at least 60.
Is a value that is a multiple of 60.

This property can be null.

Property type documentation:

Represents an inherited duration property.

parkedEmailExtension

Complex Type: inheritableStringProperty

The value must conform to all of these criteria:

Is a value representing an existing Extension of an appropriate type for the setting.

This property can be null.

Property type documentation:

Represents an inherited string property.

parkedEmailTimeout

Complex Type: inheritableDurationProperty

The value must conform to all of these criteria:

Is a value of at least 60.
Is a value that is a multiple of 60.

This property can be null.

Property type documentation:

Represents an inherited duration property.

parkedGenericObjectExtension

Complex Type: inheritableStringProperty

The value must conform to all of these criteria:

Is a value representing an existing Extension of an appropriate type for the setting.

This property can be null.

Property type documentation:

Represents an inherited string property.

parkedGenericObjectTimeout

Complex Type: inheritableDurationProperty

The value must conform to all of these criteria:

Is a value of at least 60.
Is a value that is a multiple of 60.

This property can be null.

Property type documentation:

Represents an inherited duration property.

playToExternalPartiesOnly

Boolean

Setting this property to null will set it to its default value.

Default value: false

preferredLanguage

Complex Type: idDisplayName

Language identifier defined in RFC 3066. The value must conform to all of these criteria:

Is a value referring to an existing configured item.

This property can be null.

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 object.

displayName

String

The display name of this object.

This property can be null.

queueType

Enumeration: workgroupQueueType

Setting this property to null will set it to its default value.

Default value: 5

None

Custom

GroupRing

Sequential

RoundRobin

ACD

recordAll

Boolean

Setting this property to null will set it to its default value.

Default value: false

revertToAvailableTimeout

Int

The value must conform to all of these criteria:

Is a value from 0 to 10000.

Setting this property to null will set it to its default value.

Default value: 0

roles

List [Unbounded]: Complex Type: configurationId

Is a collection of items that each conform to all of these criteria:

An instance of the Role object type.

This property can be null.

Property type documentation:

Represents a collection of configurationId's.

List item type documentation:

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

secureInputForms

List [Unbounded]: Complex Type: configurationId

Is a collection of items that each conform to all of these criteria:

An instance of the Secure Input Form object type.

This property can be null.

Property type documentation:

Represents a collection of configurationId's.

List item type documentation:

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

securityRights

Complex Type: securityRightsProperties

The collection of properties that make up the security rights for a User, Role, Workgroup, or the Default User.

This property can be null.

Property type documentation:

This is not a property of them. 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 securityRights.memberName. For example, securityRights.mobileOfficeUser will return the objects's mobile office security right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.

accessAllInteractionConferences

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

accessOwnedInteractionConferences

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

accountCodeVerification

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

addIndividuals

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

addOrganizations

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

agentPreferences

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowAccessToProblemReporter

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowAgentRules

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowAgentScheduleBidding

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowAgentSeeOwnRank

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowAgentSeeRelativeRank

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowAlertProgramming

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowEmailAccessViaTui

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowEmailAlerts

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowFaxAccessViaTui

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowHandlerAlerts

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowIntercomChat

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowMemoAlerts

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowMiniMode

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowMonitorColumns

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowMultipleCalls

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowPersistentConnections

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowReceiveVoicemail

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowRelatedInteractionsPage

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowResponseManagement

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowSpeedDials

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowStatusNotes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowUserDefinedTelephoneNumberOnRemoteLogin

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowVideo

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowVoiceMaiAccessViaTui

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

allowWorkgroupStats

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

botsConfigurationMaster

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	18

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canAccessOptimizerShiftTrading

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	5

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCoachInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canConferenceCalls

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateEmailAttendantProfile

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateInboundAttendantProfile

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateOperatorAttendantProfile

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateOptimizerActivityCodes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateOptimizerDayClassifications

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateOutboundAttendantProfile

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateQuestionnaireDirectories

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canCreateSchedulingUnits

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canDeleteOptimizerActivityCodes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canDeleteOptimizerDayClassifications

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canDeleteSchedulingUnits

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canDisconnectInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canInitiateRecordingSnippet

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	11

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canInitiateSecureInput

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canJoinInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canListenInOnInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canManageClientTemplates

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canModifyOptimizerActivityCodes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canModifyOptimizerDayClassifications

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canModifyOptimizerStatusActivityTypeMapping

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canMuteInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canOrbitQueue

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canOverrideFinishedScorecards

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canParkInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canPauseInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canPickupInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canPublishProcess

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canPutInteractionsOnHold

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canRecordInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canRequestAssistanceFromSupervisor

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canSecureRecordingPauseInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canSubmitTimeOff

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canTransferInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canTransferInteractionsToVoicemail

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canUserInteractionRecorderSelector

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canViewOptimizerActivityCodes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canViewOptimizerDayClassifications

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

canViewOptimizerStatusActivityTypeMapping

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

cloudWorkforceEngagementAdministrator

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

customizeClient

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

dataExtractorJobAdmin

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	15

This property can be null.

Property type documentation:

Represents an inherited boolean property.

debugHandlers

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

deleteIndividuals

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

deleteOrganizations

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

directoryAdmin

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

followMe

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

havePrivateContacts

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

interactionRecorderMasterKeyPasswordAdministrator

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

iPPhoneProvisioningAdmin

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

lockPolicySets

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

loginCampaign

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

manageHandlers

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

mobileOfficeUser

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyConfigurationChangeAuditing

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyConfigurationGeneral

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyConfigurationHTTPServer

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyConfigurationOutboundServers

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyConfigurationPhoneNumberTypes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyConfigurationPreviewCallBehavior

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyIndividuals

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

modifyOrganizations

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

outlookTuiUser

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

privateCalls

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

publishHandlers

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

remoteControl

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

reporterAdministrator

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

requireForcedAuthorizationCode

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

runContactListPredefinedActions

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	5

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showAssistanceButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showCoachButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showDisconnectButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showHoldButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showJoinButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showListenButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showMuteButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showParkButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showPauseButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showPickupButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showPrivateButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showRecordButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showRecordingSnippetButton

Complex Type: inheritableBooleanProperty

Feature	Version	Obsolete Version
configuration	11

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showSecureInputButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showSecureRecordingPauseButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showTransferButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showVoicemailButton

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

showWorkgroupsProfilesTab

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

traceConfiguration

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

trackerAdministrator

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

useTiffForFaxes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewConfigurationChangeAuditing

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewConfigurationGeneral

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewConfigurationHTTPServer

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewConfigurationOutboundServers

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewConfigurationPhoneNumberTypes

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewConfigurationPreviewCallBehavior

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewInteractionDetails

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyCampaignAgentlessCallingType

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyCampaignAutomaticTimeZoneMapping

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyCampaignLineSettings

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyCampaignMaxLines

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyCampaignStatus

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyContactListDataQuery

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyCustomHandlerActions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyDatabaseConnections

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyDncSources

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyEventLog

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewModifyTimeZoneMapData

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

viewOtherPeoplesPrivateInteractions

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

widgetsConfigurationMaster

Complex Type: inheritableBooleanProperty

This property can be null.

Property type documentation:

Represents an inherited boolean property.

selectedTone

Complex Type: configurationId

The value must conform to all of these criteria:

An instance of the Recording Beep Tone object type.

Setting this property to null will set it to its default value.

Default value: <Default>

Property type documentation:

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

skills

List [Unbounded]: Complex Type: skillSetting

This property can be null.

Property type documentation:

Represents a set of skill settings.

List item type documentation:

Represents a skill setting.

Complex Type: configurationId

Required

Property type documentation:

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

proficiency

Int

Required

desireToUse

Int

Required

socialConversationServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Feature	Version	Obsolete Version
configuration	14

Setting this property to null will set it to its default value.

Default value: [300, 600, 1200, 1800, 3600, 7200, 14400, 28800]

Property type documentation:

Represents a collection of durations.

socialConversationServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Feature	Version	Obsolete Version
configuration	14

Setting this property to null will set it to its default value.

Default value: 14400

socialDirectMessageServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Feature	Version	Obsolete Version
configuration	14

Setting this property to null will set it to its default value.

Default value: [10, 20, 30, 45, 60, 90, 120, 240]

Property type documentation:

Represents a collection of durations.

socialDirectMessageServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Feature	Version	Obsolete Version
configuration	14

Setting this property to null will set it to its default value.

Default value: 14400

statisticParameterGroup

Complex Type: configurationId

The value must conform to all of these criteria:

An instance of the Statistic Parameter Group object type.

This property can be null.

Property type documentation:

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

statisticsShiftStarts

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a value from 0 to 86340.

Setting this property to null will set it to its default value.

Default value: 0:00

Property type documentation:

Represents a collection of durations.

supervisors

List [Unbounded]: Complex Type: configurationId

Is a collection of items that each conform to all of these criteria:

An instance of the User object type.

This property can be null.

Property type documentation:

Represents a collection of configurationId's.

List item type documentation:

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

useRecordingTones

Boolean

Setting this property to null will set it to its default value.

Default value: false

useTiffForFaxes

Boolean

Setting this property to null will set it to its default value.

Default value: false

utilizations

List [Unbounded]: Complex Type: utilizationSetting

Setting this property to null will set it to its default value.

Default value: [{mediaType: 1, utilization: 100, maxAssignable: 1}, {mediaType: 2, utilization: 100, maxAssignable: 0}, {mediaType: 3, utilization: 100, maxAssignable: 0}, {mediaType: 4, utilization: 100, maxAssignable: 0}, {mediaType: 5, utilization: 100, maxAssignable: 0}, {mediaType: 7, utilization: 100, maxAssignable: 0}, {mediaType: 8, utilization: 100, maxAssignable: 0}]

Property type documentation:

Represents a set of utilization settings.

List item type documentation:

Represents a utilization setting.

mediaType

Enumeration: mediaType

Required

invalid

call

chat

generic

callback

workItem

socialDirectMessage

Feature	Version	Obsolete Version
configuration	14

socialConversation

Feature	Version	Obsolete Version
configuration	14

utilization

Int

Required

maxAssignable

Int

Required

voicemailMessage

String

This property can be null.

workgroupMailboxProperties

Complex Type: workgroupMailboxProperties

Represents the mailbox properties on a workgroup. To help configure a workgroup's mailbox, several resources are provided that generate the values for the other properties as required by the mailbox type. For more information, please see Mail Configuration.

This property can be null.

Property type documentation:

This is not a workgroup property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of it's members, use the form workgroupMailboxProperties.memberName. For example, workgroupMailboxProperties.directoryMoniker will return the workgroup's directory moniker. Alternatively, one can use the '*' wildcard to select all properties of the workgroup including these.

displayName

String

This property can be null.

emailAddress

String

This property can be null.

type

Enumeration: mailboxType

Setting this property to null will set it to its default value.

Default value: 0

none

interactionMessageStore

imapSmtp

genericProvider

workItemServiceLevelDistribution

List [Unbounded]: Duration

Is a collection of items that each conform to all of these criteria:

Is a collection containing 1 to 14 items.
Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: [30, 60, 900, 1800, 3600, 14400, 86400, 172800]

Property type documentation:

Represents a collection of durations.

workItemServiceLevelTarget

Duration

The value must conform to all of these criteria:

Is a value from 0 to 604800.

Setting this property to null will set it to its default value.

Default value: 14400

wrapUpCodes

List [Unbounded]: Complex Type: configurationId

When a code label is available the display name of the WrapUp code will be replaced with the value of the code label. Is a collection of items that each conform to all of these criteria:

An instance of the Wrap Up Code object type.

This property can be null.

Property type documentation:

Represents a collection of configurationId's.

List item type documentation:

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

wrapUpPrompt

String

This property can be null.

wrapUpStatus

Complex Type: configurationId

The value must conform to all of these criteria:

Is a configuration ID reference to an existing instance in the server's 'StatusMessage' collection, where 'i3config::attribute::after_call_work' is 'true'.
Both the values of wrapUpStatus and wrapUpTimeout needs both to be null or not null.

This property can be null.

Property type documentation:

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

wrapUpTimeout

Int

The value must conform to all of these criteria:

Is a value of at least 1.
Both the values of wrapUpStatus and wrapUpTimeout needs both to be null or not null.

This property can be null.

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.

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.

Parameters

Representations

200 - OK

Parameters

500 - Internal Server Error

Parameters

Error Responses

400 - Bad Request

Parameters

401 - Unauthorized

Parameters

410 - Gone

Parameters