Interaction Center Web Services (ICWS)
Welcome
Releases
2022 R2
2022 R1
2021 R4
2021 R3
2021 R2
2021 R1
2020 R4
2020 R3
2020 R2
2020 R1
2019 R4
2019 R3
2019 R2
2019 R1
2018 R5
2018 R4
2018 R3
2018 R2
2018 R1
2017 R4
2017 R3
2017 R2
2017 R1
2016 R4
2016 R3
2016 R2
2016 R1
2015 R4
2015 R3
2015 R2
2015 R1
4.0 SU 6
Getting Started
Making Requests
Connecting
Event Subscriptions and Messaging
Language-specific Libraries
JavaScript Language-Specific Library
Objective-C Language-Specific Library
C# Language-Specific Library
Example Applications
Going Further
Configuration
Directories
Interactions and Queues
Statistics and Alerts
The Statistics Catalog
Interaction Dialer
IPA Product Information
IPA Resource Paths
IPA Page and Data Definitions File
Communicating with Handlers
Concepts
Design Principles
Representation Object Format
Documentation Conventions
Security
Web Proxies
Versioning
Coverage of IceLib APIs
Activations
/icws/{sessionId}/activations
users
GET
{userId}
GET
PUT
workgroups
GET
{workgroupId}
GET
PUT
/icws/{sessionId}/messaging/subscriptions/activations
users/{subscriptionId}
PUT
DELETE
workgroups/{subscriptionId}
PUT
DELETE
Alerts
/icws/{sessionId}/alerts
alert-catalog/alert-sets
POST
{alertSetId}
PUT
DELETE
memos
POST
{memoId}
DELETE
/icws/{sessionId}/messaging/subscriptions/alerts
alert-catalog
PUT
DELETE
alert-notifications
PUT
DELETE
user-memos
PUT
DELETE
Client Buttons
/icws/{sessionId}/client-buttons
handler-action
POST
Configuration
Analytics
Collective
Peer Sites
/icws/{sessionId}/configuration
peer-sites
GET
peer-sites/{id}
GET
Emergency
Hardware
Audio Sources
/icws/{sessionId}/configuration
audio-sources
GET
POST
audio-sources/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
audio-sources/{subscriptionId}
PUT
DELETE
Default Location Configuration
/icws/{sessionId}/configuration
default-location
GET
Line Groups
/icws/{sessionId}/configuration
line-groups
GET
POST
line-groups/{id}
GET
DELETE
PUT
Lines
/icws/{sessionId}/configuration
lines
GET
POST
lines/{id}
GET
DELETE
PUT
defaults/line
GET
Locations
/icws/{sessionId}/configuration
locations
GET
POST
locations/{id}
GET
Media Servers
/icws/{sessionId}/configuration
media-servers
GET
media-servers/{id}
GET
Recording Beep Tones
/icws/{sessionId}/configuration
recording-beep-tones
GET
POST
recording-beep-tones/{id}
GET
DELETE
PUT
defaults/recording-beep-tone
GET
/icws/{sessionId}/messaging/subscriptions/configuration
recording-beep-tones/{subscriptionId}
PUT
DELETE
Selection Rules
/icws/{sessionId}/configuration
selection-rules
GET
selection-rules/{id}
GET
Sip Bridges
/icws/{sessionId}/configuration
sip-bridges
GET
sip-bridges/{id}
GET
Station Groups
/icws/{sessionId}/configuration
station-groups
GET
station-groups/{id}
GET
Structured Parameters
/icws/{sessionId}/configuration
structured-parameters
GET
POST
structured-parameters/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
structured-parameters/{subscriptionId}
PUT
DELETE
Integrations
Bots
/icws/{sessionId}/configuration
bots
GET
POST
bots/{id}
GET
DELETE
PUT
Salesforce CTI Attribute Maps
/icws/{sessionId}/configuration
salesforce-cti-configurations/{id}/salesforce-cti-attribute-maps
POST
defaults/salesforce-cti-attribute-map
GET
Salesforce CTI Configurations
/icws/{sessionId}/configuration
salesforce-cti-configurations
GET
POST
salesforce-cti-configurations/{id}
GET
DELETE
PUT
defaults/salesforce-cti-configuration
GET
/icws/{sessionId}/messaging/subscriptions/configuration
salesforce-cti-configurations/{subscriptionId}
PUT
DELETE
Widgets
/icws/{sessionId}/configuration
widgets
GET
POST
widgets/{id}
GET
DELETE
PUT
Interaction Analyzer
/icws/{sessionId}/configuration
interaction-analyzer/licensed-languages
GET
interaction-analyzer/supported-languages
GET
Keyword Sets
/icws/{sessionId}/configuration
keyword-sets
GET
POST
keyword-sets/{id}
GET
DELETE
keyword-sets/preview-keyword-runtime
GET
/icws/{sessionId}/messaging/subscriptions/configuration
keyword-sets/{subscriptionId}
PUT
DELETE
Keywords
/icws/{sessionId}/configuration
defaults/keyword
GET
Interaction Dialer
Interaction Dialer Call List Acls
/icws/{sessionId}/configuration
interaction-dialer-call-list-acls
GET
interaction-dialer-call-list-acls/{id}
GET
Interaction Dialer Campaign Acls
/icws/{sessionId}/configuration
interaction-dialer-campaign-acls
GET
interaction-dialer-campaign-acls/{id}
GET
Interaction Dialer Policy Set Acls
/icws/{sessionId}/configuration
interaction-dialer-policy-set-acls
GET
interaction-dialer-policy-set-acls/{id}
GET
Interaction Dialer Rule Set Acls
/icws/{sessionId}/configuration
interaction-dialer-rule-set-acls
GET
interaction-dialer-rule-set-acls/{id}
GET
Interaction Dialer Schedule Acls
/icws/{sessionId}/configuration
interaction-dialer-schedule-acls
GET
interaction-dialer-schedule-acls/{id}
GET
Interaction Dialer Script Acls
/icws/{sessionId}/configuration
interaction-dialer-script-acls
GET
interaction-dialer-script-acls/{id}
GET
Interaction Dialer Skill Set Acls
/icws/{sessionId}/configuration
interaction-dialer-skill-set-acls
GET
interaction-dialer-skill-set-acls/{id}
GET
Interaction Dialer Stage Set Acls
/icws/{sessionId}/configuration
interaction-dialer-stage-set-acls
GET
interaction-dialer-stage-set-acls/{id}
GET
Interaction Dialer Zone Set Acls
/icws/{sessionId}/configuration
interaction-dialer-zone-set-acls
GET
interaction-dialer-zone-set-acls/{id}
GET
Interaction Optimizer
Interaction Optimizer Scheduling Units
/icws/{sessionId}/configuration
interaction-optimizer-scheduling-units
GET
interaction-optimizer-scheduling-units/{id}
GET
Interaction Recorder
Interaction Recorder Configuration
/icws/{sessionId}/configuration
interaction-recorder-configuration
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
interaction-recorder-configuration/{subscriptionId}
PUT
DELETE
Interaction Recorder Questionnaires
/icws/{sessionId}/configuration
interaction-recorder-questionnaires
GET
interaction-recorder-questionnaires/{id}
GET
People
Access Control Groups
/icws/{sessionId}/configuration
access-control-groups
GET
POST
access-control-groups/{id}
GET
DELETE
PUT
access-control-groups/are-in-use
GET
access-control-groups/{id}/{objectType}/assign-membership
POST
access-control-groups/assignable/{objectType}
GET
/icws/{sessionId}/messaging/subscriptions/configuration
access-control-groups/{subscriptionId}
PUT
DELETE
Account Codes
/icws/{sessionId}/configuration
account-codes
GET
POST
account-codes/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
account-codes/{subscriptionId}
PUT
DELETE
Account Codes Configuration
/icws/{sessionId}/configuration
account-codes-configuration
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
account-codes-configuration/{subscriptionId}
PUT
DELETE
Client Buttons
/icws/{sessionId}/configuration
client-buttons
GET
POST
client-buttons/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
client-buttons/{subscriptionId}
PUT
DELETE
Client Configuration Templates
/icws/{sessionId}/configuration
client-configuration-templates
GET
POST
client-configuration-templates/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
client-configuration-templates/{subscriptionId}
PUT
DELETE
Client Templates
/icws/{sessionId}/configuration
client-templates
GET
client-templates/{id}
GET
DELETE
defaults/client-template
GET
/icws/{sessionId}/messaging/subscriptions/configuration
client-templates/{subscriptionId}
PUT
DELETE
Default User Configuration
/icws/{sessionId}/configuration
default-user
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
default-user/{subscriptionId}
PUT
DELETE
Monitored Mailboxes
/icws/{sessionId}/configuration
workgroups/{id}/monitored-mailboxes
POST
defaults/monitored-mailbox
GET
Password Policies
/icws/{sessionId}/configuration
password-policies
GET
POST
password-policies/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
password-policies/{subscriptionId}
PUT
DELETE
Queue Columns
/icws/{sessionId}/configuration
queue-columns
GET
POST
queue-columns/{id}
GET
DELETE
PUT
defaults/queue-column
GET
/icws/{sessionId}/messaging/subscriptions/configuration
queue-columns/{subscriptionId}
PUT
DELETE
Response Management Documents
/icws/{sessionId}/configuration
response-management-documents
GET
response-management-documents/{id}
GET
DELETE
/icws/{sessionId}/messaging/subscriptions/configuration
response-management-documents/{subscriptionId}
PUT
DELETE
Roles
/icws/{sessionId}/configuration
roles
GET
POST
roles/{id}
GET
DELETE
PUT
defaults/role
GET
/icws/{sessionId}/messaging/subscriptions/configuration
roles/{subscriptionId}
PUT
DELETE
Schedules
/icws/{sessionId}/configuration
schedules
GET
POST
schedules/{id}
GET
DELETE
PUT
defaults/schedule
GET
/icws/{sessionId}/messaging/subscriptions/configuration
schedules/{subscriptionId}
PUT
DELETE
Secure Input Forms
/icws/{sessionId}/configuration
secure-input-forms
GET
POST
secure-input-forms/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
secure-input-forms/{subscriptionId}
PUT
DELETE
Skill Categories
/icws/{sessionId}/configuration
skill-categories
GET
POST
skill-categories/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
skill-categories/{subscriptionId}
PUT
DELETE
Skills
/icws/{sessionId}/configuration
skills
GET
POST
skills/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
skills/{subscriptionId}
PUT
DELETE
Statistic Parameter Groups
/icws/{sessionId}/configuration
statistic-parameter-groups
GET
POST
statistic-parameter-groups/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
statistic-parameter-groups/{subscriptionId}
PUT
DELETE
Status Columns
/icws/{sessionId}/configuration
status-columns
GET
status-columns/{id}
GET
Users
/icws/{sessionId}/configuration
users
GET
POST
users/{id}
GET
DELETE
PUT
defaults/user
GET
users/{id}/client
PUT
users/{id}/password
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
users/{subscriptionId}
PUT
DELETE
Workgroups
/icws/{sessionId}/configuration
workgroups
GET
POST
workgroups/{id}
GET
DELETE
PUT
defaults/workgroup
GET
/icws/{sessionId}/messaging/subscriptions/configuration
workgroups/{subscriptionId}
PUT
DELETE
Wrap Up Categories
/icws/{sessionId}/configuration
wrap-up-categories
GET
POST
wrap-up-categories/{id}
GET
DELETE
PUT
defaults/wrap-up-category
GET
/icws/{sessionId}/messaging/subscriptions/configuration
wrap-up-categories/{subscriptionId}
PUT
DELETE
Wrap Up Codes
/icws/{sessionId}/configuration
wrap-up-codes
GET
POST
wrap-up-codes/{id}
GET
DELETE
PUT
defaults/wrap-up-code
GET
/icws/{sessionId}/messaging/subscriptions/configuration
wrap-up-codes/{subscriptionId}
PUT
DELETE
Reporting
Historical Reports
/icws/{sessionId}/configuration
historical-reports
GET
historical-reports/{id}
GET
Legacy Historical Reports
/icws/{sessionId}/configuration
legacy-historical-reports
GET
legacy-historical-reports/{id}
GET
Report Logs
/icws/{sessionId}/configuration
report-logs
GET
report-logs/{id}
GET
System
/icws/{sessionId}/configuration
system
GET
PUT
system/languages
GET
system/ivr-handlers
GET
system/time-zones
GET
/icws/{sessionId}/messaging/subscriptions/configuration
system/{subscriptionId}
PUT
DELETE
Accumulators
/icws/{sessionId}/configuration
accumulators
GET
accumulators/{id}
GET
Actions
/icws/{sessionId}/configuration
actions
GET
POST
actions/{id}
GET
DELETE
PUT
defaults/action
GET
/icws/{sessionId}/messaging/subscriptions/configuration
actions/{subscriptionId}
PUT
DELETE
Attendant Email Profiles
/icws/{sessionId}/configuration
attendant-email-profiles
GET
attendant-email-profiles/{id}
GET
Attendant Inbound Profiles
/icws/{sessionId}/configuration
attendant-inbound-profiles
GET
attendant-inbound-profiles/{id}
GET
Attendant Operator Profiles
/icws/{sessionId}/configuration
attendant-operator-profiles
GET
attendant-operator-profiles/{id}
GET
Attendant Outbound Profiles
/icws/{sessionId}/configuration
attendant-outbound-profiles
GET
attendant-outbound-profiles/{id}
GET
Certificates Configuration
/icws/{sessionId}/configuration
certificates/subsystem-certificates
GET
certificates/trust-subsystem-certificate
PUT
Contact List Sources
/icws/{sessionId}/configuration
contact-list-sources
GET
contact-list-sources/{id}
GET
Dial Plan Classifications
/icws/{sessionId}/configuration
dial-plan-classifications
GET
dial-plan-classifications/{id}
GET
/icws/{sessionId}/messaging/subscriptions/configuration
dial-plan-classifications/{subscriptionId}
PUT
DELETE
Dnis Mappings Configuration
/icws/{sessionId}/configuration
dnis-mappings
GET
PUT
E Faqs
/icws/{sessionId}/configuration
e-faqs
GET
e-faqs/{id}
GET
Fax Groups
/icws/{sessionId}/configuration
fax-groups
GET
fax-groups/{id}
GET
Feature Licenses
/icws/{sessionId}/configuration
feature-licenses
GET
feature-licenses/{id}
GET
Feedback Survey Groups
/icws/{sessionId}/configuration
feedback-survey-groups
GET
feedback-survey-groups/{id}
GET
Feedback Surveys
/icws/{sessionId}/configuration
feedback-surveys
GET
feedback-surveys/{id}
GET
Handlers
/icws/{sessionId}/configuration
handlers
GET
handlers/{id}
GET
Ic Data Sources
/icws/{sessionId}/configuration
ic-data-sources
GET
POST
ic-data-sources/{id}
GET
DELETE
PUT
Image Resource Categories
/icws/{sessionId}/configuration
image-resource-categories
GET
image-resource-categories/{id}
GET
Image Resources
/icws/{sessionId}/configuration
image-resources
GET
image-resources/{id}
GET
DELETE
/icws/{sessionId}/messaging/subscriptions/configuration
image-resources/{subscriptionId}
PUT
DELETE
Initialization Functions
/icws/{sessionId}/configuration
initialization-functions
GET
initialization-functions/{id}
GET
Interaction Client Plugins
/icws/{sessionId}/configuration
interaction-client-plugins
GET
interaction-client-plugins/{id}
GET
Interaction Conference Rooms
/icws/{sessionId}/configuration
interaction-conference-rooms
GET
interaction-conference-rooms/{id}
GET
Interaction Process Automation Processes
/icws/{sessionId}/configuration
interaction-process-automation-processes
GET
interaction-process-automation-processes/{id}
GET
Interaction Processor Tables
/icws/{sessionId}/configuration
interaction-processor-tables
GET
interaction-processor-tables/{id}
GET
Layouts
/icws/{sessionId}/configuration
layouts
GET
POST
layouts/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
layouts/{subscriptionId}
PUT
DELETE
License Allocations
/icws/{sessionId}/configuration
license-allocations
GET
license-allocations/{id}
GET
Lines Authority Certificates
/icws/{sessionId}/configuration
lines-authority-certificates
GET
lines-authority-certificates/{id}
GET
Login Authentication Configuration
/icws/{sessionId}/configuration
login-authentication
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
login-authentication/{subscriptionId}
PUT
DELETE
Mail Configuration
/icws/{sessionId}/configuration
mail/imap-smtp-mailbox-attributes
GET
mail/interaction-message-store-mailbox-attributes
GET
mail/no-mailbox-attributes
GET
mail/enabled-mailbox-providers
GET
mail/imap-servers
GET
mail/searchable-providers
GET
mail/folders
GET
mail/test-mailbox
GET
mail/directories
GET
mail/send-email
POST
mail/test-moniker
GET
Interaction Message Store Mailbox Configuration
/icws/{sessionId}/configuration
interaction-message-store-mailbox/users
GET
Miscellaneous Items
/icws/{sessionId}/configuration
miscellaneous-items
GET
miscellaneous-items/{id}
GET
Positions
/icws/{sessionId}/configuration
positions
GET
POST
positions/{id}
GET
DELETE
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
positions/{subscriptionId}
PUT
DELETE
Problem Reporter Configuration
/icws/{sessionId}/configuration
problem-reporter
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
problem-reporter/{subscriptionId}
PUT
DELETE
Server Parameters
/icws/{sessionId}/configuration
server-parameters
GET
POST
server-parameters/{id}
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
server-parameters/{subscriptionId}
PUT
DELETE
Single Sign On Identity Providers
/icws/{sessionId}/configuration
single-sign-on-identity-providers
GET
single-sign-on-identity-providers/{id}
GET
Sms Brokers
/icws/{sessionId}/configuration
sms-brokers
GET
sms-brokers/{id}
GET
Status Messages
/icws/{sessionId}/configuration
status-messages
GET
POST
status-messages/{id}
GET
DELETE
PUT
System Parameters
/icws/{sessionId}/configuration
system-parameters
GET
POST
system-parameters/{id}
GET
PUT
/icws/{sessionId}/messaging/subscriptions/configuration
system-parameters/{subscriptionId}
PUT
DELETE
Update Service Configuration
/icws/{sessionId}/configuration
update-service
GET
PUT
Web Services Parameters
/icws/{sessionId}/configuration
web-services-parameters
GET
web-services-parameters/{id}
GET
Transaction
/icws/{sessionId}/configuration
transaction
POST
{transactionId}/transaction-end
POST
Connection
/icws
connection
POST
version
GET
features
GET
{featureId}
GET
server-info
GET
single-sign-on/identity-providers/{identityProviderId}
GET
single-sign-on/return
GET
POST
single-sign-on/saml-ecp/{identityProviderId}
GET
POST
single-sign-on/response
GET
server-time
GET
/icws/{sessionId}
connection
GET
DELETE
switchover-status
GET
station
DELETE
PUT
GET
unique-auth-token
POST
/icws/{sessionId}/messaging/subscriptions/connection
station
PUT
DELETE
Data Dictionary
/icws/{sessionId}
data-dictionary
GET
tables
GET
views
GET
stored-procedures
GET
data-set-names
GET
Data Extractor
/icws/{sessionId}/data-extractor
jobs
GET
POST
jobs/{jobId}
GET
DELETE
/icws/{sessionId}/messaging/subscriptions/data-extractor
jobs-statuses
PUT
DELETE
Dialer
/icws/{sessionId}
dialer/log-in
POST
dialer/log-off
POST
dialer/ready-for-calls
POST
dialer/disposition
POST
dialer/request-break
POST
dialer/end-break
POST
dialer/place-preview-call
POST
dialer/establish-persistent-connection
POST
dialer/request-form-definition
POST
dialer/update-call-data
POST
dialer/reset-campaign
POST
dialer/recycle-campaign
POST
dialer/transition-campaign
POST
dialer/initiate-manual-outbound-call
POST
dialer/perform-call-list-query
POST
dialer/request-phone-number-details
POST
dialer/set-agent-type
POST
dialer/mark-call-for-finishing
POST
dialer/transfer-to-attendant-profile
POST
dialer/request-contact-data
POST
dialer/update-stage
POST
dialer/allocate-agents
POST
Directories
/icws/{sessionId}/messaging/subscriptions
directories
PUT
DELETE
directories/{subscriptionId}
PUT
DELETE
/icws/{sessionId}
directories
lookup-entries
POST
contacts/{directoryID}
POST
{entryID}
PUT
DELETE
speed-dial
POST
{speedDialDirectoryId}
PUT
DELETE
{speedDialDirectoryId}/links
POST
{speedDialLinkId}
PUT
DELETE
Interactions
/icws/{sessionId}
interactions
POST
{interactionId}
GET
POST
agent-assistance
POST
blind-transfer
POST
transfer-to-voicemail
POST
park
POST
callback/disposition
PUT
chat/messages
POST
chat/send-file
POST
chat/send-file/invitation
POST
chat/send-file/invitation-active
GET
chat/send-response-management-file
POST
chat/typing-indicator
PUT
coach
POST
consult
POST
{consultId}
DELETE
change-audience
POST
conclude
POST
disconnect
POST
email/attachments/message/download
POST
email/attachments/file/upload
POST
email/attachments/response-management/insert
POST
email/attachments/file/remove
POST
email/save
POST
email/send
POST
hold
POST
invite-party
POST
join
POST
listen
POST
mute
POST
pause
POST
record-snippet
POST
secure-pause
POST
pickup
POST
play-wav
POST
make-private
POST
record
POST
send-to-voicemail
POST
send-digits
POST
wrap-up-assignments
POST
conferences
POST
{conferenceId}
PUT
invite-party
POST
email/resolve-address
POST
agent-assistance/{assistanceId}
DELETE
POST
/icws/{sessionId}/messaging/subscriptions
interactions/{interactionId}
PUT
DELETE
callback
PUT
DELETE
chat
PUT
DELETE
email
PUT
DELETE
interactions/agent-assistance
PUT
DELETE
{assistanceId}
PUT
DELETE
interaction-alerting
PUT
DELETE
interaction-history
PUT
DELETE
Journey Map
/icws/{sessionId}/journeymap
individual
POST
GET
individual/{individualId}
GET
PUT
organization
POST
GET
organization/{organizationId}
GET
PUT
location/{locationId}
GET
resolve-interaction
PUT
config-attribute
GET
login-user-info
GET
interaction/{icuserindivid}/{interactionId}
GET
/icws/{sessionId}/messaging/subscription/journeymap
related-interaction/{subscriptionId}
PUT
DELETE
Licenses
/icws/{sessionId}
licenses
POST
PUT
DELETE
license-stages
POST
/icws/{sessionId}/messaging/subscriptions
licenses
PUT
DELETE
Messaging
/icws/{sessionId}/messaging
messages
GET
Event Source
heartbeat
POST
Phone Numbers
/icws/{sessionId}/phone-numbers
query-details
POST
Process Automation
/icws/{sessionId}/ipa
process-instances
POST
GET
workitem-instances/{workItemInstanceId}/current-page
POST
/icws/{sessionId}/messaging/subscriptions/ipa
pas
PUT
DELETE
launchable-processes
PUT
DELETE
workitem-instances/{workItemInstanceId}/current-page
PUT
DELETE
Quality Management
/icws/{sessionId}/agent-quality
questionnaires
POST
{questionnaireId}
GET
questionnaire-directories
POST
GET
{directoryId}
DELETE
rank-groups
GET
scorecards/{scorecardId}
GET
acknowledge
PUT
search
POST
{searchId}
GET
DELETE
Queues
/icws/{sessionId}/messaging/subscriptions/queues
{subscriptionId}
PUT
DELETE
Recordings Management
/icws/{sessionId}/recordings
{recordingId}/tags
GET
PUT
DELETE
{recordingId}/attributes
GET
PUT
DELETE
{recordingId}/export-uri
GET
play/station-audio
start/{recordingId}
POST
stop/{playbackInteractionId}
POST
send-as-email
PUT
{recordingId}/send-as-email
PUT
{recordingId}/media-details
GET
{recordingId}/retention-expiration
POST
/icws/{sessionId}/screenrecordings
record
start/{recordedUserId}
POST
stop/{recordedUserId}
POST
pause/{recordedUserId}
POST
resume/{recordedUserId}
POST
Response Management
/icws/{sessionId}
response-management
PUT
file
POST
/icws/{sessionId}/messaging/subscriptions
response-management
PUT
DELETE
Security
/icws/{sessionId}/security
password
POST
Session
/icws/{sessionId}/messaging/subscriptions/session
sessions-users
PUT
DELETE
sessions-stations
PUT
DELETE
sessions-layouts
PUT
DELETE
Social Media
/icws/{sessionId}
social-media
GET
POST
PUT
DELETE
account
GET
POST
PUT
DELETE
facebook
account
POST
{accountId}
GET
PUT
DELETE
channel
POST
{channelId}
GET
PUT
DELETE
channels
GET
accounts
GET
twitter
account
POST
{accountId}
GET
PUT
DELETE
channel
POST
{channelId}
GET
PUT
DELETE
channels
GET
accounts
GET
Statistics
/icws/{sessionId}/statistics
statistic-parameter-values
POST
queries
POST
chained-parameters-validator
POST
/icws/{sessionId}/messaging/subscriptions/statistics
statistic-catalog
PUT
DELETE
statistic-values
PUT
DELETE
statistic-parameter-values
PUT
DELETE
Status
/icws/{sessionId}/status
status-messages
GET
status-messages-user-access/{userId}
GET
user-statuses/{userId}
GET
PUT
user-status-previous-info/{userId}
GET
/icws/{sessionId}/messaging/subscriptions/status
status-messages
PUT
DELETE
status-messages-user-access
PUT
DELETE
user-statuses
PUT
DELETE
user-status-previous-info
PUT
DELETE
System
/icws/{sessionId}/system
handler-notification
POST
/icws/{sessionId}/messaging/subscriptions/system
handler-sent-notifications
PUT
DELETE
Unified Messaging
/icws/{sessionId}/unified-messaging
{unifiedMessageId}
PUT
DELETE
voicemail-message/play/start
POST
voicemail-message/play/stop
POST
messages-waiting-indicator/count-refresh
PUT
/icws/{sessionId}/messaging/subscriptions/unified-messaging
voicemail-messages
PUT
DELETE
fax-messages
PUT
DELETE
messages-waiting-indicator
PUT
DELETE
Voice Prompts
/icws/{sessionId}/voice-prompts
all
commit
POST
clear
POST
cancel
POST
greeting
activation
PUT
GET
record
POST
commit
POST
preview
POST
clear
POST
cancel
POST
outofoffice
activation
PUT
GET
record
POST
commit
POST
preview
POST
clear
POST
cancel
POST
noanswer
record
POST
commit
POST
preview
POST
clear
POST
cancel
POST
followme
record
POST
commit
POST
preview
POST
clear
POST
cancel
POST
name
record
POST
commit
POST
preview
POST
clear
POST
cancel
POST
forward
record
POST
commit
POST
preview
POST
clear
POST
cancel
POST
Web Callback
/icws/web-callback
create
POST
status/{participantId}
GET
exit/{participantId}
POST
reconnect
POST
Web Chat
/icws/web-chat
start
POST
exit/{participantId}
POST
reconnect
POST
typing-state/{participantId}
POST
send-message/{participantId}
POST
file/{participantId}/{fileGuid}/{fileName}
GET
messages/{participantId}
GET
message-history/{participantId}
GET
Widgets
/icws/widgets
registration/{id}
GET
handler-notification
POST
Workforce Management
/icws/{sessionId}/messaging/subscriptions/wfm-data
data-versions
PUT
DELETE
/icws/{sessionId}/wfm
time-off
POST
{timeOffRequestId}
PUT
trade-requests
POST
{shiftTradeRequestId}
PUT
trade-matches/{shiftTradeMatchId}
PUT
data
GET
matching-tradecounts
GET
matching-tradeinfo
GET
perform-trade
POST
scheduledatesrange
GET
Expand All
Collapse All
Feature Licenses
The Feature License Configuration Service provides access to the Feature License configuration data.
/icws/{sessionId}/configuration
Resources
/icws/{sessionId}/configuration/feature-licenses
GET
/icws/{sessionId}/configuration/feature-licenses/{id}
GET
Genesys © 2022
CIC 2022 R3
Developer Portal