API Table of Contents Page

Welcome title: Web Services API Reference

Examples does not exist. Click to create Examples in 8.5.2DRAFT

• Setup does not exist. Click to create Setup in 8.5.2DRAFT
  
• HelloWorldExample does not exist. Click to create HelloWorldExample in 8.5.2DRAFT
  
• GetUserInfo does not exist. Click to create GetUserInfo in 8.5.2DRAFT
  
• CSRFExample does not exist. Click to create CSRFExample in 8.5.2DRAFT
  

General title: API basics

• WhatAreOperations title: What are operations?
  
• WhatAreCapabilities title: What are capabilities?
  
• AgentStateOperations does not exist. Click to create AgentStateOperations in 8.5.2DRAFT
  
• AsynchronousEvents title: CometD notifications
  
• ErrorHanding does not exist. Click to create ErrorHanding in 8.5.2DRAFT
  
• RecoveringExistingState title: Recovering Existing State
  
• WorkingWithSettings does not exist. Click to create WorkingWithSettings in 8.5.2DRAFT
  
• ToastAndCaseData title: Toast and case data
  
• DispositionCodes does not exist. Click to create DispositionCodes in 8.5.2DRAFT
  
• RequestTypes title: Request Parameters
  
• ReturnValues title: Return Values
  
• Subresources title: Subresources
  
• Filtering title: Filtering
  
• FilteringAndSorting title: Filtering and sorting users by fields and subresources
  
• CORS title: Cross-Origin Resource Sharing
  
• CSRFProtection title: Cross-Site Request Forgery protection
  
• Features title: Features
  
• Services title: Services
  

VoiceAPI title: Voice API

• Calls does not exist. Click to create Calls in 8.5.2DRAFT
  
  • CallsDial title: Dial
    
  • CallsAnswer title: Answer
    
  • CallsReject title: Reject
    
  • CallsHold title: Hold
    
  • CallsRetrieve title: Retrieve
    
  • CallsHangup title: Hangup
    
  • CallsSendDTMF title: SendDTMF
    
  • CallsMuteCall title: MuteCall
    
  • CallsUnmuteCall title: UnmuteCall
    
  • CallsSetCallDisposition title: SetCallDisposition
    

• CallForwarding does not exist. Click to create CallForwarding in 8.5.2DRAFT
  
  • ForwardCallsOn title: ForwardCallsOn
    
  • ForwardCallsOff title: ForwardCallsOff
    

• ConferencesAndTransfers does not exist. Click to create ConferencesAndTransfers in 8.5.2DRAFT
  
  • SingleStepConference title: SingleStepConference
    
  • InitiateConference title: InitiateConference
    
  • CompleteConference title: CompleteConference
    
  • SingleStepTransfer title: SingleStepTransfer
    
  • InitiateTransfer title: InitiateTransfer
    
  • CompleteTransfer title: CompleteTransfer
    
  • RemoveParticipantFromConference title: RemoveParticipantFromConference
    
  • SwapCalls title: SwapCalls
    
  • MergeWithOtherCall title: MergeWithOtherCall
    

• CallData does not exist. Click to create CallData in 8.5.2DRAFT
  
  • AttachUserData title: AttachUserData
    
  • UpdateUserData title: UpdateUserData
    
  • DeleteUserData title: DeleteUserData
    
  • DeleteUserDataPair title: DeleteUserDataPair
    

• AgentState does not exist. Click to create AgentState in 8.5.2DRAFT
  
  • AgentStateReady title: Ready
    
  • AgentStateNotReady title: Not Ready
    
  • AgentStateAuxWork title: Aux Work
    
  • AgentStateAfterCallWork title: After Call Work
    
  • AgentStateOffline title: Offline
    
  • AgentStateDoNotDisturbOn title: DoNotDisturbOn
    
  • AgentStateDoNotDisturbOff title: DoNotDisturbOff
    

• Supervisor does not exist. Click to create Supervisor in 8.5.2DRAFT
  
  • SupervisorListenIn title: ListenIn
    
  • SupervisorCoach title: Coach
    
  • SupervisorBargeIn title: BargeIn
    
  • SupervisorCancelMonitoring title: CancelSupervisionMonitoring
    
  • SupervisorSwitchToBargeIn title: SwitchToBargeIn
    
  • SupervisorSwitchToListenin title: SwitchToListenIn
    
  • SupervisorMuteMonitoredUser title: MuteMonitoredUser
    
  • SupervisorUnmuteMonitoredUser title: UnmuteMonitoredUser
    

• CallRecording does not exist. Click to create CallRecording in 8.5.2DRAFT
  
  • CallRecordingOverview does not exist. Click to create CallRecordingOverview in 8.5.2DRAFT
    
  • CallRecordingStartCallRecording title: StartCallRecording
    
  • CallRecordingStopCallRecording title: StopCallRecording
    
  • CallRecordingPauseCallRecording title: PauseCallRecording
    
  • CallRecordingResumeCallRecording title: ResumeCallRecording
    

• SessionManagement does not exist. Click to create SessionManagement in 8.5.2DRAFT
  
  • StartContactCenterSession title: StartContactCenterSession
    
  • EndContactCenterSession title: EndContactCenterSession
    
  • MobilePushNotifications does not exist. Click to create MobilePushNotifications in 8.5.2DRAFT
    

MultimediaAPI title: Multimedia Interactions API

• Chat title: Chat API
  
  • ChatResources title: Chat Resource
    
  • ChatAccept title: Accept
    
  • ChatReject title: Reject
    
  • ChatSend title: SendMessage
    
  • ChatLeave title: Leave
    
  • ChatComplete title: Complete
    
  • ChatSendURL title: SendURL
    
  • ChatSendStartTypingNotification title: SendStartTypingNotification
    
  • ChatSendStopTypingNotification title: SendStopTypingNotification
    
  • ChatSetInFocus title: SetInFocus
    
  • ChatSetDisposition title: SetDisposition
    
  • ChatAddComment title: AddComment
    
  • ChatHistoricalChats does not exist. Click to create ChatHistoricalChats in 8.5.2DRAFT
    
  • ChatAttachUserData title: AttachUserData
    
  • ChatUpdateUserData title: UpdateUserData
    
  • ChatDeleteUserData title: DeleteUserData
    
  • ChatSingleStepTransfer title: Transfer
    
  • ChatInviteUser title: Invite
    
  • ChatConsult title: Consult
    
  • ChatSendToAgents title: SendToAgents
    
  • ChatSendStartTypingToAgentsNotification title: SendStartTypingToAgentsNotification
    
  • ChatSendStopTypingToAgentsNotification title: SendStopTypingToAgentsNotification
    
  • ChatRemoveParticipantFromConference title: RemoveParticipantFromConference
    
  • ChatSupervisor title: Supervisor Monitoring
    
  • ChatMonitor title: Monitor
    
  • ChatCoach title: Coach
    
  • ChatBargeIn title: BargeIn
    
  • ChatCancelSupervisorMonitoring title: CancelSupervisorMonitoring
    
  • ChatSwitchBargeIn title: SwitchToBargeIn
    
  • ChatSwitchToMonitor title: SwitchToMonitor
    
  • ChatSwitchToCoach title: SwitchToCoach
    

• CustomerChat title: Customer Chat API
  
  • CustomerChatGeneral title: General
    
  • CustomerChatResource title: Customer Chat Resource
    
  • CustomerChatMessages title: Customer Chat Messages
    
  • CustomerChatRequestChat title: RequestChat
    
  • CustomerChatSendMessage title: SendMessage
    
  • CustChatSendStartTypingNotification title: SendStartTypingNotification
    
  • CustChatSendStopTypingNotification title: SendStopTypingNotification
    
  • CustomerChatComplete title: Complete
    
  • CustomerChatGetChat title: GetChat
    
  • CustomerChatGetMessages title: GetMessages
    

• Email title: Email API
  
  • EmailAccept title: Accept
    
  • EmailReject title: Reject
    
  • EmailCreate title: Create
    
  • EmailSave title: Save
    
  • EmailCancel title: Cancel
    
  • EmailReply title: Reply
    
  • EmailReplyAll title: ReplyAll
    
  • EmailSend title: Send
    
  • EmailSetDisposition title: SetDisposition
    
  • EmailComplete title: Complete
    
  • EmailAttachUserData title: AttachUserData
    
  • EmailUpdateUserData title: UpdateUserData
    
  • EmailDeleteUserData title: DeleteUserData
    
  • EmailAddComment title: AddComment
    
  • EmailSetInFocus title: SetInFocus
    
  • EmailAddAttachment title: AddAttachment
    
  • EmailRemoveAttachment title: RemoveAttachment
    
  • EmailTransfer title: Transfer
    

• Twitter title: Twitter API
  
  • TwitterResource title: Twitter Resource
    
  • TwitterAccept title: Accept
    
  • TwitterReject title: Reject
    
  • TwitterCreate title: Create
    
  • TwitterSave title: Save
    
  • TwitterCancel title: Cancel
    
  • TwitterReply title: Reply
    
  • TwitterSend title: Send
    
  • TwitterSetDisposition title: SetDisposition
    
  • TwitterComplete title: Complete
    
  • TwitterAttachUserData title: AttachUserData
    
  • TwitterUpdateUserData title: UpdateUserData
    
  • TwitterDeleteUserData title: DeleteUserData
    
  • TwitterAddComment title: AddComment
    
  • TwitterSetInFocus title: SetInFocus
    
  • TwitterFollow title: Follow
    
  • TwitterUnfollow title: Unfollow
    
  • TwitterRetweet title: Retweet
    
  • TwitterTransfer title: Transfer
    

• Workbins title: Workbins API
  
  • WorkbinResource title: Workbin Resource
    
  • WorkbinGetWorkbins title: GetWorkbins
    
  • WorkbinGetWorkbinsSub does not exist. Click to create WorkbinGetWorkbinsSub in 8.5.2DRAFT
    
  • WorkbinGetWorkbinsSubUser does not exist. Click to create WorkbinGetWorkbinsSubUser in 8.5.2DRAFT
    
  • WorkbinGetWorkbinContent title: GetWorkbinContent
    
  • WorkbinAddInteractionToWorkbin title: AddInteractionToWorkbin
    
  • WorkbinPullInteractionFromWorkbin title: PullInteractionFromWorkbin
    
  • WorkbinSubscribeNotifications title: Subscribe To Workbin Notifications
    
  • WorkbinUnsubscribeNotifications title: Unsubscribe from Workbin Notifications
    
  • WorkbinSupPullIntFromWorkbin title: PullInteractionFromWorkbin for Supervisor
    
  • WorkbinSupAddIntToWorkbin title: AddInteractionToWorkbin for Supervisor
    

• WorkitemAPI title: Workitem API
  
  • WorkitemResource title: Workitem Resource
    
  • WorkitemCreate title: Workitem Create
    
  • WorkitemAccept title: Workitem Accept
    
  • WorkitemReject title: Workitem Reject
    
  • WorkitemSetInFocus title: Workitem SetInFocus
    
  • WorkitemComplete title: Workitem Complete
    
  • WorkitemAttachUserData title: Workitem AttachUserData
    
  • WorkitemUpdateUserData title: Workitem UpdateUserData
    
  • WorkitemDeleteUserData title: Workitem DeleteUserData
    
  • WorkitemTransfer title: Workitem Transfer
    

• StandardResponsesAPI title: Standard Responses API
  
  • SROperations does not exist. Click to create SROperations in 8.5.2DRAFT
    
  • SRCapabilities does not exist. Click to create SRCapabilities in 8.5.2DRAFT
    
  • SRAgentStateOperations does not exist. Click to create SRAgentStateOperations in 8.5.2DRAFT
    
  • SRAsyncEvents does not exist. Click to create SRAsyncEvents in 8.5.2DRAFT
    
  • SRErrorHandling does not exist. Click to create SRErrorHandling in 8.5.2DRAFT
    
  • SRRecoverExistingState does not exist. Click to create SRRecoverExistingState in 8.5.2DRAFT
    
  • SRResponseTemplateResource does not exist. Click to create SRResponseTemplateResource in 8.5.2DRAFT
    
  • SRGroupResource does not exist. Click to create SRGroupResource in 8.5.2DRAFT
    
  • SRGetResponseTemplateGroups does not exist. Click to create SRGetResponseTemplateGroups in 8.5.2DRAFT
    
  • SRGetResponseTemplates does not exist. Click to create SRGetResponseTemplates in 8.5.2DRAFT
    
  • SRReportResponseTemplateReal does not exist. Click to create SRReportResponseTemplateReal in 8.5.2DRAFT
    
  • SRReportResponseTemplateUsage does not exist. Click to create SRReportResponseTemplateUsage in 8.5.2DRAFT
    
  • SRGetAgentsFavoriteResponseTemplate does not exist. Click to create SRGetAgentsFavoriteResponseTemplate in 8.5.2DRAFT
    
  • SRAddResponseTemplatetoFavorites does not exist. Click to create SRAddResponseTemplatetoFavorites in 8.5.2DRAFT
    
  • SRRemoveResponseTemplate does not exist. Click to create SRRemoveResponseTemplate in 8.5.2DRAFT
    

ChannelsAPI title: Channels API

• QueryAgentState does not exist. Click to create QueryAgentState in 8.5.2DRAFT
  
• SetAgentStatesAcrossAllChannels does not exist. Click to create SetAgentStatesAcrossAllChannels in 8.5.2DRAFT
  
• SetAgentStatesForAParticularChannel does not exist. Click to create SetAgentStatesForAParticularChannel in 8.5.2DRAFT
  
• CometDNotifications does not exist. Click to create CometDNotifications in 8.5.2DRAFT
  

ProvisioningAPI title: Provisioning API

• ProvisioningFeatures title: Provisioning Features
  
• ProvisioningQueues title: Provisioning Queues
  
• ProvisioningSkills title: Provisioning Skills
  
• ProvisioningUsers does not exist. Click to create ProvisioningUsers in 8.5.2DRAFT
  
• BusinessUnitAPI title: Business Unit API
  
  • BusinessUnitCreate title: Create a Business Unit
    
  • BusinessUnitDelete title: Remove Business Unit
    
  • BusinessUnitAssignSupervisor title: Assign Supervisor to Business Unit
    
  • BusinessUnitAssignQueue title: Assign Queue to Business Unit
    
  • BusinessUnitRemoveQueue title: Remove Queue from Business Unit
    
  • BusinessUnitBulkAssignQueue title: Bulk Assign Queues to a Business Unit
    
  • BusinessUnitAssignSkill title: Assign Skill to a Business Unit
    
  • BusinessUnitRemoveSkill title: Remove Skill from a Business Unit
    
  • BusinessUnitBulkAssignSkill title: Bulk Assign Skills to a Business Unit
    
  • BusinessAssignAgent title: Assign Agent to Business Unit
    
  • BusinessRemoveAgent title: Remove Agent from Business Unit
    
  • BusinessBulkAssignAgent title: Bulk Assign Agents to as Business Unit
    
  • BusinessAssignUnitToAgent title: Assign Business Unit To Agent
    
  • BusinessRemoveUnitFromAgent title: Remove Business Unit from Agent
    
  • BusinessRetrieveContent title: Retrieve Business Unit Content
    
  • BusinessRetrieveList title: Retrieve Business Units list
    

DevicesAPI title: Devices API

• DevicesOps title: Operations
  
• DevicesAttribs title: Attributes
  
• DevicesList title: List Devices
  
• DevicesCreate title: Create Device
  
• DevicesDelete title: Delete Device
  
• DevicesAssign title: Assign Device
  
• DevicesUnassign title: Unassign Device
  
• DevicesCreateAssign title: Create and Assign Device to User
  

ContactsAPI title: Contacts API

• ContactsOperations does not exist. Click to create ContactsOperations in 8.5.2DRAFT
  
• ContactsAttributes does not exist. Click to create ContactsAttributes in 8.5.2DRAFT
  
• ContactsQueryFilterPage does not exist. Click to create ContactsQueryFilterPage in 8.5.2DRAFT
  
• CreateNewCustomContact does not exist. Click to create CreateNewCustomContact in 8.5.2DRAFT
  
• RetrieveCustomContacts does not exist. Click to create RetrieveCustomContacts in 8.5.2DRAFT
  

SettingsAPI title: Settings API

• SettingsAPIOperations does not exist. Click to create SettingsAPIOperations in 8.5.2DRAFT
  
• SettingsAPIAttributes title: Settings resource
  
• SettingsAPIExample does not exist. Click to create SettingsAPIExample in 8.5.2DRAFT
  
• SettingsAPISupportedSettings does not exist. Click to create SettingsAPISupportedSettings in 8.5.2DRAFT
  
• SettingsAPIUDSupportedSettings does not exist. Click to create SettingsAPIUDSupportedSettings in 8.5.2DRAFT
  

StatisticsAPI title: Statistics API

• StatisticsAPIRestAPI does not exist. Click to create StatisticsAPIRestAPI in 8.5.2DRAFT
  
• StatisticsAPIQuery title: Get most recent statistic values
  
• ListOfStatisticsToBeMonitored does not exist. Click to create ListOfStatisticsToBeMonitored in 8.5.2DRAFT
  

HierarchicalDispositionsAPI title: Hierarchical Dispositions API

• HierarchRetrieveDispositions title: Retrieve all configured dispositions in a specific disposition group
  
• HierarchRetrieveContents title: Retrieve full contents of a specific disposition category
  
• HierarchRetrieveDispositionCategory title: Retrieve full disposition and category tree
  
• HierarchCreateNewDisposition title: Create a new disposition
  
• HierarchRemoveDdisposition title: Remove a disposition
  
• HierarchCreateSubDisposition title: Create sub-category of dispositions
  
• HierarchCreateTopDisposition title: Create top-level disposition group
  
• HierarchRemoveSubDisposition title: Remove sub-category of dispositions
  
• HierarchRemoveRootDisposition title: Remove root-level disposition group
  
• HierarchCMEScenarios title: Configuration Manager Scenarios
  

InternalConfigAPI title: Platform Configuration API

Users title: Users API

• UsersResource title: User Resource
  
• UsersGetUsers title: Get all Users
  
• UsersGetUser title: Get a Specific User
  
• UsersGetSubresources title: Get all Sub-Resources for a User
  
• UserSettings title: User Settings API
  
  • UserSettingsGetGroups title: Get Settings Groups
    
  • UserSettingsCreateGroup title: Create Settings Group
    
  • UserSettingsDeleteGroup title: Delete Settings Group
    
  • UserSettingsGetSettings title: Get Settings
    
  • UserSettingsCreateSetting title: Create Setting
    
  • UserSettingsUpdateSetting title: Update Setting
    
  • UserSettingsDeleteSetting title: Delete Setting
    

IMSession title: IM Session API

• IMSessionResource title: IM Session Resource
  
• IMSessionSubResource title: Message Log Sub-Resource
  
• IMSessionInitiateIM title: InitiateIMSession
  
• IMSessionSendMessage title: SendMessage
  
• IMSessionAttachUserData title: AttachUserData
  
• IMSessionUpdateUserData title: UpdateUserData
  
• IMSessionDeleteUserData title: DeleteUserData
  
• IMSessionComplete title: Complete