Documentation:HTCC:APITOC8.5.2

Welcome title: Web Services API Reference

QuickStart title: Getting started

• MakingaRequest title: Making a Request
  
• InterpretingaResponse title: Interpreting a response
  
• WorkingwithAgents title: Working with agents
  
• AnsweringaCall title: Answering a call
  

General title: API basics

• WhatAreOperations title: What are operations?
  
• WhatAreCapabilities title: What are capabilities?
  
• AsynchronousEvents title: CometD notifications
  
• ErrorHandling title: Error handling
  
• RequestTypes title: Request Parameters
  
• Roles title: Working with roles
  
• Filtering title: Filtering
  
• FilteringAndSorting title: Filtering and sorting users by fields and subresources
  
• Subresources title: Subresources
  
• ReturnValues title: Return Values
  
• RecoveringExistingState title: Recovering Existing State
  
• ToastAndCaseData title: Toast and case data
  
• Dispositioncodes title: Disposition codes
  
• CORS title: Cross-Origin Resource Sharing
  
• CSRFProtection title: Cross-Site Request Forgery protection
  
• Features title: Features
  
• Services title: Services
  

VoiceAPI title: Voice API

• CallsMessageType title: CometD notifications
  
• CallResource title: Call resource
  
• CallsDeviceResource title: Device resource
  
• StartContactCenterSession title: StartContactCenterSession
  
• EndContactCenterSession title: EndContactCenterSession
  
• 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
  
• ForwardCallsOn title: ForwardCallsOn
  
• ForwardCallsOff title: ForwardCallsOff
  
• 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
  
• SingleStepConference title: SingleStepConference
  
• InitiateConference title: InitiateConference
  
• CompleteConference title: CompleteConference
  
• RemoveParticipantFromConference title: RemoveParticipantFromConference
  
• ClearCall title: ClearCall
  
• SingleStepTransfer title: SingleStepTransfer
  
• InitiateTransfer title: InitiateTransfer
  
• CompleteTransfer title: CompleteTransfer
  
• SwapCalls title: SwapCalls
  
• MergeWithOtherCall title: MergeWithOtherCall
  
• AttachUserData title: AttachUserData
  
• UpdateUserData title: UpdateUserData
  
• DeleteUserData title: DeleteUserData
  
• DeleteUserDataPair title: DeleteUserDataPair
  
• SupervisorListenIn title: ListenIn
  
• SupervisorCoach title: Coach
  
• SupervisorBargeIn title: BargeIn
  
• SupervisorCancelMonitoring title: CancelSupervisionMonitoring
  
• SupervisorSwitchToBargeIn title: SwitchToBargeIn
  
• SupervisorSwitchToListenin title: SwitchToListenIn
  
• SupervisorMuteMonitoredUser title: MuteMonitoredUser
  
• SupervisorUnmuteMonitoredUser title: UnmuteMonitoredUser
  
• CallRecordingStartCallRecording title: StartCallRecording
  
• CallRecordingPauseCallRecording title: PauseCallRecording
  
• CallRecordingResumeCallRecording title: ResumeCallRecording
  
• CallRecordingStopCallRecording title: StopCallRecording
  
• IMSession title: IM Session API
  
  • IMSessionMessageType title: CometD notifications
    
  • IMSessionResource title: IM Session Resource
    
  • IMSessionInitiateIM title: InitiateIMSession
    
  • IMSessionSendMessage title: SendMessage
    
  • IMSessionAttachUserData title: AttachUserData
    
  • IMSessionUpdateUserData title: UpdateUserData
    
  • IMSessionDeleteUserData title: DeleteUserData
    
  • IMSessionComplete title: Complete
    

MultimediaAPI title: Multimedia Interactions API

• Chat title: Chat API
  
  • ChatMessageType title: CometD notifications
    
  • ChatResources title: Chat Resource
    
  • ChatAccept title: Accept
    
  • ChatReject title: Reject
    
  • ChatSend title: SendMessage
    
  • ChatLeave title: Leave
    
  • ChatComplete title: Complete
    
  • ChatSendURL title: SendURL
    
  • ChatAddAttachment title: AddAttachment
    
  • ChatGetAttachment title: GetAttachment
    
  • ChatRemoveAttachment title: RemoveAttachment
    
  • ChatUploadFile title: UploadFile
    
  • ChatDeleteFile title: DeleteFile
    
  • ChatSendStartTypingNotification title: SendStartTypingNotification
    
  • ChatSendStopTypingNotification title: SendStopTypingNotification
    
  • ChatSetInFocus title: SetInFocus
    
  • ChatSetDisposition title: SetDisposition
    
  • ChatAddComment title: AddComment
    
  • ChatSendCustomNotice title: SendCustomNotice
    
  • ChatAttachUserData title: AttachUserData
    
  • ChatUpdateUserData title: UpdateUserData
    
  • ChatDeleteUserData title: DeleteUserData
    
  • ChatSingleStepTransfer title: Transfer
    
  • ChatInviteUser title: Invite
    
  • ChatConsult title: Consult
    
  • ChatCancelConsult title: CancelConsult
    
  • ChatSendToAgents title: SendToAgents
    
  • ChatSendStartTypingToAgentsNotification title: SendStartTypingToAgentsNotification
    
  • ChatSendStopTypingToAgentsNotification title: SendStopTypingToAgentsNotification
    
  • ChatRemoveParticipantFromConference title: RemoveParticipantFromConference
    
  • ChatSendCustomNoticeToAgents title: SendCustomNoticeToAgents
    
  • ChatSupervisor title: Supervisor Monitoring
    
  • ChatMonitor title: Monitor
    
  • ChatCoach title: Coach
    
  • ChatBargeIn title: BargeIn
    
  • ChatCancelSupervisorMonitoring title: CancelSupervisorMonitoring
    
  • ChatIntrude title: Intrude
    
  • ChatSwitchBargeIn title: SwitchToBargeIn
    
  • ChatSwitchToMonitor title: SwitchToMonitor
    
  • ChatSwitchToCoach title: SwitchToCoach
    
  • ChatGetAgentInteractions title: GetAgentInteractions
    

• 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
    

• DigitalUserEvents title: Digital User Events API
  
  • DigitalUserEventsPublish title: Publish
    
  • DigitalUserEventsSubscribe title: Subscribe
    
  • DigitalUserEventsUnsubscribe title: Unsubscribe
    

• Email title: Email API
  
  • EmailMessageType title: CometD notifications
    
  • EmailResource title: Email Resource
    
  • 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
    
  • EmailGetAttachment title: GetAttachment
    
  • EmailRemoveAttachment title: RemoveAttachment
    
  • EmailTransfer title: Transfer
    

• Facebook title: Facebook API
  
  • FacebookMessageType title: CometD notifications
    
  • FacebookResource title: Facebook Resource
    
  • FacebookAccept title: Accept
    
  • FacebookReject title: Reject
    
  • FacebookCreate title: Create
    
  • FacebookSave title: Save
    
  • FacebookCancel title: Cancel
    
  • FacebookReply title: Reply
    
  • FacebookSend title: Send
    
  • FacebookSetDisposition title: SetDisposition
    
  • FacebookComplete title: Complete
    
  • FacebookAttachUserData title: AttachUserData
    
  • FacebookUpdateUserData title: UpdateUserData
    
  • FacebookDeleteUserData title: DeleteUserData
    
  • FacebookAddComment title: AddComment
    
  • FacebookSetInFocus title: SetInFocus
    
  • FacebookTransfer title: Transfer
    

• FacebookPM title: Facebook Private Messaging API
  
  • FacebookPMMessageType title: CometD notifications
    
  • FacebookSessionResource title: FacebookSession Resource
    
  • FacebookPMAccept title: Accept
    
  • FacebookPMReject title: Reject
    
  • FacebookPMSendMessage title: SendMessage
    
  • FacebookPMSendUrl title: SendUrl
    
  • FacebookPMSetInFocus title: SetInFocus
    
  • FacebookPMSetDisposition title: SetDisposition
    
  • FacebookPMLeave title: Leave
    
  • FacebookPMComplete title: Complete
    
  • FacebookPMAttachUserData title: AttachUserData
    
  • FacebookPMUpdateUserData title: UpdateUserData
    
  • FacebookPMDeleteUserData title: DeleteUserData
    
  • FacebookPMAddComment title: AddComment
    
  • FacebookPMTransfer title: Transfer
    
  • FacebookPMConsult title: Consult
    
  • FacebookPMSendToAgents title: SendToAgents
    
  • FacebookPMRemovePart title: RemoveParticipantFromConference
    
  • FacebookPMReportSRUsage title: ReportStandardResponseUsage FacebookSession
    

• OpenMediaAPI title: Open Media API
  
  • OpenMediaAPIMessageType title: CometD notifications
    
  • OpenMediaAPIResource title: OpenMedia Resource
    
  • OpenMediaAPICreate title: Create
    
  • OpenMediaAPIAccept title: Accept
    
  • OpenMediaAPIReject title: Reject
    
  • OpenMediaAPISetInFocus title: SetInFocus
    
  • OpenMediaAPIComplete title: Complete
    
  • OpenMediaAPIAddContent title: AddContent
    
  • OpenMediaAPIGetContent title: GetContent
    
  • OpenMediaAPIAttachUD title: AttachUserData
    
  • OpenMediaAPIUpdateUD title: UpdateUserData
    
  • OpenMediaAPIDeleteUD title: DeleteUserData
    
  • OpenMediaAPITransfer title: Transfer
    

• SMSAPI title: SMS Session API
  
  • SMSResources title: SMS Session Resource
    
  • SMSAccept title: Accept
    
  • SMSReject title: Reject
    
  • SMSSendMessage title: SendMessage
    
  • SMSLeave title: Leave
    
  • SMSComplete title: Complete
    
  • SMSSendUrl title: SendURL
    
  • SMSSendStartType title: SendStartTypingNotification
    
  • SMSSendStopType title: SendStopTypingNotification
    
  • SMSSetInFocus title: SetInFocus
    
  • SMSSetDisposition title: SetDisposition
    
  • SMSAddComment title: AddComment
    
  • SMSSendCustomNotice title: SendCustomNotice
    
  • SMSGetMessages title: GetMessages
    
  • SMSAttachUserData title: AttachUserData
    
  • SMSUpdateUserData title: UpdateUserData
    
  • SMSDeleteUserData title: DeleteUserData
    
  • SMSTransfer title: Transfer
    
  • SMSInvite title: Invite
    
  • SMSConsult title: Consult
    
  • SMSCancelConsult title: CancelConsult
    
  • SMSSendToAgents title: SendToAgents
    
  • SMSSendStartTypingToAgentsNotification title: SendStartTypingToAgentsNotification
    
  • SMSSendStopTypingToAgentsNotification title: SendStopTypingToAgentsNotification
    
  • SMSRemoveParticipantFromConference title: RemoveParticipantFromConference
    
  • SMSSendCustomNoticeToAgents title: SendCustomNoticeToAgents
    
  • SMSMonitor title: Monitor
    
  • SMSCoach title: Coach
    
  • SMSBargeIn title: BargeIn
    
  • SMSCancelSupervisorMonitoring title: CancelSupervisorMonitoring
    
  • SMSIntrude title: Intrude
    
  • SMSSwitchtoBargeIn title: SwitchToBargeIn
    
  • SMSSwitchtoMonitor title: SwitchToMonitor
    
  • SMSSwitchtoCoach title: SwitchToCoach
    
  • SMSGetAgentInteractions title: GetAgentInteractions
    

• Twitter title: Twitter API
  
  • TwitterMessageType title: CometD notifications
    
  • 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
  
  • WorkbinsMessageType title: CometD notifications
    
  • WorkbinResource title: Workbin Resource
    
  • WorkbinGetWorkbins title: GetWorkbins
    
  • 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
    
  • WorkbinGetGWContent title: GetGroupWorkbinContent
    
  • WorkbinAddInteractionToGW title: AddInteraction to a Group Workbin
    
  • WorkbinPullInteractionFromGW title: PullInteraction from a Group Workbin
    
  • WorkbinSubscribingToGWNotif title: Subscribe to Group Workbin Notifications
    
  • WorkbinUnsubscribingFromGWNotif title: Unsubscribe from Group Workbin Notifications
    

• WorkitemAPI title: Workitem API
  
  • WorkitemMessageType title: CometD notifications
    
  • 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
  
  • GWS_GetStandardResponse title: GetStandardResponse
    
  • GWS_RenderStandardResponse title: RenderStandardResponse
    
  • GWS_ReportStandardResponseUsage title: ReportStandardResponseUsage
    
  • GWS_GetStandardResponseFavorites title: GetStandardResponseFavorites
    
  • GWS_AddStandardResponseFavorite title: AddStandardResponseFavorite
    
  • GWS_DeleteStandardResponseFavorite title: DeleteStandardResponseFavorite
    
  • GWS_DeleteAllStandardResponseFavorites title: DeleteAllStandardResponseFavorites
    
  • GWS_GetDocumentStandardResponse title: GetDocumentStandardResponse
    

ChannelsAPI title: Channels API

• ChannelsResource title: Channel resource
  
• ChannelsGetMMChannels title: Get all channels
  
• ChannelsGetMMChannelbyId title: Get channel by ID
  
• ChannelsSetReadyMMChannel title: Set channel to Ready
  
• ChannelsSetNotReadyMMChannel title: Set channel to NotReady
  
• ChannelsSetReadyChannels title: Set all channels to Ready
  
• ChannelsSetNotReadyChannels title: Set all channels to NotReady
  
• ChannelsSetDNDOn title: Set all channels to DNDOn
  
• ChannelsSetDNDOff title: Set all channels to DNDOff
  

ProvisioningAPI title: Provisioning API

• 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
    

• PlaceManAPI title: Place Management API
  
  • PlaceManGet title: List Places
    
  • PlaceManGetID title: List Place by ID
    
  • PlaceManGetUser title: List Places Assigned to User
    
  • PlaceManGetBU title: List Places Assigned to Business Unit
    
  • PlaceManCreate title: Create
    
  • PlaceManUpdate title: Update
    
  • PlaceManDelete title: Delete
    
  • PlaceAssignDevice title: Assign Device to Place
    
  • PlaceUnassignDevice title: Unassign Device from Place
    
  • PlaceAssignUser title: Assign Place to User
    
  • PlaceUnassignUser title: Unassign Place from User
    
  • PlaceAssignBU title: Assign Place to Business Unit
    
  • PlaceUnassignBU title: Unassign Place from Business Unit
    

• Users title: Users API
  
  • UsersResource title: User Resource
    
  • UsersCreateUser title: Create User
    
  • UsersDeleteUser title: Delete User
    
  • UsersUpdateUser title: Update User
    
  • UsersGetUsers title: Get all Users
    
  • UsersGetUser title: Get a Specific User
    
  • UsersGetSubresources title: Get all Sub-Resources for a User
    
  • UsersUnlockAccount title: Unlock User Account
    

• 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
    

ContactsAPI title: Contacts API

• ContactsResource title: Contact resource
  
• ContactsGetContacts title: Get contacts
  
• ContactCreate title: Create a custom contact
  
• ContactUpdate title: Update a custom contact
  
• ContactDelete title: Delete a custom contact
  

SettingsAPI title: Settings API

• SettingsAPIAttributes title: Settings resource
  
• SettingsSystem title: System settings
  
• SettingsCustom title: Custom settings
  

StatisticsAPI title: Statistics API

• Listofstatisticstobemonitored title: Monitored statistics
  
• StatisticsAPIQuery title: Get most recent statistic values
  

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

OutboundAPI title: Outbound API

• OutboundCampaignResource title: Outbound Campaign Resource
  
• OutboundRecordResource title: Outbound Record Resource
  
• OutboundRequestCampaign title: Request Campaign Status
  
• OutboundStartPreview title: Start Preview Session
  
• OutboundEndPreview title: End Preview Session
  
• OutboundRequestPreview title: Request Preview Record
  
• OutboundDialPreview title: Dial Preview Record
  
• OutboundReject title: Reject Record
  
• OutboundCancel title: Cancel Record
  
• OutboundCancelNum title: Cancel Record with Phone Number
  
• OutboundComplete title: Complete Record
  
• OutboundDoNotCall title: Do Not Call Record
  
• OutboundDoNotCallNum title: Do Not Call Record with Phone Number
  
• OutboundCreate title: Create Record
  
• OutboundUpdate title: Update Record
  
• OutboundGetChained title: Get Chained Record
  
• OutboundReschedule title: Reschedule Record
  
• OutboundIncoming title: Incoming Call From an Outbound Campaign
  

InteractionHistory title: Interaction History API

• CHMessageType title: CometD notifications
  
• CHInteractionResource title: Interaction history resource
  
• CHMessageResource title: Message resource
  
• CHGetContactInteractions title: RetrieveContactHistory
  
• CHGetAgentInteractions title: RetrieveAgentHistory
  
• CHGetInteractions title: RetrieveInteractionHistory
  
• CHGetInteractionContent title: GetInteractionContent
  

• UCSIntegrationVoice title: UCS Integration with Voice API
  
  • UCSIVIdentifyUCSContent title: IdentifyUCSContact
    
  • UCSIVFindPhoneCall title: FindPhoneCall
    
  • UCSIVSetCallNote title: SetCallNote
    
  • UCSIVSetCallCompleted title: SetCallCompleted
    
  • UCSIVSetCallContact title: SetCallContact