Coverage of IceLib APIs

The Interaction Center Extension Library (IceLib for short) is a .NET-based programming API that allows developers to create custom applications that leverage the Interaction Center to solve business problems. IceLib is for developers who use modern .NET languages, such as C# or VB.NET.

For developers that have used IceLib, it is helpful to understand how those API features are covered in ICWS APIs. That API coverage is detailed here, describing each IceLib element and how it maps to ICWS.

If the ICWS Support column is blank, then ICWS does not yet contain support for the equivalent of the IceLib feature. If that column is not blank, then it contains information about which ICWS feature version initially contained the equivalent of the IceLib feature. For more information about versioning, see Versioning.

This topic contains the following sections:

ININ.IceLib.Configuration

FeatureIceLib APIICWS SupportICWS API
Configuration Object SupportSee separate Configuration Object table below.
Get enabled mailbox typesININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetEnabledMailboxTypesFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/enabled-mailbox-providers
Get IMAP serversININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetImapServersFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/imap-servers
Get Interaction Message Store usersININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetInteractionMessageStoreMailboxesFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/interaction-message-store-mailbox-attributes
List mailbox foldersININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetMailboxFoldersFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/folders
Get searchable mailbox directoriesININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetSearchableDirectoriesFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/searchable-providers
Open mailboxININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.OpenMailboxFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/test-mailbox
Search mailbox directoriesININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.SearchDirectoriesFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/directories
Send an emailININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.SendEmailFeature: configuration
Version: 1
POST /icws/{sessionId}/configuration/mail/send-email
Test a mailbox monikerININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.TestMonikerFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/mail/test-moniker
Check to see if Access Control Groups are in useININ.IceLib.Configuration.DataTypes.AccessControlGroup.AreAccessControlGroupsInUseFeature: configuration
Version: 1
GET /icws/{sessionId}/configuration/access-control-groups/are-in-use
Assign Users to an Access Control GroupININ.IceLib.Configuration.DataTypes.AccessControlGroup.AssignToAccessControlGroupFeature: configuration
Version: 1
POST /icws/{sessionId}/configuration/access-control-groups/{id}/{objectType}/assign-membership
Get Access Control Groups for a User, for a specific Object TypeININ.IceLib.Configuration.DataTypes.AccessControlGroup.GetAccessControlGroupsForObjectTypeFeature: configuration
Version: 1

GET /icws/{sessionId}/configuration/access-control-groups/assignable/{objectType}

Get list of supported Analyzer keyword languagesININ.IceLib.Configuration.AnalyzerKeywordConfiguration.GetSupportedAnalyzerLanguagesFeature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-analyzer/supported-languages

Get Keyword accuracyININ.IceLib.Configuration.AnalyzerKeywordSetConfigurationList.GetKeywordAccuracyFeature: configuration
Version: 1

GET /icws/{sessionId}/configuration/keyword-sets/preview-keyword-runtime

Get Keyword count informationININ.IceLib.Configuration.AnalyzerKeywordSetConfigurationList.GetKeywordCountInformation
Publish Client Templates to Users, Roles and Workgroups

ININ.IceLib.Configuration.RoleConfiguration.PublishClientTemplate

ININ.IceLib.Configuration.UserConfiguration.PublishClientTemplate

ININ.IceLib.Configuration.WorkgroupConfiguration.PublishClientTemplate

Determine if Dialer is enabled

ININ.IceLib.Configuration.ServerParameterConfigurationList.IsDialerEnabled

Get supported System languages

ININ.IceLib.Configuration.SystemConfiguration.GetSupportedLanguages

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/system/languages

Get time zones

ININ.IceLib.Configuration.SystemConfiguration.GetTimeZones

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/system/time-zones

Get a list of IVR Handler names

ININ.IceLib.Configuration.SecureInputFormConfiguration.GetIvrHandlers

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/system/ivr-handlers

Being a Configuration Transaction

ININ.IceLib.Configuration.ConfigurationManager.BeginTransaction

POST /icws/{sessionId}/configuration/transaction

End a Configuration Transaction

ININ.IceLib.Configuration.ConfigurationManager.EndTransaction

POST /icws/{sessionId}/configuration/transaction/{transactionId}/transaction-end

ININ.IceLib.Configuration Objects

Note

All objects can be queried. Queries can be constructed to retrieve specific properties (or all properties), filter on specific properties (except for Singleton-type objects), specify result limit (except for Singleton-type objects), and specify rights to apply. The following explains the other capabilities of configuration objects:

  • Read-Only: The object cannot be edited.
  • Editable: The object can be edited and committed back to the IC Server. New objects can be added, and existing objects can be deleted.
    • Object add and delete actions are not valid for Singleton-type objects.
  • Watchable: Can receive change notifications for when a property value changes and can receive remove notifications on system deletes.
    • Notifications for newly added objects are not supported. Change notifications are not based on user rights that were specified in the watch. Object add and delete notifications are not valid for Singleton-type objects.
    • See Event Subscriptions and Messaging for information on how to work with subscriptions.

Configuration ObjectIceLib APIICWS SupportICWS API
List-based Objects
AccessControlGroupConfiguration

ININ.IceLib.Configuration.AccessControlGroupConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/access-control-groups

PUT /icws/{sessionId}/messaging/subscriptions/configuration/access-control-groups/{subscriptionId}

Capabilities:
Editable, Watchable

AccountCodeConfiguration

ININ.IceLib.Configuration.AccountCodeConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/account-codes

PUT /icws/{sessionId}/messaging/subscriptions/configuration/account-codes/{subscriptionId}

Capabilities:
Editable, Watchable

AccumulatorConfiguration

ININ.IceLib.Configuration.AccumulatorConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/accumulators

Capabilities:
Read-Only, Not Watchable

ActionConfiguration

ININ.IceLib.Configuration.ActionConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/actions

PUT /icws/{sessionId}/messaging/subscriptions/configuration/actions/{subscriptionId}

Capabilities:
Editable, Watchable

AnalyzerKeywordConfiguration

ININ.IceLib.Configuration.AnalyzerKeywordConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/keyword-sets

PUT /icws/{sessionId}/messaging/subscriptions/configuration/keyword-sets/{subscriptionId}

Capabilities:
Editable, Watchable

AnalyzerKeywordSetConfiguration

ININ.IceLib.Configuration.AnalyzerKeywordSetConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/keyword-sets

PUT /icws/{sessionId}/messaging/subscriptions/configuration/keyword-sets/{subscriptionId}

Capabilities:
Editable, Watchable

AttendantEmailProfileConfiguration

ININ.IceLib.Configuration.AttendantEmailProfileConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/attendant-email-profiles

Capabilities:
Read-Only, Not Watchable

AttendantInboundProfileConfiguration

ININ.IceLib.Configuration.AttendantInboundProfileConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/attendant-inbound-profiles

Capabilities:
Read-Only, Not Watchable

AttendantOperatorProfileConfiguration

ININ.IceLib.Configuration.AttendantOperatorProfileConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/attendant-operator-profiles

Capabilities:
Read-Only, Not Watchable

AttendantOutboundProfileConfiguration

ININ.IceLib.Configuration.AttendantOutboundProfileConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/attendant-outbound-profiles

Capabilities:
Read-Only, Not Watchable

AudioSourceConfiguration

ININ.IceLib.Configuration.AudioSourceConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/audio-sources

PUT /icws/{sessionId}/messaging/subscriptions/configuration/audio-sources/{subscriptionId}

Capabilities:
Editable, Watchable

ClientConfigurationTemplateConfiguration

ININ.IceLib.Configuration.ClientConfigurationTemplateConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/client-configuration-templates

PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-configuration-templates/{subscriptionId}

Capabilities:
Editable, Watchable

ClientTemplateConfiguration

ININ.IceLib.Configuration.ClientTemplateConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/client-templates

PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-templates/{subscriptionId}

Capabilities:
Editable, Watchable

ContactListSourceConfiguration

ININ.IceLib.Configuration.ContactListSourceConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/contact-list-sources

Capabilities:
Read-Only, Not Watchable

Integrations.Salesforce.CtiAttributeMapConfiguration

ININ.IceLib.Configuration.Integrations.Salesforce.CtiAttributeMapConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

POST /icws/{sessionId}/configuration/salesforce-cti-configurations/{id}/salesforce-cti-attribute-maps

PUT /icws/{sessionId}/messaging/subscriptions/configuration/salesforce-cti-configurations/{subscriptionId}

Capabilities:
Editable, Watchable

Integrations.Salesforce.CtiConfiguration

ININ.IceLib.Configuration.Integrations.Salesforce.CtiConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/salesforce-cti-configurations

PUT /icws/{sessionId}/messaging/subscriptions/configuration/salesforce-cti-configurations/{subscriptionId}

Capabilities:
Editable, Watchable

CustomButtonConfiguration

ININ.IceLib.Configuration.CustomButtonConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/client-buttons

PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-buttons/{subscriptionId}

Capabilities:
Editable, Watchable

EFaq.EFaqConfiguration

ININ.IceLib.Configuration.EFaq.EFaqConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/e-faqs

Capabilities:
Read-Only, Not Watchable

FaxGroupConfiguration

ININ.IceLib.Configuration.FaxGroupConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/fax-groups

Capabilities:
Read-Only, Not Watchable

FeatureLicenseConfiguration

ININ.IceLib.Configuration.FeatureLicenseConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/feature-licenses

Capabilities:
Read-Only, Not Watchable

Feedback.FeedbackSurveyConfiguration

ININ.IceLib.Configuration.Feedback.FeedbackSurveyConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/feedback-surveys

Capabilities:
Read-Only, Not Watchable

Feedback.FeedbackSurveyGroupConfiguration

ININ.IceLib.Configuration.Feedback.FeedbackSurveyGroupConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/feedback-survey-groups

Capabilities:
Read-Only, Not Watchable

HandlerConfiguration

ININ.IceLib.Configuration.HandlerConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/handlers

Capabilities:
Read-Only, Not Watchable

Reporting.HistoricalReportConfiguration

ININ.IceLib.Configuration.Reporting.HistoricalReportConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/historical-reports

Capabilities:
Read-Only, Not Watchable

ICDataSourceConfiguration

ININ.IceLib.Configuration.ICDataSourceConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/ic-data-sources

Capabilities:
Editable, Not Watchable

Editability was added in the CTP version 7.

Watch support was added in public version 11.

ImageResourceCategoryConfiguration

ININ.IceLib.Configuration.ImageResourceCategoryConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/image-resource-categories

Capabilities:
Read-Only, Not Watchable

ImageResourceConfiguration

ININ.IceLib.Configuration.ImageResourceConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/image-resources

PUT /icws/{sessionId}/messaging/subscriptions/configuration/image-resources/{subscriptionId}

Capabilities:
Editable, Watchable

InitializationFunctionConfiguration

ININ.IceLib.Configuration.InitializationFunctionConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/initialization-functions

Capabilities:
Read-Only, Not Watchable

InteractionClientPluginConfiguration

ININ.IceLib.Configuration.InteractionClientPluginConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-client-plugins

Capabilities:
Read-Only, Not Watchable

InteractionConferenceRoomConfiguration

ININ.IceLib.Configuration.InteractionConferenceRoomConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-conference-rooms

Capabilities:
Read-Only, Not Watchable

InteractionProcessorTableConfiguration

ININ.IceLib.Configuration.InteractionProcessorTableConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-processor-tables

Capabilities:
Read-Only, Not Watchable

LayoutConfiguration

ININ.IceLib.Configuration.LayoutConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/layouts

PUT /icws/{sessionId}/messaging/subscriptions/configuration/layouts/{subscriptionId}

Capabilities:
Editable, Watchable

Reporting.LegacyHistoricalReportConfiguration

ININ.IceLib.Configuration.Reporting.LegacyHistoricalReportConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/legacy-historical-reports

Capabilities:
Read-Only, Not Watchable

LicenseAllocationConfiguration

ININ.IceLib.Configuration.LicenseAllocationConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/license-allocations

Capabilities:
Read-Only, Not Watchable

LineConfiguration

ININ.IceLib.Configuration.LineConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/lines

Capabilities:
Editable, Not Watchable

Editability was added in the CTP version 7.

Watch support was added in public version 11.

LineGroupConfiguration

ININ.IceLib.Configuration.LineGroupConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/line-groups

Capabilities:
Editable, Not Watchable

Editability was added in the CTP version 8.

Watch support was added in public version 11.

LocationConfiguration

ININ.IceLib.Configuration.LocationConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/locations

Capabilities:
Read-Only, Create, Not Watchable

Create was added in the CTP version 7, and public version 11.

MiscellaneousItemConfiguration

ININ.IceLib.Configuration.MiscellaneousItemConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/miscellaneous-items

Capabilities:
Read-Only, Not Watchable

OCS.OfficeCommunicationServerActiveDirectoryConfiguration

ININ.IceLib.Configuration.OCS.OfficeCommunicationServerActiveDirectoryConfigurationConfiguration

Capabilities:
Read-Only, Watchable

OCS.OfficeCommunicationServerStatusMessageConfiguration

ININ.IceLib.Configuration.OCS.OfficeCommunicationServerStatusMessageConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Optimizer.OptimizerSchedulingUnitConfiguration

ININ.IceLib.Configuration.Optimizer.OptimizerSchedulingUnitConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-optimizer-scheduling-units

Capabilities:
Read-Only, Not Watchable

PagingCarrierConfiguration

ININ.IceLib.Configuration.PagingCarrierConfigurationConfiguration

Capabilities:
Read-Only, Watchable

PasswordPolicyConfiguration

ININ.IceLib.Configuration.PasswordPolicyConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/password-policies

PUT /icws/{sessionId}/messaging/subscriptions/configuration/password-policies/{subscriptionId}

Capabilities:
Editable, Watchable

PhoneNumberClassificationConfiguration

ININ.IceLib.Configuration.PhoneNumberClassificationConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/dial-plan-classifications

PUT /icws/{sessionId}/messaging/subscriptions/configuration/dial-plan-classifications/{subscriptionId}

Capabilities:
Read-Only, Watchable

PositionConfiguration

ININ.IceLib.Configuration.PositionConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/positions

PUT /icws/{sessionId}/messaging/subscriptions/configuration/positions/{subscriptionId}

Capabilities:
Editable, Watchable

ProcessAutomation.ProcessConfiguration

ININ.IceLib.Configuration.ProcessAutomation.ProcessConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-process-automation-processes

Capabilities:
Read-Only, Not Watchable

QueueColumnConfiguration

ININ.IceLib.Configuration.QueueColumnConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/queue-columns

PUT /icws/{sessionId}/messaging/subscriptions/configuration/queue-columns/{subscriptionId}

Capabilities:
Editable, Watchable

Recorder.RecorderQuestionnaireConfiguration

ININ.IceLib.Configuration.Recorder.RecorderQuestionnaireConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-recorder-questionnaires

Capabilities:
Read-Only, Not Watchable

ReportLogConfiguration

ININ.IceLib.Configuration.ReportLogConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/report-logs

Capabilities:
Read-Only, Not Watchable

RecordingBeepToneConfiguration

ININ.IceLib.Configuration.RecordingBeepToneConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/recording-beep-tones

PUT /icws/{sessionId}/messaging/subscriptions/configuration/recording-beep-tones/{subscriptionId}

Capabilities:
Editable, Watchable

ResponseManagementDocumentConfiguration

ININ.IceLib.Configuration.ResponseManagementDocumentConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/response-management-documents

PUT /icws/{sessionId}/messaging/subscriptions/configuration/response-management-documents/{subscriptionId}

Capabilities:
Editable, Watchable

RoleConfiguration

ININ.IceLib.Configuration.RoleConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/roles

PUT /icws/{sessionId}/messaging/subscriptions/configuration/roles/{subscriptionId}

Capabilities:
Editable, Watchable

ScheduleConfiguration

ININ.IceLib.Configuration.ScheduleConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/schedules

PUT /icws/{sessionId}/messaging/subscriptions/configuration/schedules/{subscriptionId}

Capabilities:
Editable, Watchable

ScheduleRecurrenceConfiguration

ININ.IceLib.Configuration.ScheduleRecurrenceConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/schedules

PUT /icws/{sessionId}/messaging/subscriptions/configuration/schedules/{subscriptionId}

Capabilities:
Editable, Watchable

SelectionRuleConfiguration

ININ.IceLib.Configuration.SelectionRuleConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/selection-rules

Capabilities:
Read-Only, Not Watchable

ServerParameterConfiguration

ININ.IceLib.Configuration.ServerParameterConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/server-parameters

PUT /icws/{sessionId}/messaging/subscriptions/configuration/server-parameters/{subscriptionId}

Capabilities:
Editable, Watchable

SipBridgeConfiguration

ININ.IceLib.Configuration.SipBridgeConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/sip-bridges

Capabilities:
Read-Only, Not Watchable

SingleSignOnIdentityProviderConfiguration

ININ.IceLib.Configuration.SingleSignOnIdentityProviderConfigurationConfiguration

Capabilities:
Read-Only, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/single-sign-on-identity-providers

Capabilities:
Read-Only, Not Watchable

SiteConfiguration

ININ.IceLib.Configuration.SiteConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/peer-sites

Capabilities:
Read-Only, Not Watchable

SecureInputFormConfiguration

ININ.IceLib.Configuration.SecureInputFormConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/secure-input-forms

PUT /icws/{sessionId}/messaging/subscriptions/configuration/secure-input-forms/{subscriptionId}

Capabilities:
Editable, Watchable

SkillConfiguration

ININ.IceLib.Configuration.SkillConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/skills

PUT /icws/{sessionId}/messaging/subscriptions/configuration/skills/{subscriptionId}

Capabilities:
Editable, Watchable

SmsBrokerConfiguration

ININ.IceLib.Configuration.SmsBrokerConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/sms-brokers

Capabilities:
Read-Only, Not Watchable

StationConfiguration

ININ.IceLib.Configuration.StationConfigurationConfiguration

Capabilities:
Editable, Watchable

StationGroupConfiguration

ININ.IceLib.Configuration.StationGroupConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/station-groups

Capabilities:
Read-Only, Not Watchable

StationTemplateConfiguration

ININ.IceLib.Configuration.StationTemplateConfigurationConfiguration

Capabilities:
Editable, Watchable

StatusColumnConfiguration

ININ.IceLib.Configuration.StatusColumnConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/status-columns

Capabilities:
Read-Only, Not Watchable

StatusMessageConfiguration

ININ.IceLib.Configuration.StatusMessageConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/status-messages

Capabilities:
Editable, Not Watchable

Editiability was added in CTP version 10.

StructuredParameterConfiguration

ININ.IceLib.Configuration.StructuredParameterConfigurationConfiguration

Capabilities:
Editable, Not Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/structured-parameters

PUT /icws/{sessionId}/messaging/subscriptions/configuration/structured-parameters/{subscriptionId}

Capabilities:
Editable, Watchable

SystemParameterConfiguration

ININ.IceLib.Configuration.SystemParameterConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/system-parameters

PUT /icws/{sessionId}/messaging/subscriptions/configuration/system-parameters/{subscriptionId}

Capabilities:
Editable, Watchable

UserConfiguration

ININ.IceLib.Configuration.UserConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/users

PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId}

Capabilities:
Editable, Watchable

VoiceModuleConfiguration

ININ.IceLib.Configuration.VoiceModuleConfigurationConfiguration

Capabilities:
Read-Only, Watchable

WebServicesParameterConfiguration

ININ.IceLib.Configuration.WebServicesParameterConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/web-services-parameters

Capabilities:
Read-Only, Not Watchable

WorkgroupConfiguration

ININ.IceLib.Configuration.WorkgroupConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/workgroups

PUT /icws/{sessionId}/messaging/subscriptions/configuration/workgroups/{subscriptionId}

Capabilities:
Editable, Watchable

WorkgroupMonitoredMailboxConfiguration

ININ.IceLib.Configuration.WorkgroupMonitoredMailboxConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

POST /icws/{sessionId}/configuration/workgroups/{id}/monitored-mailboxes

Capabilities:
Editable, Not Watchable

WrapUpCategoryConfiguration

ININ.IceLib.Configuration.WrapUpCategoryConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/wrap-up-categories

PUT /icws/{sessionId}/messaging/subscriptions/configuration/wrap-up-categories/{subscriptionId}

Capabilities:
Editable, Watchable

WrapUpCodeConfiguration

ININ.IceLib.Configuration.WrapUpCodeConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/wrap-up-codes

PUT /icws/{sessionId}/messaging/subscriptions/configuration/wrap-up-codes/{subscriptionId}

Capabilities:
Editable, Watchable

Reporting.ReportCategoryConfiguration

ININ.IceLib.Configuration.Reporting.ReportCategoryConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportCustomDataConfiguration

ININ.IceLib.Configuration.Reporting.ReportCustomDataConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportFlexibleColumnConfiguration

ININ.IceLib.Configuration.Reporting.ReportFlexibleColumnConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportMasterConfiguration

ININ.IceLib.Configuration.Reporting.ReportMasterConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportParameterConfiguration

ININ.IceLib.Configuration.Reporting.ReportParameterConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportSectionConfiguration

ININ.IceLib.Configuration.Reporting.ReportSectionConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportSystemSettingConfiguration

ININ.IceLib.Configuration.Reporting.ReportSystemSettingConfigurationConfiguration

Capabilities:
Editable, Watchable

Reporting.ReportTableConfiguration

ININ.IceLib.Configuration.Reporting.ReportTableConfigurationConfiguration

Capabilities:
Editable, Watchable

Internal List-based Objects
Dialer.Internal.DialerCallListAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerCallListAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-call-list-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerCampaignAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerCampaignAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-campaign-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerPolicySetAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerPolicySetAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-policy-set-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerRuleSetAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerRuleSetAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-rule-set-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerScheduleAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerScheduleAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-schedule-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerScriptAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerScriptAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-script-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerSkillSetAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerSkillSetAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-skill-set-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerStageSetAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerStageSetAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-stage-set-acls

Capabilities:
Read-Only, Not Watchable

Dialer.Internal.DialerZoneSetAclConfiguration

ININ.IceLib.Configuration.Dialer.Internal.DialerZoneSetAclConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-dialer-zone-set-acls

Capabilities:
Read-Only, Not Watchable

ManagedPhoneConfiguration

ININ.IceLib.Configuration.ManagedPhoneConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedPhoneRegistrationGroupConfiguration

ININ.IceLib.Configuration.ManagedPhoneRegistrationGroupConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedPhoneRingSetConfiguration

ININ.IceLib.Configuration.ManagedPhoneRingSetConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedPhoneTemplateConfiguration

ININ.IceLib.Configuration.ManagedPhoneTemplateConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedExternalRegistrationAppearanceConfiguration

ININ.IceLib.Configuration.ManagedExternalRegistrationAppearanceConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedSharedStationAppearanceConfiguration

ININ.IceLib.Configuration.ManagedSharedStationAppearanceConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedSharedStationTemplateAppearanceConfiguration

ININ.IceLib.Configuration.ManagedSharedStationTemplateAppearanceConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedStationAppearanceConfiguration

ININ.IceLib.Configuration.ManagedStationAppearanceConfigurationConfiguration

Capabilities:
Editable, Watchable

ManagedStationTemplateAppearanceConfiguration

ININ.IceLib.Configuration.ManagedStationTemplateAppearanceConfigurationConfiguration

Capabilities:
Editable, Watchable

SkillCategoryConfiguration

ININ.IceLib.Configuration.SkillCategoryConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 11
Status: Completed

GET /icws/{sessionId}/configuration/skill-categories

PUT /icws/{sessionId}/messaging/subscriptions/configuration/skill-categories/{subscriptionId}

Capabilities:
Editable, Watchable

StatisticGroupConfiguration

ININ.IceLib.Configuration.StatisticGroupConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 11
Status: Completed

GET /icws/{sessionId}/configuration/statistic-parameter-groups

PUT /icws/{sessionId}/messaging/subscriptions/configuration/statistic-parameter-groups/{subscriptionId}

Capabilities:
Editable, Watchable

Singleton Objects
AccountCodesConfiguration

ININ.IceLib.Configuration.AccountCodesConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/account-codes-configuration

PUT /icws/{sessionId}/messaging/subscriptions/configuration/account-codes-configuration/{subscriptionId}

Capabilities:
Editable, Watchable

DefaultLocationConfiguration

ININ.IceLib.Configuration.DefaultLocationConfigurationConfiguration

Capabilities:
Read-Only, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/default-location

Capabilities:
Read-Only, Not Watchable

DefaultStationConfiguration

ININ.IceLib.Configuration.DefaultStationConfigurationConfiguration

Capabilities:
Editable, Watchable

DefaultUserConfiguration

ININ.IceLib.Configuration.DefaultUserConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/default-user

PUT /icws/{sessionId}/messaging/subscriptions/configuration/default-user/{subscriptionId}

Capabilities:
Editable, Watchable

DnisMappingsConfiguration

ININ.IceLib.Configuration.DnisMappingsConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/dnis-mappings

Capabilities:
Editable, Not Watchable

ProblemReporterConfiguration

ININ.IceLib.Configuration.ProblemReporterConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/problem-reporter

PUT /icws/{sessionId}/messaging/subscriptions/configuration/problem-reporter/{subscriptionId}

Capabilities:
Editable, Watchable

Recorder.RecorderConfiguration

ININ.IceLib.Configuration.Recorder.RecorderConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/interaction-recorder-configuration

PUT /icws/{sessionId}/messaging/subscriptions/configuration/interaction-recorder-configuration/{subscriptionId}

Capabilities:
Editable, Watchable

SystemConfiguration

ININ.IceLib.Configuration.SystemConfigurationConfiguration

Capabilities:
Editable, Watchable

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/system

PUT /icws/{sessionId}/messaging/subscriptions/configuration/system/{subscriptionId}

Capabilities:
Editable, Watchable

ININ.IceLib.Connection

FeatureIceLib APIICWS SupportICWS API
Can specify session-specific settings to use when connecting to an IC Server

ININ.IceLib.Connection.SessionSettings

Using SessionSettings, can set the Application Name, Machine Name, ISO Language, Class of Service, Device Type, Ready For Interactions flag and Custom Parameters.  Can set the Application Profile Name (for Custom Profiles), MarketPlace Application Code, and MarketPlace Application License Name.

Feature: connection
Version: 1

POST /icws/connection

Only Application Name, MarketPlace Application Code, and MarketPlace Application License Name values are supported.

Can specify custom parameters when connecting to an IC Server

ININ.IceLib.Connection.SessionSettings.CustomSettings

Connect to IC Server via Windows Authentication

ININ.IceLib.Connection.WindowsAuthSettings

Can request NTLM and/or Kerberos.

Feature: connection
Version: 3

POST /icws/connection

Performed using single sign-on with a built-in Identity Provider.

Connect to IC Server via Alternate Windows Authentication

ININ.IceLib.Connection.AlternateWindowsAuthSettings

Can request NTLM and/or Kerberos.

Feature: connection
Version: 3

POST /icws/connection

Performed using single sign-on with a built-in Identity Provider.

Connect to IC Server via IC Authentication

ININ.IceLib.Connection.ICAuthSettings

Feature: connection
Version: 1

POST /icws/connection

Connect to IC Server via Single-Sign-On

ININ.IceLib.Connection.SecurityTokenServiceAuthSettings

Feature: connection
Version: 3

POST /icws/connection

Connect to IC Server with a Workstation

ININ.IceLib.Connection.WorkstationSettings

Supports persistent logins, for use with applications such as Mobile Web Client.

Feature: connection
Version: 1

PUT /icws/{sessionId}/connection/station

Supply the appropriate workstationSettings object.

Connect to IC Server as Stationless

ININ.IceLib.Connection.StationlessSettings

Feature: connection
Version: 2

PUT /icws/{sessionId}/connection/station

This is the default state when first connecting. Can supply the appropriate stationlessSettings object to specify media types and ready for interactions.

Connect to IC Server with a Remote Number

ININ.IceLib.Connection.RemoteNumberSettings

Supports persistent logins, for use with applications such as Mobile Web Client.  Supports persistent connections, that keep a call open to the remote number while logged in.

Feature: connection
Version: 1

PUT /icws/{sessionId}/connection/station

Supply the appropriate remoteNumberSettings object.

Connect to IC Server with a Remote Workstation

ININ.IceLib.Connection.RemoteStationSettings

Supports persistent logins, for use with applications such as Mobile Web Client.

Feature: connection
Version: 1

PUT /icws/{sessionId}/connection/station

Supply the appropriate remoteWorkstationSettings object.

Retrieve allowed authentication modes

ININ.IceLib.Connection.Session.GetAllowableAuthentications

Used prior to connecting to the IC Server to determine if ICAuth, Windows Auth, Alternate Windows Auth, and/or Cached Credentials are allowed to be used.

Feature: connection
Version: 3

GET /icws/connection/server-info

There is no support for Cached Credentials.

Set and retrieve Common Credentials

ININ.IceLib.Connection.CommonCredentials

Receive a notification for when Connection State changes

ININ.IceLib.Connection.Session.ConnectionStateChanged

Feature: connection
Version: 1

POST /icws/connection

Check for connectionStateChangeMessage.

Receive a notification for when Station Settings change

ININ.IceLib.Connection.Session.StationSettingsChanged

Feature: connection
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/connection/station

Check for stationConnectionStateChangeMessage.

Receive a notification for when the Effective Station changes

ININ.IceLib.Connection.Session.EffectiveStationChanged

Only valid when connecting via Stationless.

Feature: connection
Version: 11

POST /icws/connection

Check for effectiveStationChangeMessage.

Auto-reconnect on dropped connection

ININ.IceLib.Connection.Session.AutoReconnectEnabled

Can turn this on or off.

Get and Set Additional UTC Offset

ININ.IceLib.Connection.Session.AdditionalUtcOffset

On the Session, commonly used for Web Applications.

Feature: connection
Version: 4

GET /icws/connection/server-time

ICWS uses UTC time for date time representations, but retrieving the server time is provided to allow ICWS-based clients to perform their own offset calculation if necessary.

Force an IC User to be logged out

ININ.IceLib.Connection.Session.ForceUserLogout

ININ.IceLib.Connection.Extensions

FeatureIceLib APIICWS SupportICWS API
Retrieve and set Custom profile settings

ININ.IceLib.Connection.Extensions.CustomProfile

Supports legacy custom profiles, and application-based custom profiles.

Watch and send Custom Notifications

ININ.IceLib.Connection.Extensions.CustomNotification

Feature: system
Version: 1

POST /icws/{sessionId}/system/handler-notification

PUT /icws/{sessionId}/messaging/subscriptions/system/handler-sent-notifications

Only supports sending notifications to custom handlers and subscribing to handler-sent notifications. Application notifications are not supported.

Watch Server Parameters

ININ.IceLib.Connection.Extensions.ServerParameters

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/server-parameters

PUT /icws/{sessionId}/messaging/subscriptions/configuration/server-parameters/{subscriptionId}

Submit Problem Reports

ININ.IceLib.Connection.Extensions.ProblemReporter

Connect to IC Server on behalf of a different Windows User

ININ.IceLib.Connection.Extensions.ProxyAlternateWindowsAuthSettings

Can request NTLM and/or Kerberos.

Connect to IC Server on behalf of a different IC User

ININ.IceLib.Connection.Extensions.ProxyAuthSettings

Connect to IC Server via Windows Authentication on behalf of a different IC User

ININ.IceLib.Connection.Extensions.ProxyWindowsAuthSettings

Can request NTLM and/or Kerberos.

Retrieve Password Policy

ININ.IceLib.Connection.Extensions.Security.GetPasswordPolicy

Change Password

ININ.IceLib.Connection.Extensions.Security.SetPassword

Feature: security
Version: 1

POST /icws/{sessionId}/security/password

Receive notifications when a password expires

ININ.IceLib.Connection.Extensions.Security.PasswordExpired

Feature: connection
Version: 3

POST /icws/connection

Check the daysUntilPasswordExpiration property on the response.

Receive notifications when a password is about to expire

ININ.IceLib.Connection.Extensions.Security.PasswordEnteredNagPeriod

Feature: connection
Version: 3

POST /icws/connection

response

Check the daysUntilPasswordExpiration property on the response.

Watch Sessions based on User

ININ.IceLib.Connection.Extensions.SessionWatch

Call StartWatching with an ININ.IceLib.Connection.Extensions.SessionWatchId object set to use ININ.IceLib.Connection.Extensions.SessionWatchType.User.

Feature: session
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/session/sessions-users

Check for sessionsMessage.

Watch Sessions based Station

ININ.IceLib.Connection.Extensions.SessionWatch

Call StartWatching with an ININ.IceLib.Connection.Extensions.SessionWatchId object set to use ININ.IceLib.Connection.Extensions.SessionWatchType.Station.

Feature: session
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/session/sessions-stations

Check for sessionsMessage.

Watch Sessions based Machine

ININ.IceLib.Connection.Extensions.SessionWatch

Call StartWatching with an ININ.IceLib.Connection.Extensions.SessionWatchId object set to use ININ.IceLib.Connection.Extensions.SessionWatchType.Machine.

ININ.IceLib.Directories

FeatureIceLib APIICWS SupportICWS API
Watch Directory Metadata

ININ.IceLib.Directories.DirectoryConfiguration.StartWatching

Feature: directories
Version: 4

PUT /icws/{sessionId}/messaging/subscriptions/directories

Check for directoriesMessage.

Watch Contact Directories

ININ.IceLib.Directories.ContactDirectory.StartWatching

Supports paged and non-pages watches.

Feature: directories
Version: 4

PUT /icws/{sessionId}/messaging/subscriptions/directories/{subscriptionId}

Check for directoryMessage. Paged watches are not supported.

Add, Edit and Delete Contacts

ININ.IceLib.Directories.ContactDirectory.CreateContactEntry

ININ.IceLib.Directories.ContactDirectory.UpdateContactEntry

ININ.IceLib.Directories.ContactDirectory.DeleteContactEntry

Receive notifications when the number of Contacts in a Directory changes

ININ.IceLib.Directories.DirectoryConfiguration.ContactCountChanged

Create, Edit, Delete Speed Dial Directories

ININ.IceLib.Directories.DirectoryConfiguration.CreateSpeedDialDirectory

ININ.IceLib.Directories.DirectoryConfiguration.RenameDirectory

ININ.IceLib.Directories.DirectoryConfiguration.DeleteDirectory

Create, Edit Speed Dial entries

ININ.IceLib.Directories.ContactDirectory.CreateSpeedDialLink

ININ.IceLib.Directories.ContactDirectory.UpdateSpeedDialLink

ININ.IceLib.Interactions

FeatureIceLib APIICWS SupportICWS API
Agents and Supervisors can create and watch Help requests.

ININ.IceLib.Interactions.AgentAssistanceList

ININ.IceLib.Interactions.SupervisorAssistanceList

This is the new help request mechanism that support 2-way chats.  The old way is still there, but it is marked obsolete.

Create Callback Interaction.

ININ.IceLib.Interactions.InteractionsManager.MakeCallbackInteraction

Feature: interactions
Version: 8

POST /icws/{sessionId}/interactions

Supply the appropriate createCallbackParameters object.

Set a Callback Interaction’s “completion” to success, failure or retry.

ININ.IceLib.Interactions.CallbackInteraction.SetCompletion

Feature: interactions
Version: 8

PUT /icws/{sessionId}/interactions/{interactionId}/callback/disposition

Create Call Interaction.

ININ.IceLib.Interactions.InteractionsManager.MakeCall

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions

Supply the appropriate createCallParameters object.

Play digits to a Call Interaction.

ININ.IceLib.Interactions.CallInteraction.PlayDigits

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/send-digits

Play/Stop WAV audio to a Call Interaction.

ININ.IceLib.Interactions.CallInteraction.PlayWaveAudio

ININ.IceLib.Interactions.CallInteraction.StopAllWaveAudio

Receive notification of when WAV audio play is complete.

ININ.IceLib.Interactions.CallInteraction.PlayWaveAudioComplete

Create Chat Interaction.

ININ.IceLib.Interactions.InteractionsManager.MakeChat

Receive notification when chat members are added/removed/updated.

ININ.IceLib.Interactions.ChatInteraction.ChatMemberAdded

ININ.IceLib.Interactions.ChatInteraction.ChatMemberChanged

ININ.IceLib.Interactions.ChatInteraction.ChangeMemberRemoved

Feature: interactions
Version: 6

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat

Check for chatMembersMessage.

Receive notification of a chat typing indicator.

ININ.IceLib.Interactions.ChatInteraction.TypingChanged

Feature: interactions
Version: 6

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat

Check for chatMembersMessage.

Receive notification of text and URL added to a chat.

ININ.IceLib.Interactions.ChatInteraction.TextAdded

ININ.IceLib.Interactions.ChatInteraction.UrlAdded

Feature: interactions
Version: 6

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat

Check for chatContentsMessage. No support for URLs.

Retrieve current chat members.

ININ.IceLib.Interactions.ChatInteraction.GetMembers

Feature: interactions
Version: 6

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat

The current chat members will come as part of the first chatMembersMessage notification. It is up to the ICWS consumer to track adds/changes/removes from that point forward.

Retrieve current chat history.

ININ.IceLib.Interactions.ChatInteraction.GetHistory

Feature: interactions
Version: 6

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat

The current chat history will come as part of the first chatContentsMessage notification. It is up to the ICWS consumer to track adds from that point forward.

Add members to a Chat Interaction via Interaction ID or User ID.

ININ.IceLib.Interactions.ChatInteraction.AddMembers

ININ.IceLib.Interactions.ChatInteraction.AddUsers

Set the chat typing indicator.

ININ.IceLib.Interactions.ChatInteraction.SetTypingIndicator

Feature: interactions
Version: 6

PUT /icws/{sessionId}/interactions/{interactionId}/chat/typing-indicator

Send chat text.

ININ.IceLib.Interactions.ChatInteraction.SendText

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/chat/messages

Send chat URL.

ININ.IceLib.Interactions.ChatInteraction.SendUrl

Send chat file.

ININ.IceLib.Interactions.ChatInteraction.SendFile

SendFile uploads a file to the IC Server before adding it to the chat; however, it doesn’t appear that a FileAdded notification is setup or working, even though SendFile was added in 4.0 SU 3.  This might be something Web Processor does not currently support.

Feature: interactions
Version: 10
Status: Completed

POST /icws/{sessionId}/interactions/{interactionId}/chat/send-file

Get a ConsultTransfer object from an existing Interaction.

ININ.IceLib.Interactions.ConsultTransfer.GetConsultTransferFromInteraction

Receive notification of when the speakers changed for a consult transfer.

ININ.IceLib.Interactions.ConsultTransfer.SpeakersChanged

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/consult

Check for consultMessage.

Cancel on a consult transfer.

ININ.IceLib.Interactions.ConsultTransfer.Cancel

Feature: interactions
Version: 6

DELETE /icws/{sessionId}/interactions/{interactionId}/consult/{consultId}

Conclude on a consult transfer.

ININ.IceLib.Interactions.ConsultTransfer.Conclue

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/consult/{consultId}/conclude

ChangeSpeakers on a consult transfer.

ININ.IceLib.Interactions.ConsultTransfer.ChangeSpeakers

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/consult/{consultId}/change-audience

Watch and retrieve the list of EFaq Servers.

ININ.IceLib.EFaq.EFaqServerList.StartWatching

Submit queries to an EFaq Server.

ININ.IceLib.EFaq.EFaqServer.Query

Create an Email Interaction.

ININ.IceLib.Interactions.InteractionsManager.MakeEmail

Create Email responses.

ININ.IceLib.Interactions.EmailInteraction.CreateResponse

Download email file and message attachments.

ININ.IceLib.Interactions.EmailInteraction.DownloadFileAttachment

ININ.IceLib.Interactions.EmailInteraction.DownloadMessageAttachment

Feature: interactions
Version: 10
Status: Completed

POST /icws/{sessionId}/interactions/{interactionId}/email/attachments/message/download

Receive notifications when an email is updated.

ININ.IceLib.Interactions.EmailInteraction.EmailContentUpdated

Save an email.

ININ.IceLib.Interactions.EmailInteraction.SaveEmail

Feature: interactions
Version: 10
Status: Completed

POST /icws/{sessionId}/interactions/{interactionId}/email/save

Update email file attachments.

ININ.IceLib.Interactions.EmailInteraction.UpdateFileAttachment

Feature: interactions
Version: 10
Status: Completed

POST /icws/{sessionId}/interactions/{interactionId}/email/attachments/file/upload

POST /icws/{sessionId}/interactions/{interactionId}/email/attachments/file/remove

Send an email.

ININ.IceLib.Interactions.EmailInteraction.SendEmail

Feature: interactions
Version: 10
Status: Completed

POST /icws/{sessionId}/interactions/{interactionId}/email/send

Resolve email address names.

ININ.IceLib.Interactions.EmailResolver.ResolveName

Feature: interactions
Version: 10
Status: Completed

POST /icws/{sessionId}/interactions/email/resolve-address

Watch an Interaction Queue.

ININ.IceLib.Interactions.InteractionQueue.StartWatching

Feature: interactions
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId}

Check for queueContentsMessage.

Get Interaction Queue contents snapshot.

ININ.IceLib.Interactions.InteractionQueue.GetContents

Receive notifications of lost rights to a queue.

ININ.IceLib.Interactions.InteractionQueue.LostRights

Receive notifications when queue notifications become suspended, or are resumed.

ININ.IceLib.Interactions.InteractionQueue.NotificationsSuspendedChanged

Change watched attributes for a queue.

ININ.IceLib.Interactions.InteractionQueue.ChangeWatchedAttributes

Feature: interactions
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId}

Create a Generic Interaction.

ININ.IceLib.Interactions.InteractionsManager.MakeGenericInteraction

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions

Supply the appropriate createGenericInteractionParameters object.

Watch an Interaction, change the watched attributes on an Interaction.

ININ.IceLib.Interactions.Interaction.StartWatching

ININ.IceLib.Interactions.Interaction.ChangeWatchedAttributes

These methods are available on all of the Interaction-derived objects. Additionally, to watch email interaction contents, a call to EmailStartWatching is needed.

Feature: interactions
Version: 8

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/callback

PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat

Check for interactionChangedMessage. Call, Callback, and Chat Interactions are the only currently supported types for an Interaction watch.

Retrieve String, String[], Boolean, DateTime and Integer attribute values from an Interaction.

The following retrieve attributes, causing a potential hit to the IC Server:

ININ.IceLib.Interactions.Interaction.GetBooleanAttribute

ININ.IceLib.Interactions.Interaction.GetDateTimeAttribute

ININ.IceLib.Interactions.Interaction.GetIntegerAttribute

ININ.IceLib.Interactions.Interaction.GetStringAttribute

ININ.IceLib.Interactions.Interaction.GetStringAttributes

The following retrieve attributes, only if they are watched:

ININ.IceLib.Interactions.Interaction.GetWatchedBooleanAttribute

ININ.IceLib.Interactions.Interaction.GetWatchedDateTimeAttribute

ININ.IceLib.Interactions.Interaction.GetWatchedIntegerAttribute

ININ.IceLib.Interactions.Interaction.GetWatchedStringAttribute

ININ.IceLib.Interactions.Interaction.GetWatchedStringAttributes

Additionally, there are many strongly-typed properties for well-known Interaction attributes.

Feature: interactions
Version: 1

GET /icws/{sessionId}/interactions/{interactionId}

Set String and DateTime attribute values on an Interaction.

ININ.IceLib.Interactions.Interaction.SetDateTimeAttribute

ININ.IceLib.Interactions.Interaction.SetStringAttribute

ININ.IceLib.Interactions.Interaction.SetStringAttributes

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}

Append a value to a string attribute on an Interaction.

ININ.IceLib.Interactions.Interaction.AppendStringAttribute

Default delimiter is “|”.

Pickup an Interaction

ININ.IceLib.Interactions.Interaction.Pickup

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/pickup

Disconnect an Interaction

ININ.IceLib.Interactions.Interaction.Disconnect

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/disconnect

Blind Transfer an Interaction

ININ.IceLib.Interactions.Interaction.BlindTransfer

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/blind-transfer

Transfer an Interaction to Voicemail

ININ.IceLib.Interactions.Interaction.TransferToVoicemail

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/transfer-to-voicemail

Send an Interaction to Voicemail

ININ.IceLib.Interactions.Interaction.Voicemail

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/send-to-voicemail

Park an Interaction

ININ.IceLib.Interactions.Interaction.Park

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/park

Listen to an Interaction

ININ.IceLib.Interactions.Interaction.Listen

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/listen

Coach an Interaction

ININ.IceLib.Interactions.Interaction.Coach

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/coach

Hold an Interaction

ININ.IceLib.Interactions.Interaction.Hold

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/hold

Mute an Interaction

ININ.IceLib.Interactions.Interaction.Mute

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/mute

Pause recording of an Interaction

ININ.IceLib.Interactions.Interaction.Pause

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/pause

Set an Interaction Private

ININ.IceLib.Interactions.Interaction.Private

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/make-private

Record/Pause Recording of an Interaction

ININ.IceLib.Interactions.Interaction.Record

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/record

Join an Interaction in a Conference

ININ.IceLib.Interactions.Interaction.Join

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/{interactionId}/join

Initiate Secure Input for an Interaction

ININ.IceLib.Interactions.Interaction.InitiateSecureInput

Initiate Secure Recording Pause for an Interaction

ININ.IceLib.Interactions.Interaction.SecureRecordingPause

Feature: interactions
Version: 8

POST /icws/{sessionId}/interactions/{interactionId}/secure-pause

Start or Stop a Recording Snippet for an Interaction

ININ.IceLib.Interactions.Interaction.InitiateRecordingSnip

Receive notifications on an Interaction when attributes change, it is de-allocated, rights to the Interaction are lost, or when an Interaction morphs.

ININ.IceLib.Interactions.Interaction.AttributesChanged

ININ.IceLib.Interactions.Interaction.Deallocated

ININ.IceLib.Interactions.Interaction.LostRights

ININ.IceLib.Interactions.Interaction.Morphed

Feature: interactions
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId}

Check for queueContentsMessage. This will contain added, removed, and changed interactions. There are no specific notifications for de-allocation, lost rights, or interaction morphs. Interactions that have de-allocated, or that the user have lost rights to will be represented by a remove notification. Interaction morphs are represented by a remove and an add notification.

Watch Interaction Alerting.

ININ.IceLib.Interactions.InteractionAlerting.StartWatching

Feature: interactions
Version: 6

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

Check for interactionAlertingMessage.

Monitor Interactions for when interaction attributes contain certain values.

ININ.IceLib.Interactions.InteractionAttributeMonitor.StartWatching

Receive added/removed/updated/lost rights notifications for monitored interactions.

ININ.IceLib.Interactions.InteractionAttributeMonitor.InteractionAdded

ININ.IceLib.Interactions.InteractionAttributeMonitor.InteractionChanged

ININ.IceLib.Interactions.InteractionAttributeMonitor.InteractionRemoved

ININ.IceLib.Interactions.InteractionAttributeMonitor.LostRights

Create an Interaction Conference.

ININ.IceLib.Interactions.InteractionsManager.MakeNewConference

Feature: interactions
Version: 1

POST /icws/{sessionId}/interactions/conferences

Invite members and add parties to an Interaction Conference.

ININ.IceLib.Interactions.InteractionConference.InviteParty

ININ.IceLib.Interactions.InteractionConference.AddParties

ININ.IceLib.Interactions.InteractionManager.InviteParty

Feature: interactions
Version: 1

PUT /icws/{sessionId}/interactions/conferences/{conferenceId}

POST /icws/{sessionId}/interactions/conferences/{conferenceId}/invite-party
Version: 11

POST /icws/{sessionId}/interactions/{interactionId}/invite-party
Version: 11

Watch and retrieve Interaction History.

ININ.IceLib.Interactions.InteractionsHistory.StartWatching

Feature: interactions
Version: 4

PUT /icws/{sessionId}/messaging/subscriptions/interaction-history

Watch for historyMessage.

Receive notifications when a MakeCall completes the appropriate stage, based on the CallMadeStage supplied with it was created.

ININ.IceLib.Interactions.InteractionsManager.CallMade

Receive notifications when an Interaction is auto answered.

ININ.IceLib.Interactions.InteractionsManager.InteractionAutoAnswered

Receive notifications when an Interaction action is “performing”, and when it has “performed”.

ININ.IceLib.Interactions.InteractionsManager.PerformingAction

ININ.IceLib.Interactions.InteractionsManager.PerformedAction

Perform consult transfers.

ININ.IceLib.Interactions.InteractionsManager.MakeConsultTransfer

Feature: interactions
Version: 6

POST /icws/{sessionId}/interactions/{interactionId}/consult

Create a Station Connection Interaction.

ININ.IceLib.Interactions.InteractionManager.MakeStationConnection

Create a Remote Number Connection Interaction.

ININ.IceLib.Interactions.InteractionManager.MakeRemoteNumberConnection

Add WrapUp assignments to Interactions.

ININ.IceLib.Interactions.InteractionManager.AddWrapUpAssignment

Query phone number details.

ININ.IceLib.Interactions.InteractionManager.QueryPhoneNumberDetails

Feature: interactions
Version: 2

POST /icws/{sessionId}/phone-numbers/query-details

Enable and disable monitored queue alerting.

ININ.IceLib.Interactions.MonitoredQueueAlerting.EnableAlerting

ININ.IceLib.Interactions.MonitoredQueueAlerting.DisableAlerting

Watch screen pops.

ININ.IceLib.Interactions.ScreenPop.StartWatching

ININ.IceLib.People

FeatureIceLib APIICWS SupportICWS API
Watch Response Management documents

ININ.IceLib.People.ResponseManagement.ResponseManager.StartWatching

This includes the User-specific documents, as well as the server documents.

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/response-management-documents

PUT /icws/{sessionId}/messaging/subscriptions/configuration/response-management-documents/{subscriptionId}

Save User-specific Response Management document

ININ.IceLib.People.ResponseManagement.ResponseManager.SaveUserDocument

Watch Custom Buttons

ININ.IceLib.People.CustomButtonList.StartWatching

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/client-buttons

PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-buttons/{subscriptionId}

Execute Custom Button Actions

ININ.IceLib.People.CustomButtonList.ActivateButtonAction

Watch the list of Status Messages a User is allowed to see

ININ.IceLib.People.FilteredStatusMessageList.StartWatching

Feature: status
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/status/status-messages-user-access

Check for statusMessagesUserAccessMessage.

Watch the list of Status Messages

ININ.IceLib.People.StatusMessageList.StartWatching

Feature: status
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/status/status-messages

Check for statusMessagesMessage.

Watch Licenses

ININ.IceLib.People.LicenseManagement.StartWatching

Feature: licenses
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/licenses

Check for licenseMessage.

Perform License operations

ININ.IceLib.People.LicenseManagment.LicenseOperation

ININ.IceLib.People.LicenseManagment.PerformLicenseOperation

This includes querying, requesting, replacing and releasing licenses.

Feature: licenses
Version: 1

POST /icws/{sessionId}/licenses

POST /icws/{sessionId}/licenses/license-stages

Querying of licenses is not supported.

Check to see if a License has been assigned

ININ.IceLib.People.LicenseManagement.IsLicenseAssigned

Watch users

ININ.IceLib.People.UserEntryList.StartWatching

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/users

PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId}

Watch Users’ Statuses

ININ.IceLib.People.UserStatusList.StartWatching

Feature: status
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/status/user-statuses

Check for userStatusMessage.

Retrieve a single User’s Status

ININ.IceLib.People.UserStatusList.GetUserStatus

This is separate from the watched User Statuses, and is done without the presence of a watch.

Feature: status
Version: 1

GET /icws/{sessionId}/status/user-statuses/{userId}

Retrieve previous Status Information for a User

ININ.IceLib.People.UserStatusList.GetPreviousStatusInfo

Feature: status
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/status/user-status-previous-info

Check for userStatusPreviousInfoMessage.

Change a User’s Status

ININ.IceLib.People.UserStatusUpdate.UpdateRequest

This includes Forward Number, UntilDate, UntilTime and Notes.

Feature: status
Version: 1

PUT /icws/{sessionId}/status/user-statuses/{userId}

Watch the logged in User’s Workgroup Activations

ININ.IceLib.People.UserWorkgroupActivationList.StartWatching

Feature: activations
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/activations/users/{subscriptionId}

Check for userActivationMessage.

Activate/Deactivate a User’s Workgroup memberships

ININ.IceLib.People.UserWorkgroupActivationUpdate.UpdateRequest

Feature: activations
Version: 1

PUT /icws/{sessionId}/activations/users/{userId}

Get a list of Workgroups the logged in User is a member of

ININ.IceLib.People.UserWorkgroupActivation.GetUserWorkgroups

This is exposed without a need for a watch.

Feature: configuration
Version: 1

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

The response will have a workgroups property.

Get a list of Workgroup Activations for the logged in User

ININ.IceLib.People.UserWorkgroupActivation.GetUserWorkgroupActivations

This is exposed without a need for a watch.

Feature: activations
Version: 1

GET /icws/{sessionId}/activations/users

GET /icws/{sessionId}/activations/users/{userId}

Get a list of Workgroups Activations for other Users

ININ.IceLib.People.UserWorkgroupActivation.GetActivationsForUser

This is exposed without a need for a watch.

Feature: activations
Version: 1

GET /icws/{sessionId}/activations/users

GET /icws/{sessionId}/activations/users/{userId}

Watch Workgroup Activations for a specific Workgroup

ININ.IceLib.People.WorkgroupActivationList.StartWatching

Feature: activations
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/activations/workgroups/{subscriptionId}

Check for workgroupActivationMessage.

Get a list of Workgroup Activations for a specific Workgroup.

ININ.IceLib.People.WorkgroupActivationList.GetUserActivationList

This is exposed without a need for a watch.

Feature: activations
Version: 1

GET /icws/{sessionId}/activations/workgroups

GET /icws/{sessionId}/activations/workgroups/{workgroupId}

Set Workgroup Activations for a specific Workgroup for multiple Users

ININ.IceLib.People.WorkgroupActivationList.SetUserActivations

Feature: activations
Version: 1

PUT /icws/{sessionId}/activations/workgroups/{workgroupId}

Watch a Workgroup

ININ.IceLib.People.WorkgroupDetailsList.StartWatching

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/workgroups

PUT /icws/{sessionId}/messaging/subscriptions/configuration/workgroups/{subscriptionId}

Manage Voice Prompts

ININ.IceLib.People.VoicePrompts.ManageVoicePrompts

Includes record, commit, preview, clear and cancel for Out of Office, No Answer, Follow Me, Name, Greeting, Available Forward and Quick Hold prompts.

Get a properly formatted Display Name for a User

ININ.IceLib.People.PeopleManager.GetDisplayName

Feature: phone-numbers
Version: 2

POST /icws/{sessionId}/phone-numbers/query-details

Search for simple User Entry Details

ININ.IceLib.People.PeopleManager.GetLookupEntries

This is exposed without a need for a watch.

Feature: directories
Version: 4

POST /icws/{sessionId}/directories/lookup-entries

Watch User Settings

ININ.IceLib.People.UserSettings.StartWatching

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/users

PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId}

Get User Attribute

ININ.IceLib.People.UserSettings.GetAttributeAsString

ININ.IceLib.People.UserSettings.GetAttributeAsStrings

ININ.IceLib.People.UserSettings.GetAttributeAsBool

Other strongly-types settings can be accessed from the following objects (ININ.IceLib.People.UserSettings.StartWatching is required to have been called first):

ININ.IceLib.People.UserAccessListsSettings

ININ.IceLib.People.UserDataSettings

ININ.IceLib.People.UserRightsSettings

ININ.IceLib.People.UserTrackerRightsSettings

Feature: configuration
Version: 1

GET /icws/{sessionId}/configuration/users

PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId}

Set User Attribute

ININ.IceLib.People.UserSettings.SetAttributeFromString

ININ.IceLib.People.UserSettings.SetAttributeFromStrings

ININ.IceLib.People.UserSettings.SetAttributeFromBool

Feature: configuration
Version: 1

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

ININ.IceLib.ProcessAutomation

FeatureIceLib APIICWS SupportICWS API
Watch Process Definitions.

ININ.IceLib.ProcessAutomation.ProcessManager.ProcessDefinitionList.StartWatching

Cancel Process Instances.

ININ.IceLib.ProcessAutomation.ProcessManager.CancelProcessInstances

Launch a process by name.

ININ.IceLib.ProcessAutomation.ProcessManager.LaunchProcessByName

Get a list of launch-able processes.

ININ.IceLib.ProcessAutomation.ProcessManager.GetLaunchableProcesses

Watch the launch-able process list.

ININ.IceLib.ProcessAutomation.ProcessManager.StartWatchingLaunchableProcesses

Feature: ipa
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/ipa/launchable-processes

Check for launchableProcessesSubscriptionEventArgs.

Check to see if a given process definition ID is running.

ININ.IceLib.ProcessAutomation.ProcessManager.CheckForRunningProcess

ININ.IceLib.QualityManagement

FeatureIceLib APIICWS SupportICWS API
Start a timed screen recording for a User.

ININ.IceLib.QualityManagement.ScreenRecorder.StartTimedRecording

Start/Stop a screen recording for a User.

ININ.IceLib.QualityManagement.ScreenRecorder.StartRecording

ININ.IceLib.QualityManagement.ScreenRecorder.StopRecording

Pause/Resume all screen recordings for a User.

ININ.IceLib.QualityManagement.ScreenRecorder.PauseRecordings

ININ.IceLib.QualityManagement.ScreenRecorder.ResumeRecordings

Get a recording's export Uri.

ININ.IceLib.QualityManagement.RecordingsManager.GetExportUri

ININ.IceLib.QualityManagement.RecordingsManager.GetSecureExportUri

Send an email of recording IDs to the Recorder Server.

ININ.IceLib.QualityManagement.RecordingsManager.SendRecordingsEmail

Start/Stop playback of a recording to a station.

ININ.IceLib.QualityManagement.RecordingsManager.StartStationAudioPlayback

ININ.IceLib.QualityManagement.RecordingsManager.StopStationAudioPlayback

Add/Query/Remove recording tags.

ININ.IceLib.QualityManagement.RecordingsManager.AddRecordingTags

ININ.IceLib.QualityManagement.RecordingsManager.QueryRecordingTags

ININ.IceLib.QualityManagement.RecordingsManager.RemoveRecordingTags

Add/Modify/Query/Remove recording attributes.

ININ.IceLib.QualityManagement.RecordingsManager.AddRecordingAttributes

ININ.IceLib.QualityManagement.RecordingsManager.ModifyRecordingAttributes

ININ.IceLib.QualityManagement.RecordingsManager.QueryRecordingAttributes

ININ.IceLib.QualityManagement.RecordingsManager.RemoveRecordingAttributes

ININ.IceLib.Reporting

FeatureIceLib APIICWS SupportICWS API
Retrieve Interaction snapshot history.
Get the current Site ID.

ININ.IceLib.Statistics

FeatureIceLib APIICWS SupportICWS API
Watch Alerts.

ININ.IceLib.Statistics.Alerts.AlertListener.StartWatching

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/alerts/alert-notifications

Watch the Alert Catalog.

ININ.IceLib.Statistics.Alerts.AlertCatalog.StartWatching

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/alerts/alert-catalog

Create/update/remove an Alert Set.

ININ.IceLib.Statistics.Alerts.AlertCatalog.CreateAlertSet

ININ.IceLib.Statistics.Alerts.AlertCatalog.RemoveAlertSet

ININ.IceLib.Statistics.Alerts.AlertCatalog.UpdateAlertSet

Update an Alert Set’s subscriptions.

ININ.IceLib.Statistics.Alerts.AlertCatalog.UpdateSubscriptions

Transfer an Alert Set’s ownership.

ININ.IceLib.Statistics.Alerts.AlertCatalog.TransferOwnership

Get watched shared Alert Sets.

ININ.IceLib.Statistics.Alerts.AlertCatalog.GetWatchedSharedAlertSets

Get watched Owner Default Alert Sets.

ININ.IceLib.Statistics.Alerts.AlertCatalog.GetWatchedOwnerDefaultAlertSets

Get watched Alert Sets.

ININ.IceLib.Statistics.Alerts.AlertCatalog.GetWatchedAlertSets

Get Alert Definitions.

ININ.IceLib.Statistics.Alerts.AlertCatalog.GetAlertDefinitions

Get an Alert Set.

ININ.IceLib.Statistics.Alerts.AlertCatalog.AlertCatalog.GetAlertSet

Subscribe to an Alert Set.

ININ.IceLib.Statistics.Alerts.AlertCatalog.Subscribe

Get Drill Down Data for a Statistic Key.

ININ.IceLib.Statistics.DrillDown.GetDrillDownData

Watch Statistic Parameter Values.

ININ.IceLib.Statistics.ParameterValuesDepot.StartWatching

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-parameter-values

Execute a Statistic Parameter Value Query.

ININ.IceLib.Statistics.ParameterValuesDepot.ExecuteQuery

Feature: statistics
Version: 1

POST /icws/{sessionId}/statistics/statistic-parameter-values/queries

Validate associated Parameter Sets.

ININ.IceLib.Statistics.ParameterValuesDepot.ValidateAssociatedParameterSet

Feature: statistics
Version: 1

POST /icws/{sessionId}/statistics/statistic-parameter-values/chained-parameters-validator

Get detailed Parameter Values.

ININ.IceLib.Statistics.ParameterValuesDepot.GetDetailedParameterValues

Feature: statistics
Version: 1

POST /icws/{sessionId}/statistics/statistic-parameter-values

Watch the Statistics Catalog.

ININ.IceLib.Statistics.StatisticCatalog.StartWatching

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

Get a Statistic Category.

ININ.IceLib.Statistics.StatisticCatalog.GetStatisticCategory

Get all Statistic Categories.

ININ.IceLib.Statistics.StatisticCatalog.GetStatisticCategories

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

Check for the statisticCategoryList property on statisticCatalogMessage.

Get a Statistic Category’s Statistic Definitions.

ININ.IceLib.Statistics.StatisticCatalog.GetStatisticDefinitions

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

Check for the statisticDefinitions property on the statisticCategoryList property on statisticCatalogMessage.

Get all Statistic Definitions.

ININ.IceLib.Statistics.StatisticCatalog.GetStatisticDefinitions

Get a Statistic Definition.

ININ.IceLib.Statistics.StatisticCatalog.GetStatisticDefinition

Get a Parameter Type.

ININ.IceLib.Statistics.StatisticCatalog.GetParameterType

Get all Parameter Types.

ININ.IceLib.Statistics.StatisticCatalog.GetParameterTypes

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

Check for the parameterTypeDefinitions property on statisticCatalogMessage.

Get a Parameter’s Display String.

ININ.IceLib.Statistics.StatisticCatalog.GetParameterDisplayString

Feature: statistics
Version: 1

POST /icws/{sessionId}/statistics/statistic-parameter-values

Check the response for the displayString property on the parameterValues property.

Watch Statistic Values.

ININ.IceLib.Statistics.StatisticListener.StartWatching

Feature: statistics
Version: 1

PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-values

Check for statisticValueMessage.

Watch Memos.

ININ.IceLib.Statistics.Alerts.MemoList.StartWatching

Create a new Memo.

ININ.IceLib.Statistics.Alerts.MemoList.CommitMemo

Delete a Memo.

ININ.IceLib.Statistics.Alerts.MemoList.DeleteMemo

ININ.IceLib.Tracker

ICWS does not have support for the functionality provided by this IceLib namespace.

ININ.IceLib.Data.TransactionBuilder

ICWS does not have support for the functionality provided by this IceLib namespace.

ININ.IceLib.UnifiedMessaging

FeatureIceLib APIICWS SupportICWS API
Send a fax from a fax file.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.SendFax

Load/save/modify fax files.

ININ.IceLib.UnifiedMessaging.FaxFile.LoadFrom

ININ.IceLib.UnifiedMessaging.FaxFile.SaveAs

ININ.IceLib.UnifiedMessaging.FaxFile.AddEnvelope

ININ.IceLib.UnifiedMessaging.FaxFile.AddPage

ININ.IceLib.UnifiedMessaging.FaxFile.InsertPage

ININ.IceLib.UnifiedMessaging.FaxFile.MovePage

ININ.IceLib.UnifiedMessaging.FaxFile.RemoveEnvelope

ININ.IceLib.UnifiedMessaging.FaxFile.RemovePage

ININ.IceLib.UnifiedMessaging.FaxFile.UpdatePage

Receive notifications of fax status changes.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.FaxMonitorUpdate

Retrieve fax server settings.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.GetFaxServerSettings

Cancel a fax.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.CancelFax

Retrieve fax properties.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.GetFaxProperties

Refresh the fax cache.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.RefreshFaxCache

Receive notifications of added/removed/updated faxes.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.NewFax

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.FaxDeleted

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.FaxUpdated

Note that this is not currently triggered by a watch request.  These are triggered by sending a refresh request to the server.

Watch for waiting voicemails.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.StartWatchingVoicemailWaiting

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.StopWatchingVoicemailWaiting

Receive notifications for when there are waiting voicemails.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.VoicemailWaitingChanged

Stop voicemail handset playback.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.StopPlayToStation

Update the Message Waiting Indicator light.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.UpdateMessageWaitingIndicator

Refresh the voicemail cache.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.RefreshVoicemailCache

Receive notifications of added/removed/updated voicemails.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.NewVoicemail

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.VoicemailDeleted

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.VoicemailUpdated

Note that this is not currently triggered by a watch request.  These are triggered by sending a refresh request to the server.

Enable/disable fax monitoring.

ININ.IceLib.UnifiedMessaging.UnifiedMessagingManager.EnableFaxMonitoring

Delete a voicemail message.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.Delete

Start/Stop voicemail playback to a station.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.PlayToStation

Receive notification when a voicemail message station playback completes.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.PlaybackComplete

Play a voicemail to the handset.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.PlayToHandset

Start/Stop voicemail playback to a specific number.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.PlayToNumber

Save a voicemail as a file.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.SaveAsFile

Cancel a voicemail file save.

ININ.IceLib.UnifiedMessaging.VoicemailMessage.CancelSaveAsFile