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:
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Configuration Object Support | See separate Configuration Object table below. | ||
| Get enabled mailbox types | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetEnabledMailboxTypes | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/enabled-mailbox-providers |
| Get IMAP servers | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetImapServers | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/imap-servers |
| Get Interaction Message Store users | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetInteractionMessageStoreMailboxes | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/interaction-message-store-mailbox-attributes |
| List mailbox folders | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetMailboxFolders | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/folders |
| Get searchable mailbox directories | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.GetSearchableDirectories | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/searchable-providers |
| Open mailbox | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.OpenMailbox | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/test-mailbox |
| Search mailbox directories | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.SearchDirectories | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/directories |
| Send an email | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.SendEmail | Feature: configuration Version: 1 | POST /icws/{sessionId}/configuration/mail/send-email |
| Test a mailbox moniker | ININ.IceLib.Configuration.Mailbox.Utility.MailboxUtilities.TestMoniker | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/mail/test-moniker |
| Check to see if Access Control Groups are in use | ININ.IceLib.Configuration.DataTypes.AccessControlGroup.AreAccessControlGroupsInUse | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/access-control-groups/are-in-use |
| Assign Users to an Access Control Group | ININ.IceLib.Configuration.DataTypes.AccessControlGroup.AssignToAccessControlGroup | Feature: 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 Type | ININ.IceLib.Configuration.DataTypes.AccessControlGroup.GetAccessControlGroupsForObjectType | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/access-control-groups/assignable/{objectType} |
| Get list of supported Analyzer keyword languages | ININ.IceLib.Configuration.AnalyzerKeywordConfiguration.GetSupportedAnalyzerLanguages | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-analyzer/supported-languages |
| Get Keyword accuracy | ININ.IceLib.Configuration.AnalyzerKeywordSetConfigurationList.GetKeywordAccuracy | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/keyword-sets/preview-keyword-runtime |
| Get Keyword count information | ININ.IceLib.Configuration.AnalyzerKeywordSetConfigurationList.GetKeywordCountInformation | ||
| Publish Client Templates to Users, Roles and Workgroups |
| ||
| Determine if Dialer is enabled |
| ||
| Get supported System languages |
| Feature: configuration Version: 1 | |
| Get time zones |
| Feature: configuration Version: 1 | |
| Get a list of IVR Handler names |
| Feature: configuration Version: 1 | |
| Being a Configuration Transaction |
| ||
| End a Configuration Transaction |
| POST /icws/{sessionId}/configuration/transaction/{transactionId}/transaction-end |
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:
| Configuration Object | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| List-based Objects | |||
| AccessControlGroupConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/access-control-groups PUT /icws/{sessionId}/messaging/subscriptions/configuration/access-control-groups/{subscriptionId} Capabilities: |
| AccountCodeConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/account-codes PUT /icws/{sessionId}/messaging/subscriptions/configuration/account-codes/{subscriptionId} Capabilities: |
| AccumulatorConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/accumulators Capabilities: |
| ActionConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/actions PUT /icws/{sessionId}/messaging/subscriptions/configuration/actions/{subscriptionId} Capabilities: |
| AnalyzerKeywordConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/keyword-sets PUT /icws/{sessionId}/messaging/subscriptions/configuration/keyword-sets/{subscriptionId} Capabilities: |
| AnalyzerKeywordSetConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/keyword-sets PUT /icws/{sessionId}/messaging/subscriptions/configuration/keyword-sets/{subscriptionId} Capabilities: |
| AttendantEmailProfileConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/attendant-email-profiles Capabilities: |
| AttendantInboundProfileConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/attendant-inbound-profiles Capabilities: |
| AttendantOperatorProfileConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/attendant-operator-profiles Capabilities: |
| AttendantOutboundProfileConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/attendant-outbound-profiles Capabilities: |
| AudioSourceConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/audio-sources PUT /icws/{sessionId}/messaging/subscriptions/configuration/audio-sources/{subscriptionId} Capabilities: |
| ClientConfigurationTemplateConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/client-configuration-templates Capabilities: |
| ClientTemplateConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/client-templates PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-templates/{subscriptionId} Capabilities: |
| ContactListSourceConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/contact-list-sources Capabilities: |
| Integrations.Salesforce.CtiAttributeMapConfiguration |
Capabilities: | Feature: configuration Version: 1 | Capabilities: |
| Integrations.Salesforce.CtiConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/salesforce-cti-configurations Capabilities: |
| CustomButtonConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/client-buttons PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-buttons/{subscriptionId} Capabilities: |
| EFaq.EFaqConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/e-faqs Capabilities: |
| FaxGroupConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/fax-groups Capabilities: |
| FeatureLicenseConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/feature-licenses Capabilities: |
| Feedback.FeedbackSurveyConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/feedback-surveys Capabilities: |
| Feedback.FeedbackSurveyGroupConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/feedback-survey-groups Capabilities: |
| HandlerConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/handlers Capabilities: |
| Reporting.HistoricalReportConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/historical-reports Capabilities: |
| ICDataSourceConfiguration |
Capabilities: | Feature: configuration | GET /icws/{sessionId}/configuration/ic-data-sources Capabilities: Editability was added in the CTP version 7. Watch support was added in public version 11. |
| ImageResourceCategoryConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/image-resource-categories Capabilities: |
| ImageResourceConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/image-resources PUT /icws/{sessionId}/messaging/subscriptions/configuration/image-resources/{subscriptionId} Capabilities: |
| InitializationFunctionConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/initialization-functions Capabilities: |
| InteractionClientPluginConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-client-plugins Capabilities: |
| InteractionConferenceRoomConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-conference-rooms Capabilities: |
| InteractionProcessorTableConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-processor-tables Capabilities: |
| LayoutConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/layouts PUT /icws/{sessionId}/messaging/subscriptions/configuration/layouts/{subscriptionId} Capabilities: |
| Reporting.LegacyHistoricalReportConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/legacy-historical-reports Capabilities: |
| LicenseAllocationConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/license-allocations Capabilities: |
| LineConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/lines Capabilities: Editability was added in the CTP version 7. Watch support was added in public version 11. |
| LineGroupConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/line-groups Capabilities: Editability was added in the CTP version 8. Watch support was added in public version 11. |
| LocationConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/locations Capabilities: Create was added in the CTP version 7, and public version 11. |
| MiscellaneousItemConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/miscellaneous-items Capabilities: |
| OCS.OfficeCommunicationServerActiveDirectoryConfiguration |
Capabilities: | ||
| OCS.OfficeCommunicationServerStatusMessageConfiguration |
Capabilities: | ||
| Optimizer.OptimizerSchedulingUnitConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-optimizer-scheduling-units Capabilities: |
| PagingCarrierConfiguration |
Capabilities: | ||
| PasswordPolicyConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/password-policies PUT /icws/{sessionId}/messaging/subscriptions/configuration/password-policies/{subscriptionId} Capabilities: |
| PhoneNumberClassificationConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/dial-plan-classifications Capabilities: |
| PositionConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/positions PUT /icws/{sessionId}/messaging/subscriptions/configuration/positions/{subscriptionId} Capabilities: |
| ProcessAutomation.ProcessConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-process-automation-processes Capabilities: |
| QueueColumnConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/queue-columns PUT /icws/{sessionId}/messaging/subscriptions/configuration/queue-columns/{subscriptionId} Capabilities: |
| Recorder.RecorderQuestionnaireConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-recorder-questionnaires Capabilities: |
| ReportLogConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/report-logs Capabilities: |
| RecordingBeepToneConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/recording-beep-tones PUT /icws/{sessionId}/messaging/subscriptions/configuration/recording-beep-tones/{subscriptionId} Capabilities: |
| ResponseManagementDocumentConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/response-management-documents Capabilities: |
| RoleConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/roles PUT /icws/{sessionId}/messaging/subscriptions/configuration/roles/{subscriptionId} Capabilities: |
| ScheduleConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/schedules PUT /icws/{sessionId}/messaging/subscriptions/configuration/schedules/{subscriptionId} Capabilities: |
| ScheduleRecurrenceConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/schedules PUT /icws/{sessionId}/messaging/subscriptions/configuration/schedules/{subscriptionId} Capabilities: |
| SelectionRuleConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/selection-rules Capabilities: |
| ServerParameterConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/server-parameters PUT /icws/{sessionId}/messaging/subscriptions/configuration/server-parameters/{subscriptionId} Capabilities: |
| SipBridgeConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/sip-bridges Capabilities: |
| SingleSignOnIdentityProviderConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/single-sign-on-identity-providers Capabilities: |
| SiteConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/peer-sites Capabilities: |
| SecureInputFormConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/secure-input-forms PUT /icws/{sessionId}/messaging/subscriptions/configuration/secure-input-forms/{subscriptionId} Capabilities: |
| SkillConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/skills PUT /icws/{sessionId}/messaging/subscriptions/configuration/skills/{subscriptionId} Capabilities: |
| SmsBrokerConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/sms-brokers Capabilities: |
| StationConfiguration |
Capabilities: | ||
| StationGroupConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/station-groups Capabilities: |
| StationTemplateConfiguration |
Capabilities: | ||
| StatusColumnConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/status-columns Capabilities: |
| StatusMessageConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/status-messages Capabilities: Editiability was added in CTP version 10. |
| StructuredParameterConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/structured-parameters PUT /icws/{sessionId}/messaging/subscriptions/configuration/structured-parameters/{subscriptionId} Capabilities: |
| SystemParameterConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/system-parameters PUT /icws/{sessionId}/messaging/subscriptions/configuration/system-parameters/{subscriptionId} Capabilities: |
| UserConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/users PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId} Capabilities: |
| VoiceModuleConfiguration |
Capabilities: | ||
| WebServicesParameterConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/web-services-parameters Capabilities: |
| WorkgroupConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/workgroups PUT /icws/{sessionId}/messaging/subscriptions/configuration/workgroups/{subscriptionId} Capabilities: |
| WorkgroupMonitoredMailboxConfiguration |
Capabilities: | Feature: configuration Version: 1 | POST /icws/{sessionId}/configuration/workgroups/{id}/monitored-mailboxes Capabilities: |
| WrapUpCategoryConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/wrap-up-categories PUT /icws/{sessionId}/messaging/subscriptions/configuration/wrap-up-categories/{subscriptionId} Capabilities: |
| WrapUpCodeConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/wrap-up-codes PUT /icws/{sessionId}/messaging/subscriptions/configuration/wrap-up-codes/{subscriptionId} Capabilities: |
| Reporting.ReportCategoryConfiguration |
Capabilities: | ||
| Reporting.ReportCustomDataConfiguration |
Capabilities: | ||
| Reporting.ReportFlexibleColumnConfiguration |
Capabilities: | ||
| Reporting.ReportMasterConfiguration |
Capabilities: | ||
| Reporting.ReportParameterConfiguration |
Capabilities: | ||
| Reporting.ReportSectionConfiguration |
Capabilities: | ||
| Reporting.ReportSystemSettingConfiguration |
Capabilities: | ||
| Reporting.ReportTableConfiguration |
Capabilities: | ||
| Internal List-based Objects | |||
| Dialer.Internal.DialerCallListAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-call-list-acls Capabilities: |
| Dialer.Internal.DialerCampaignAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-campaign-acls Capabilities: |
| Dialer.Internal.DialerPolicySetAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-policy-set-acls Capabilities: |
| Dialer.Internal.DialerRuleSetAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-rule-set-acls Capabilities: |
| Dialer.Internal.DialerScheduleAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-schedule-acls Capabilities: |
| Dialer.Internal.DialerScriptAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-script-acls Capabilities: |
| Dialer.Internal.DialerSkillSetAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-skill-set-acls Capabilities: |
| Dialer.Internal.DialerStageSetAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-stage-set-acls Capabilities: |
| Dialer.Internal.DialerZoneSetAclConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-dialer-zone-set-acls Capabilities: |
| ManagedPhoneConfiguration |
Capabilities: | ||
| ManagedPhoneRegistrationGroupConfiguration |
Capabilities: | ||
| ManagedPhoneRingSetConfiguration |
Capabilities: | ||
| ManagedPhoneTemplateConfiguration |
Capabilities: | ||
| ManagedExternalRegistrationAppearanceConfiguration |
Capabilities: | ||
| ManagedSharedStationAppearanceConfiguration |
Capabilities: | ||
| ManagedSharedStationTemplateAppearanceConfiguration |
Capabilities: | ||
| ManagedStationAppearanceConfiguration |
Capabilities: | ||
| ManagedStationTemplateAppearanceConfiguration |
Capabilities: | ||
| SkillCategoryConfiguration |
Capabilities: | Feature: configuration Version: 11 Status: Completed | GET /icws/{sessionId}/configuration/skill-categories PUT /icws/{sessionId}/messaging/subscriptions/configuration/skill-categories/{subscriptionId} Capabilities: |
| StatisticGroupConfiguration |
Capabilities: | Feature: configuration Version: 11 Status: Completed | GET /icws/{sessionId}/configuration/statistic-parameter-groups Capabilities: |
| Singleton Objects | |||
| AccountCodesConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/account-codes-configuration Capabilities: |
| DefaultLocationConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/default-location Capabilities: |
| DefaultStationConfiguration |
Capabilities: | ||
| DefaultUserConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/default-user PUT /icws/{sessionId}/messaging/subscriptions/configuration/default-user/{subscriptionId} Capabilities: |
| DnisMappingsConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/dnis-mappings Capabilities: |
| ProblemReporterConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/problem-reporter PUT /icws/{sessionId}/messaging/subscriptions/configuration/problem-reporter/{subscriptionId} Capabilities: |
| Recorder.RecorderConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/interaction-recorder-configuration Capabilities: |
| SystemConfiguration |
Capabilities: | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/system PUT /icws/{sessionId}/messaging/subscriptions/configuration/system/{subscriptionId} Capabilities: |
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Can specify session-specific settings to use when connecting to an IC Server |
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 | Only Application Name, MarketPlace Application Code, and MarketPlace Application License Name values are supported. |
| Can specify custom parameters when connecting to an IC Server |
| ||
| Connect to IC Server via Windows Authentication |
Can request NTLM and/or Kerberos. | Feature: connection Version: 3 | Performed using single sign-on with a built-in Identity Provider. |
| Connect to IC Server via Alternate Windows Authentication |
Can request NTLM and/or Kerberos. | Feature: connection Version: 3 | Performed using single sign-on with a built-in Identity Provider. |
| Connect to IC Server via IC Authentication |
| Feature: connection Version: 1 | |
| Connect to IC Server via Single-Sign-On |
| Feature: connection Version: 3 | |
| Connect to IC Server with a Workstation |
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 |
| 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 |
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 |
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 |
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 |
| ||
| Receive a notification for when Connection State changes |
| Feature: connection Version: 1 | Check for |
| Receive a notification for when Station Settings change |
| Feature: connection Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/connection/station Check for |
| Receive a notification for when the Effective Station changes |
Only valid when connecting via Stationless. | Feature: connection Version: 11 | Check for |
| Auto-reconnect on dropped connection |
Can turn this on or off. | ||
| Get and Set Additional UTC Offset |
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 |
|
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Retrieve and set Custom profile settings |
Supports legacy custom profiles, and application-based custom profiles. | ||
| Watch and send Custom Notifications |
| 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 |
| Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/server-parameters PUT /icws/{sessionId}/messaging/subscriptions/configuration/server-parameters/{subscriptionId} |
| Submit Problem Reports |
| ||
| Connect to IC Server on behalf of a different Windows User |
Can request NTLM and/or Kerberos. | ||
| Connect to IC Server on behalf of a different IC User |
| ||
| Connect to IC Server via Windows Authentication on behalf of a different IC User |
Can request NTLM and/or Kerberos. | ||
| Retrieve Password Policy |
| ||
| Change Password |
| Feature: security Version: 1 | |
| Receive notifications when a password expires |
| Feature: connection Version: 3 | Check the |
| Receive notifications when a password is about to expire |
| Feature: connection Version: 3 | response
Check the |
| Watch Sessions based on User |
Call StartWatching with an | Feature: session Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/session/sessions-users Check for |
| Watch Sessions based Station |
Call StartWatching with an | Feature: session Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/session/sessions-stations Check for |
| Watch Sessions based Machine |
Call StartWatching with an |
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Watch Directory Metadata |
| Feature: directories Version: 4 | PUT /icws/{sessionId}/messaging/subscriptions/directories Check for |
| Watch Contact Directories |
Supports paged and non-pages watches. | Feature: directories Version: 4 | PUT /icws/{sessionId}/messaging/subscriptions/directories/{subscriptionId} Check for |
| Add, Edit and Delete Contacts |
| ||
| Receive notifications when the number of Contacts in a Directory changes |
| ||
| Create, Edit, Delete Speed Dial Directories |
| ||
| Create, Edit Speed Dial entries |
|
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Agents and Supervisors can create and watch Help requests. |
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. |
| Feature: interactions Version: 8 | POST /icws/{sessionId}/interactions Supply the appropriate createCallbackParameters object. |
| Set a Callback Interaction’s “completion” to success, failure or retry. |
| Feature: interactions Version: 8 | PUT /icws/{sessionId}/interactions/{interactionId}/callback/disposition |
| Create Call Interaction. |
| Feature: interactions Version: 1 | POST /icws/{sessionId}/interactions Supply the appropriate createCallParameters object. |
| Play digits to a Call Interaction. |
| Feature: interactions Version: 6 | POST /icws/{sessionId}/interactions/{interactionId}/send-digits |
| Play/Stop WAV audio to a Call Interaction. |
| ||
| Receive notification of when WAV audio play is complete. |
| ||
| Create Chat Interaction. |
| ||
| Receive notification when chat members are added/removed/updated. |
| Feature: interactions Version: 6 | PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat Check for |
| Receive notification of a chat typing indicator. |
| Feature: interactions Version: 6 | PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat Check for |
| Receive notification of text and URL added to a chat. |
| Feature: interactions Version: 6 | PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}/chat Check for |
| Retrieve current chat members. |
| 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. |
| 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. |
| ||
| Set the chat typing indicator. |
| Feature: interactions Version: 6 | PUT /icws/{sessionId}/interactions/{interactionId}/chat/typing-indicator |
| Send chat text. |
| Feature: interactions Version: 6 | POST /icws/{sessionId}/interactions/{interactionId}/chat/messages |
| Send chat URL. |
| ||
| Send chat file. |
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. |
| ||
| Receive notification of when the speakers changed for a consult transfer. |
| Feature: interactions Version: 6 | POST /icws/{sessionId}/interactions/{interactionId}/consult Check for |
| Cancel on a consult transfer. |
| Feature: interactions Version: 6 | DELETE /icws/{sessionId}/interactions/{interactionId}/consult/{consultId} |
| Conclude on a consult transfer. |
| Feature: interactions Version: 6 | POST /icws/{sessionId}/interactions/{interactionId}/consult/{consultId}/conclude |
| ChangeSpeakers on a consult transfer. |
| Feature: interactions Version: 6 | POST /icws/{sessionId}/interactions/{interactionId}/consult/{consultId}/change-audience |
| Watch and retrieve the list of EFaq Servers. |
| ||
| Submit queries to an EFaq Server. |
| ||
| Create an Email Interaction. |
| ||
| Create Email responses. |
| ||
| Download email file and message attachments. |
| Feature: interactions Version: 10 Status: Completed | POST /icws/{sessionId}/interactions/{interactionId}/email/attachments/message/download |
| Receive notifications when an email is updated. |
| ||
| Save an email. |
| Feature: interactions Version: 10 Status: Completed | POST /icws/{sessionId}/interactions/{interactionId}/email/save |
| Update email file attachments. |
| 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. |
| Feature: interactions Version: 10 Status: Completed | POST /icws/{sessionId}/interactions/{interactionId}/email/send |
| Resolve email address names. |
| Feature: interactions Version: 10 Status: Completed | |
| Watch an Interaction Queue. |
| Feature: interactions Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId} Check for |
| Get Interaction Queue contents snapshot. |
| ||
| Receive notifications of lost rights to a queue. |
| ||
| Receive notifications when queue notifications become suspended, or are resumed. |
| ||
| Change watched attributes for a queue. |
| Feature: interactions Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId} |
| Create a Generic Interaction. |
| Feature: interactions Version: 1 | POST /icws/{sessionId}/interactions Supply the appropriate createGenericInteractionParameters object. |
| Watch an Interaction, change the watched attributes on an Interaction. |
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 |
| Retrieve String, String[], Boolean, DateTime and Integer attribute values from an Interaction. | The following retrieve attributes, causing a potential hit to the IC Server:
The following retrieve attributes, only if they are watched:
Additionally, there are many strongly-typed properties for well-known Interaction attributes. | Feature: interactions Version: 1 | |
| Set String and DateTime attribute values on an Interaction. |
| Feature: interactions Version: 1 | |
| Append a value to a string attribute on an Interaction. |
Default delimiter is “|”. | ||
| Pickup an Interaction |
| Feature: interactions Version: 1 | |
| Disconnect an Interaction |
| Feature: interactions Version: 1 | POST /icws/{sessionId}/interactions/{interactionId}/disconnect |
| Blind Transfer an Interaction |
| Feature: interactions Version: 1 | POST /icws/{sessionId}/interactions/{interactionId}/blind-transfer |
| Transfer an Interaction to Voicemail |
| Feature: interactions Version: 6 | POST /icws/{sessionId}/interactions/{interactionId}/transfer-to-voicemail |
| Send an Interaction to Voicemail |
| Feature: interactions Version: 1 | POST /icws/{sessionId}/interactions/{interactionId}/send-to-voicemail |
| Park an Interaction |
| Feature: interactions Version: 6 | |
| Listen to an Interaction |
| Feature: interactions Version: 1 | |
| Coach an Interaction |
| Feature: interactions Version: 1 | |
| Hold an Interaction |
| Feature: interactions Version: 1 | |
| Mute an Interaction |
| Feature: interactions Version: 1 | |
| Pause recording of an Interaction |
| Feature: interactions Version: 1 | |
| Set an Interaction Private |
| Feature: interactions Version: 1 | POST /icws/{sessionId}/interactions/{interactionId}/make-private |
| Record/Pause Recording of an Interaction |
| Feature: interactions Version: 1 | |
| Join an Interaction in a Conference |
| Feature: interactions Version: 1 | |
| Initiate Secure Input for an Interaction |
| ||
| Initiate Secure Recording Pause for an Interaction |
| Feature: interactions Version: 8 | POST /icws/{sessionId}/interactions/{interactionId}/secure-pause |
| Start or Stop a Recording Snippet for an Interaction |
| ||
| Receive notifications on an Interaction when attributes change, it is de-allocated, rights to the Interaction are lost, or when an Interaction morphs. |
| Feature: interactions Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId} Check for |
| Watch Interaction Alerting. |
| Feature: interactions Version: 6 | PUT /icws/{sessionId}/messaging/subscriptions/interaction-alerting Check for |
| Monitor Interactions for when interaction attributes contain certain values. |
| ||
| Receive added/removed/updated/lost rights notifications for monitored interactions. |
| ||
| Create an Interaction Conference. |
| Feature: interactions Version: 1 | |
| Invite members and add parties to an Interaction Conference. |
| Feature: interactions Version: 1 | PUT /icws/{sessionId}/interactions/conferences/{conferenceId} POST /icws/{sessionId}/interactions/conferences/{conferenceId}/invite-party POST /icws/{sessionId}/interactions/{interactionId}/invite-party |
| Watch and retrieve Interaction History. |
| 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. |
| ||
| Receive notifications when an Interaction is auto answered. |
| ||
| Receive notifications when an Interaction action is “performing”, and when it has “performed”. |
| ||
| Perform consult transfers. |
| Feature: interactions Version: 6 | |
| Create a Station Connection Interaction. |
| ||
| Create a Remote Number Connection Interaction. |
| ||
| Add WrapUp assignments to Interactions. |
| ||
| Query phone number details. |
| Feature: interactions Version: 2 | |
| Enable and disable monitored queue alerting. |
| ||
| Watch screen pops. |
|
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Watch Response Management documents |
This includes the User-specific documents, as well as the server documents. | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/response-management-documents |
| Save User-specific Response Management document |
| ||
| Watch Custom Buttons |
| Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/client-buttons PUT /icws/{sessionId}/messaging/subscriptions/configuration/client-buttons/{subscriptionId} |
| Execute Custom Button Actions |
| ||
| Watch the list of Status Messages a User is allowed to see |
| Feature: status Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/status/status-messages-user-access Check for |
| Watch the list of Status Messages |
| Feature: status Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/status/status-messages Check for |
| Watch Licenses |
| Feature: licenses Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/licenses Check for |
| Perform License operations |
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 |
| ||
| Watch users |
| Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/users PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId} |
| Watch Users’ Statuses |
| Feature: status Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/status/user-statuses Check for |
| Retrieve a single User’s Status |
This is separate from the watched User Statuses, and is done without the presence of a watch. | Feature: status Version: 1 | |
| Retrieve previous Status Information for a User |
| Feature: status Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/status/user-status-previous-info Check for |
| Change a User’s Status |
This includes Forward Number, UntilDate, UntilTime and Notes. | Feature: status Version: 1 | |
| Watch the logged in User’s Workgroup Activations |
| Feature: activations Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/activations/users/{subscriptionId} Check for |
| Activate/Deactivate a User’s Workgroup memberships |
| Feature: activations Version: 1 | |
| Get a list of Workgroups the logged in User is a member of |
This is exposed without a need for a watch. | Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/users/{id} The response will have a |
| Get a list of Workgroup Activations for the logged in User |
This is exposed without a need for a watch. | Feature: activations Version: 1 | |
| Get a list of Workgroups Activations for other Users |
This is exposed without a need for a watch. | Feature: activations Version: 1 | |
| Watch Workgroup Activations for a specific Workgroup |
| Feature: activations Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/activations/workgroups/{subscriptionId} Check for |
| Get a list of Workgroup Activations for a specific Workgroup. |
This is exposed without a need for a watch. | Feature: activations Version: 1 | |
| Set Workgroup Activations for a specific Workgroup for multiple Users |
| Feature: activations Version: 1 | |
| Watch a Workgroup |
| Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/workgroups PUT /icws/{sessionId}/messaging/subscriptions/configuration/workgroups/{subscriptionId} |
| Manage Voice Prompts |
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 |
| Feature: phone-numbers Version: 2 | |
| Search for simple User Entry Details |
This is exposed without a need for a watch. | Feature: directories Version: 4 | |
| Watch User Settings |
| Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/users PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId} |
| Get User Attribute |
Other strongly-types settings can be accessed from the following objects (
| Feature: configuration Version: 1 | GET /icws/{sessionId}/configuration/users PUT /icws/{sessionId}/messaging/subscriptions/configuration/users/{subscriptionId} |
| Set User Attribute |
| Feature: configuration Version: 1 |
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Watch Process Definitions. |
| ||
| Cancel Process Instances. |
| ||
| Launch a process by name. |
| ||
| Get a list of launch-able processes. |
| ||
| Watch the launch-able process list. |
| Feature: ipa Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/ipa/launchable-processes Check for |
| Check to see if a given process definition ID is running. |
|
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Start a timed screen recording for a User. |
| ||
| Start/Stop a screen recording for a User. |
| ||
| Pause/Resume all screen recordings for a User. |
| ||
| Get a recording's export Uri. |
| ||
| Send an email of recording IDs to the Recorder Server. |
| ||
| Start/Stop playback of a recording to a station. |
| ||
| Add/Query/Remove recording tags. |
| ||
| Add/Modify/Query/Remove recording attributes. |
|
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Retrieve Interaction snapshot history. | |||
| Get the current Site ID. |
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Watch Alerts. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/alerts/alert-notifications |
| Watch the Alert Catalog. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/alerts/alert-catalog |
| Create/update/remove an Alert Set. |
| ||
| Update an Alert Set’s subscriptions. |
| ||
| Transfer an Alert Set’s ownership. |
| ||
| Get watched shared Alert Sets. |
| ||
| Get watched Owner Default Alert Sets. |
| ||
| Get watched Alert Sets. |
| ||
| Get Alert Definitions. |
| ||
| Get an Alert Set. |
| ||
| Subscribe to an Alert Set. |
| ||
| Get Drill Down Data for a Statistic Key. |
| ||
| Watch Statistic Parameter Values. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-parameter-values |
| Execute a Statistic Parameter Value Query. |
| Feature: statistics Version: 1 | POST /icws/{sessionId}/statistics/statistic-parameter-values/queries |
| Validate associated Parameter Sets. |
| Feature: statistics Version: 1 | POST /icws/{sessionId}/statistics/statistic-parameter-values/chained-parameters-validator |
| Get detailed Parameter Values. |
| Feature: statistics Version: 1 | POST /icws/{sessionId}/statistics/statistic-parameter-values |
| Watch the Statistics Catalog. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog |
| Get a Statistic Category. |
| ||
| Get all Statistic Categories. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog Check for the |
| Get a Statistic Category’s Statistic Definitions. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog Check for the |
| Get all Statistic Definitions. |
| ||
| Get a Statistic Definition. |
| ||
| Get a Parameter Type. |
| ||
| Get all Parameter Types. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog Check for the |
| Get a Parameter’s Display String. |
| Feature: statistics Version: 1 | POST /icws/{sessionId}/statistics/statistic-parameter-values Check the response for the |
| Watch Statistic Values. |
| Feature: statistics Version: 1 | PUT /icws/{sessionId}/messaging/subscriptions/statistics/statistic-values Check for |
| Watch Memos. |
| ||
| Create a new Memo. |
| ||
| Delete a Memo. |
|
ICWS does not have support for the functionality provided by this IceLib namespace.
ICWS does not have support for the functionality provided by this IceLib namespace.
| Feature | IceLib API | ICWS Support | ICWS API |
|---|---|---|---|
| Send a fax from a fax file. |
| ||
| Load/save/modify fax files. |
| ||
| Receive notifications of fax status changes. |
| ||
| Retrieve fax server settings. |
| ||
| Cancel a fax. |
| ||
| Retrieve fax properties. |
| ||
| Refresh the fax cache. |
| ||
| Receive notifications of added/removed/updated faxes. |
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. |
| ||
| Receive notifications for when there are waiting voicemails. |
| ||
| Stop voicemail handset playback. |
| ||
| Update the Message Waiting Indicator light. |
| ||
| Refresh the voicemail cache. |
| ||
| Receive notifications of added/removed/updated voicemails. |
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. |
| ||
| Delete a voicemail message. |
| ||
| Start/Stop voicemail playback to a station. |
| ||
| Receive notification when a voicemail message station playback completes. |
| ||
| Play a voicemail to the handset. |
| ||
| Start/Stop voicemail playback to a specific number. |
| ||
| Save a voicemail as a file. |
| ||
| Cancel a voicemail file save. |
|