API Table of Contents Page

Welcome title: Web Services API Reference

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.2
  
• AsynchronousEvents title: CometD notifications
  
• ErrorHanding does not exist. Click to create ErrorHanding in 8.5.2
  
• RecoveringExistingState title: Recovering Existing State
  
• WorkingWithSettings does not exist. Click to create WorkingWithSettings in 8.5.2
  
• ToastAndCaseData title: Toast and case data
  
• DispositionCodes does not exist. Click to create DispositionCodes in 8.5.2
  
• RequestTypes title: Request Parameters
  
• ReturnValues title: Return Values
  
• Subresources title: Subresources
  
• Filtering title: Filtering
  
• Features title: Features
  
• Services title: Services
  

VoiceAPI title: Voice API

• Calls title: Calls
  
  • 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.2
  
  • ForwardCallsOn title: ForwardCallsOn
    
  • ForwardCallsOff title: ForwardCallsOff
    

• ConferencesAndTransfers does not exist. Click to create ConferencesAndTransfers in 8.5.2
  
  • 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.2
  
  • AttachUserData title: AttachUserData
    
  • UpdateUserData title: UpdateUserData
    
  • DeleteUserData title: DeleteUserData
    
  • DeleteUserDataPair title: DeleteUserDataPair
    

• AgentState title: Agent State
  
  • 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 title: Supervisor
  
  • SupervisorListenIn title: ListenIn
    
  • SupervisorCoach title: Coach
    
  • SupervisorBargeIn title: BargeIn
    
  • SupervisorCancelSupervisionMonitoring does not exist. Click to create SupervisorCancelSupervisionMonitoring in 8.5.2
    
  • SupervisorSwitchToBargeIn title: SwitchToBargeIn
    
  • SupervisorSwitchToListenin title: SwitchToListenIn
    
  • SupervisorMuteMonitoredUser title: MuteMonitoredUser
    
  • SupervisorUnmuteMonitoredUser title: UnmuteMonitoredUser
    

• CallRecording title: Call Recording
  
  • CallRecordingStartCallRecording title: StartCallRecording
    
  • CallRecordingStopCallRecording title: StopCallRecording
    
  • CallRecordingPauseCallRecording title: PauseCallRecording
    
  • CallRecordingResumeCallRecording title: ResumeCallRecording
    

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

MultimediaAPI title: Multimedia Interactions API

• Chat title: Chat API
  
  • • ChatOperations does not exist. Click to create ChatOperations in 8.5.2
      
    • ChatCapabilities does not exist. Click to create ChatCapabilities in 8.5.2
      
    • ChatAgentStateOperations does not exist. Click to create ChatAgentStateOperations in 8.5.2
      
    • ChatAsynchronousEvents does not exist. Click to create ChatAsynchronousEvents in 8.5.2
      
    • ChatErrorHandling does not exist. Click to create ChatErrorHandling in 8.5.2
      
    • ChatRecoveringAgentState does not exist. Click to create ChatRecoveringAgentState in 8.5.2
      
  • ChatResources title: Chat Resource
    
  • ChatMigration does not exist. Click to create ChatMigration in 8.5.2
    
  • BasicChatControl does not exist. Click to create BasicChatControl in 8.5.2
    
    • ChatAccept title: Accept
      
    • ChatReject title: Reject
      
    • ChatSend title: SendMessage
      
    • ChatSendStartTypingNotification title: SendStartTypingNotification
      
    • ChatSendStopTypingNotification title: SendStopTypingNotification
      
    • ChatSetInFocus title: SetInFocus
      
    • ChatSetDisposition title: SetDisposition
      
    • ChatLeave title: Leave
      
    • ChatAddComment title: AddComment
      
    • ChatComplete title: Complete
      
    • 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
      

• Email title: Email API
  
  • EmailAccept title: Accept
    
  • EmailReject title: Reject
    
  • EmailReply title: Reply
    
  • EmailReplyAll title: ReplyAll
    
  • EmailCancel title: Cancel
    
  • EmailSend title: Send
    
  • EmailTransfer title: Transfer
    
  • EmailComplete title: Complete
    
  • EmailPlaceInQueue does not exist. Click to create EmailPlaceInQueue in 8.5.2
    

• Facebook title: Facebook API
  
  • FacebookAccept title: Accept
    
  • FacebookReject title: Reject
    
  • FacebookReply title: Reply
    
  • FacebookCancel title: Cancel
    
  • FacebookSend title: Send
    
  • FacebookTransfer title: Transfer
    
  • FacebookComplete title: Complete
    
  • FacebookCreateInteraction does not exist. Click to create FacebookCreateInteraction in 8.5.2
    
  • FacebookDeleteFacebookPost does not exist. Click to create FacebookDeleteFacebookPost in 8.5.2
    
  • FacebookDeleteFacebookComment does not exist. Click to create FacebookDeleteFacebookComment in 8.5.2
    

• Twitter title: Twitter API
  
  • TwitterAccept title: Accept
    
  • TwitterReject title: Reject
    
  • TwitterReply title: Reply
    
  • TwitterCancel title: Cancel
    
  • TwitterSend title: Send
    
  • TwitterTransfer title: Transfer
    
  • TwitterComplete title: Complete
    
  • TwitterCreate title: Create
    
  • TwitterFollow title: Follow
    
  • TwitterUnfollow title: Unfollow
    

• Workbins title: Workbins API
  
  • WorkbinsGetWorkbinTypesInfo does not exist. Click to create WorkbinsGetWorkbinTypesInfo in 8.5.2
    
  • WorkbinsGetWorkbinContent does not exist. Click to create WorkbinsGetWorkbinContent in 8.5.2
    
  • WorkbinsAddInteractionToWorkbin does not exist. Click to create WorkbinsAddInteractionToWorkbin in 8.5.2
    
  • WorkbinsPullInteraction does not exist. Click to create WorkbinsPullInteraction in 8.5.2
    
  • WorkbinsSubscribeWorkbinEvents does not exist. Click to create WorkbinsSubscribeWorkbinEvents in 8.5.2
    
  • WorkbinsUnsubscribeWorkbinEvents does not exist. Click to create WorkbinsUnsubscribeWorkbinEvents in 8.5.2
    }}

• StandardResponsesAPI title: Standard Responses API
  
  • SROverview does not exist. Click to create SROverview in 8.5.2
    
    • SRGeneral does not exist. Click to create SRGeneral in 8.5.2
      

• • SRResources does not exist. Click to create SRResources in 8.5.2
    
    • SRResponseTemplateResource title: Response Template Resource
      
    • SRGroupResource does not exist. Click to create SRGroupResource in 8.5.2
      

• • SRBackend does not exist. Click to create SRBackend in 8.5.2
    
    • SRCassandraSchema does not exist. Click to create SRCassandraSchema in 8.5.2
      
    • SRFavoritesCassandraSchema does not exist. Click to create SRFavoritesCassandraSchema in 8.5.2
      
    • SRSync does not exist. Click to create SRSync in 8.5.2
      
    • SRFavoritesSync does not exist. Click to create SRFavoritesSync in 8.5.2
      

• • SROperations does not exist. Click to create SROperations in 8.5.2
    
    • SRGetResponseTemplateGroupsAndSubResources does not exist. Click to create SRGetResponseTemplateGroupsAndSubResources in 8.5.2
      
    • SRGetResponseTemplates does not exist. Click to create SRGetResponseTemplates in 8.5.2
      
    • SRManuallyRenderResponseTemplateIntoRealMessage does not exist. Click to create SRManuallyRenderResponseTemplateIntoRealMessage in 8.5.2
      
    • SRReportResponseTemplateUsage does not exist. Click to create SRReportResponseTemplateUsage in 8.5.2
      

• • SRFavoritesControl does not exist. Click to create SRFavoritesControl in 8.5.2
    
    • SRGetAgentsFavoriteResponseTemplate does not exist. Click to create SRGetAgentsFavoriteResponseTemplate in 8.5.2
      
    • SRAddResponseTemplatetoAgentsFavorites does not exist. Click to create SRAddResponseTemplatetoAgentsFavorites in 8.5.2
      
    • SRRemoveResponseTemplatefromAgentsFavorite does not exist. Click to create SRRemoveResponseTemplatefromAgentsFavorite in 8.5.2
      

ChannelsAPI title: Channels API

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

ProvisioningAPI title: Provisioning API

• ProvisioningDevices does not exist. Click to create ProvisioningDevices in 8.5.2
  
• ProvisioningFeatures title: Provisioning Features
  
• ProvisioningQueues title: Provisioning Queues
  
• ProvisioningSkills title: Provisioning Skills
  
• ProvisioningUsers does not exist. Click to create ProvisioningUsers in 8.5.2
  

ContactsAPI title: Contacts API

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

SettingsAPI title: Settings API

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

StatisticsAPI title: Statistics API

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