API Table of Contents Page

Welcome title: Web Services API Reference

General title: API basics

• 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
    
  • CallRecordingPauseCallRecording title: PauseCallRecording
    
  • CallRecordingResumeCallRecording title: ResumeCallRecording
    
  • CallRecordingStopCallRecording title: StopCallRecording
    

• 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
  
  • ChatAccept title: Accept
    
  • ChatReject title: Reject
    
  • ChatInviteUser title: Invite
    
  • ChatEndChatSession does not exist. Click to create ChatEndChatSession in 8.5.2
    
  • ChatSend title: SendMessage
    
  • ChatSendStartTypingNotification title: SendStartTypingNotification
    
  • ChatSendStopTypingNotification title: SendStopTypingNotification
    
  • ChatSingleStepTransfer title: Transfer
    
  • ChatComplete title: Complete
    
  • ChatRequestChatHistory does not exist. Click to create ChatRequestChatHistory in 8.5.2
    
  • ChatLeaveConference does not exist. Click to create ChatLeaveConference in 8.5.2
    
• 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
  
• Twitter title: Twitter API
  
• Workbins title: Workbins API
  

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

• AgentStateOperations does not exist. Click to create AgentStateOperations in 8.5.2
  
• 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