Genesys Engage

Web Services and Applications

Web Services and Applications

Web Services API Reference
Getting started
Making a Request
Interpreting a response
Working with agents
Answering a call
API basics
What are operations?
What are capabilities?
CometD notifications
Error handling
Request Parameters
Working with roles
Filtering
Filtering and sorting users by fields and subresources
Subresources
Return Values
Recovering Existing State
Toast and case data
Disposition codes
Cross-Origin Resource Sharing
Cross-Site Request Forgery protection
Features
Services
Voice API
CometD notifications
Call resource
Device resource
StartContactCenterSession
EndContactCenterSession
Ready
Not Ready
Aux Work
After Call Work
Offline
DoNotDisturbOn
DoNotDisturbOff
ForwardCallsOn
ForwardCallsOff
Dial
Answer
Reject
Hold
Retrieve
Hangup
SendDTMF
MuteCall
UnmuteCall
SetCallDisposition
SingleStepConference
InitiateConference
CompleteConference
RemoveParticipantFromConference
ClearCall
SingleStepTransfer
InitiateTransfer
CompleteTransfer
SwapCalls
MergeWithOtherCall
AttachUserData
UpdateUserData
DeleteUserData
DeleteUserDataPair
ListenIn
Coach
BargeIn
CancelSupervisionMonitoring
SwitchToBargeIn
SwitchToListenIn
MuteMonitoredUser
UnmuteMonitoredUser
StartCallRecording
PauseCallRecording
ResumeCallRecording
StopCallRecording
IM Session API
CometD notifications
IM Session Resource
InitiateIMSession
SendMessage
AttachUserData
UpdateUserData
DeleteUserData
Complete
Multimedia Interactions API
Chat API
CometD notifications
Chat Resource
Accept
Reject
SendMessage
Leave
Complete
SendURL
AddAttachment
GetAttachment
RemoveAttachment
UploadFile
DeleteFile
SendStartTypingNotification
SendStopTypingNotification
SetInFocus
SetDisposition
AddComment
SendCustomNotice
AttachUserData
UpdateUserData
DeleteUserData
Transfer
Invite
Consult
CancelConsult
SendToAgents
SendStartTypingToAgentsNotification
SendStopTypingToAgentsNotification
RemoveParticipantFromConference
SendCustomNoticeToAgents
Supervisor Monitoring
Monitor
Coach
BargeIn
CancelSupervisorMonitoring
Intrude
SwitchToBargeIn
SwitchToMonitor
SwitchToCoach
GetAgentInteractions
SendNicknameUpdatedNotice
Customer Chat API
General
Customer Chat Resource
Customer Chat Messages
RequestChat
SendMessage
SendStartTypingNotification
SendStopTypingNotification
Complete
GetChat
GetMessages
Digital User Events API
Publish
Subscribe
Unsubscribe
Email API
CometD notifications
Email Resource
Accept
Reject
Create
Save
Cancel
Reply
ReplyAll
Send
SetDisposition
Complete
AttachUserData
UpdateUserData
DeleteUserData
AddComment
SetInFocus
AddAttachment
GetAttachment
RemoveAttachment
Transfer
Facebook API
CometD notifications
Facebook Resource
Accept
Reject
Create
Save
Cancel
Reply
Send
SetDisposition
Complete
AttachUserData
UpdateUserData
DeleteUserData
AddComment
SetInFocus
Transfer
Facebook Private Messaging API
CometD notifications
FacebookSession Resource
Accept
Reject
SendMessage
SendUrl
SetInFocus
SetDisposition
Leave
Complete
AttachUserData
UpdateUserData
DeleteUserData
AddComment
Transfer
Consult
SendToAgents
RemoveParticipantFromConference
ReportStandardResponseUsage FacebookSession
Open Media API
CometD notifications
OpenMedia Resource
Create
Accept
Reject
SetInFocus
Complete
AddContent
GetContent
AttachUserData
UpdateUserData
DeleteUserData
Transfer
SMS Session API
SMS Session Resource
Accept
Reject
SendMessage
Leave
Complete
SendURL
SendStartTypingNotification
SendStopTypingNotification
SetInFocus
SetDisposition
AddComment
SendCustomNotice
GetMessages
AttachUserData
UpdateUserData
DeleteUserData
Transfer
Invite
Consult
CancelConsult
SendToAgents
SendStartTypingToAgentsNotification
SendStopTypingToAgentsNotification
RemoveParticipantFromConference
SendCustomNoticeToAgents
Monitor
Coach
BargeIn
CancelSupervisorMonitoring
Intrude
SwitchToBargeIn
SwitchToMonitor
SwitchToCoach
GetAgentInteractions
Standard Responses API
GetStandardResponse
RenderStandardResponse
ReportStandardResponseUsage
GetStandardResponseFavorites
AddStandardResponseFavorite
DeleteStandardResponseFavorite
DeleteAllStandardResponseFavorites
GetDocumentStandardResponse
Twitter API
CometD notifications
Twitter Resource
Accept
Reject
Create
Save
Cancel
Reply
Send
SetDisposition
Complete
AttachUserData
UpdateUserData
DeleteUserData
AddComment
SetInFocus
Follow
Unfollow
Retweet
Transfer
Workbins API
CometD notifications
Workbin Resource
GetWorkbins
GetWorkbinContent
AddInteractionToWorkbin
PullInteractionFromWorkbin
Subscribe To Workbin Notifications
Unsubscribe from Workbin Notifications
PullInteractionFromWorkbin for Supervisor
AddInteractionToWorkbin for Supervisor
GetGroupWorkbinContent
AddInteraction to a Group Workbin
PullInteraction from a Group Workbin
Subscribe to Group Workbin Notifications
Unsubscribe from Group Workbin Notifications
RequestStats
RequestAgentStats
Workitem API
CometD notifications
Workitem Resource
Workitem Create
Workitem Accept
Workitem Reject
Workitem SetInFocus
Workitem Complete
Workitem AttachUserData
Workitem UpdateUserData
Workitem DeleteUserData
Workitem Transfer
Channels API
Channel resource
Get all channels
Get channel by ID
Set channel to Ready
Set channel to NotReady
Set all channels to Ready
Set all channels to NotReady
Set all channels to DNDOn
Set all channels to DNDOff
Provisioning API
Business Unit API
Create a Business Unit
Remove Business Unit
Assign Supervisor to Business Unit
Assign Queue to Business Unit
Remove Queue from Business Unit
Bulk Assign Queues to a Business Unit
Assign Skill to a Business Unit
Remove Skill from a Business Unit
Bulk Assign Skills to a Business Unit
Assign Agent to Business Unit
Remove Agent from Business Unit
Bulk Assign Agents to as Business Unit
Assign Business Unit To Agent
Remove Business Unit from Agent
Retrieve Business Unit Content
Retrieve Business Units list
Devices API
Operations
Attributes
List Devices
Create Device
Delete Device
Assign Device
Unassign Device
Create and Assign Device to User
Place Management API
List Places
List Place by ID
List Places Assigned to User
List Places Assigned to Business Unit
Create
Update
Delete
Assign Device to Place
Unassign Device from Place
Assign Place to User
Unassign Place from User
Assign Place to Business Unit
Unassign Place from Business Unit
Users API
User Resource
Create User
Delete User
Update User
Get all Users
Get a Specific User
Get all Sub-Resources for a User
Unlock User Account
User Settings API
Get Settings Groups
Create Settings Group
Delete Settings Group
Get Settings
Create Setting
Update Setting
Delete Setting
Contacts API
Contact resource
Get contacts
Create a custom contact
Update a custom contact
Delete a custom contact
Settings API
Settings resource
System settings
Custom settings
Statistics API
Monitored statistics
Get most recent statistic values
Hierarchical Dispositions API
Retrieve all configured dispositions in a specific disposition group
Retrieve full contents of a specific disposition category
Retrieve full disposition and category tree
Create a new disposition
Remove a disposition
Create sub-category of dispositions
Create top-level disposition group
Remove sub-category of dispositions
Remove root-level disposition group
Configuration Manager Scenarios
Platform Configuration API
Outbound API
Outbound Campaign Resource
Outbound Record Resource
Request Campaign Status
Start Preview Session
End Preview Session
Request Preview Record
Dial Preview Record
Reject Record
Cancel Record
Cancel Record with Phone Number
Complete Record
Do Not Call Record
Do Not Call Record with Phone Number
Create Record
Update Record
Get Chained Record
Reschedule Record
Incoming Call From an Outbound Campaign
Interaction History API
CometD notifications
Interaction history resource
Message resource
RetrieveContactHistory
RetrieveAgentHistory
RetrieveInteractionHistory
GetInteractionContent
UCS Integration with Voice API
IdentifyUCSContact
FindPhoneCall
SetCallNote
SetCallCompleted
SetCallContact
Supervisor Agent State Control API
Ready
NotReady
DoNotDisturbOff
DoNotDisturbOn
Offline
Service API
Runtime
Configuration

Other guides

Web Services and Applications Deployment Guide
Web Services and Applications Configuration Guide
Workspace Web Edition Developer’s Guide and API Reference
Gplus Adapter User Guide
Web Services and Applications Migration Guide
Library

8.5.2

Jump to: navigation, search

Invite

This page was last edited on March 23, 2014, at 16:13.

Comments or questions about this documentation? Contact us for support!

Contact

Contact Us

Genesys

Genesys Forums
Corporate Website

Customer Care

Customer Care Website
Support Guide – On-Premises
Support Guide – Cloud
Support Guide – Custom Apps

Legal

Legal Notices
General Disclaimer

Log in