Jump to: navigation, search

API Table of Contents Page

(Updated TOC with UCSIVSetCallCompleted)
(Updated TOC with ServiceConfigurations)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{#topic:Welcome}}
 
{{#topic:Welcome}}
+
 
 
{{#topic:QuickStart}}
 
{{#topic:QuickStart}}
 
*{{#topic:MakingaRequest}}
 
*{{#topic:MakingaRequest}}
Line 17: Line 17:
 
*{{#topic:FilteringAndSorting}}
 
*{{#topic:FilteringAndSorting}}
 
*{{#topic:Subresources}}
 
*{{#topic:Subresources}}
 
 
*{{#topic:ReturnValues}}
 
*{{#topic:ReturnValues}}
 
*{{#topic:RecoveringExistingState}}
 
*{{#topic:RecoveringExistingState}}
Line 133: Line 132:
 
**{{#topic:ChatSwitchToCoach}}
 
**{{#topic:ChatSwitchToCoach}}
 
**{{#topic:ChatGetAgentInteractions}}
 
**{{#topic:ChatGetAgentInteractions}}
 +
**{{#topic:ChatSendNicknameUpdatedNotice}}
  
 
*{{#topic:CustomerChat}}
 
*{{#topic:CustomerChat}}
Line 145: Line 145:
 
**{{#topic:CustomerChatGetChat}}
 
**{{#topic:CustomerChatGetChat}}
 
**{{#topic:CustomerChatGetMessages}}
 
**{{#topic:CustomerChatGetMessages}}
 +
 +
*{{#topic:DigitalUserEvents}}
 +
**{{#topic:DigitalUserEventsPublish}}
 +
**{{#topic:DigitalUserEventsSubscribe}}
 +
**{{#topic:DigitalUserEventsUnsubscribe}}
  
 
*{{#topic:Email}}
 
*{{#topic:Email}}
Line 217: Line 222:
 
**{{#topic:OpenMediaAPISetInFocus}}
 
**{{#topic:OpenMediaAPISetInFocus}}
 
**{{#topic:OpenMediaAPIComplete}}
 
**{{#topic:OpenMediaAPIComplete}}
 +
**{{#topic:OpenMediaAPIAddContent}}
 +
**{{#topic:OpenMediaAPIGetContent}}
 
**{{#topic:OpenMediaAPIAttachUD}}
 
**{{#topic:OpenMediaAPIAttachUD}}
 
**{{#topic:OpenMediaAPIUpdateUD}}
 
**{{#topic:OpenMediaAPIUpdateUD}}
 
**{{#topic:OpenMediaAPIDeleteUD}}
 
**{{#topic:OpenMediaAPIDeleteUD}}
 
**{{#topic:OpenMediaAPITransfer}}
 
**{{#topic:OpenMediaAPITransfer}}
 +
 +
*{{#topic:SMSAPI}}
 +
**{{#topic:SMSResources}}
 +
**{{#topic:SMSAccept}}
 +
**{{#topic:SMSReject}}
 +
**{{#topic:SMSSendMessage}}
 +
**{{#topic:SMSLeave}}
 +
**{{#topic:SMSComplete}}
 +
**{{#topic:SMSSendUrl}}
 +
**{{#topic:SMSSendStartType}}
 +
**{{#topic:SMSSendStopType}}
 +
**{{#topic:SMSSetInFocus}}
 +
**{{#topic:SMSSetDisposition}}
 +
**{{#topic:SMSAddComment}}
 +
**{{#topic:SMSSendCustomNotice}}
 +
**{{#topic:SMSGetMessages}}
 +
**{{#topic:SMSAttachUserData}}
 +
**{{#topic:SMSUpdateUserData}}
 +
**{{#topic:SMSDeleteUserData}}
 +
**{{#topic:SMSTransfer}}
 +
**{{#topic:SMSInvite}}
 +
**{{#topic:SMSConsult}}
 +
**{{#topic:SMSCancelConsult}}
 +
**{{#topic:SMSSendToAgents}}
 +
**{{#topic:SMSSendStartTypingToAgentsNotification}}
 +
**{{#topic:SMSSendStopTypingToAgentsNotification}}
 +
**{{#topic:SMSRemoveParticipantFromConference}}
 +
**{{#topic:SMSSendCustomNoticeToAgents}}
 +
**{{#topic:SMSMonitor}}
 +
**{{#topic:SMSCoach}}
 +
**{{#topic:SMSBargeIn}}
 +
**{{#topic:SMSCancelSupervisorMonitoring}}
 +
**{{#topic:SMSIntrude}}
 +
**{{#topic:SMSSwitchtoBargeIn}}
 +
**{{#topic:SMSSwitchtoMonitor}}
 +
**{{#topic:SMSSwitchtoCoach}}
 +
**{{#topic:SMSGetAgentInteractions}}
 +
 +
*{{#topic:StandardResponsesAPI}}
 +
**{{#topic:GWS_GetStandardResponse}}
 +
**{{#topic:GWS_RenderStandardResponse}}
 +
**{{#topic:GWS_ReportStandardResponseUsage}}
 +
**{{#topic:GWS_GetStandardResponseFavorites}}
 +
**{{#topic:GWS_AddStandardResponseFavorite}}
 +
**{{#topic:GWS_DeleteStandardResponseFavorite}}
 +
**{{#topic:GWS_DeleteAllStandardResponseFavorites}}
 +
**{{#topic:GWS_GetDocumentStandardResponse}}
  
 
*{{#topic:Twitter}}
 
*{{#topic:Twitter}}
Line 260: Line 314:
 
**{{#topic:WorkbinSubscribingToGWNotif}}
 
**{{#topic:WorkbinSubscribingToGWNotif}}
 
**{{#topic:WorkbinUnsubscribingFromGWNotif}}
 
**{{#topic:WorkbinUnsubscribingFromGWNotif}}
 
+
**{{#topic:WorkbinRequestStats}}
<!--**{{#topic:WorkbinGetWorkbinsSub}}
+
**{{#topic:WorkbinRequestAgentStats}}
**{{#topic:WorkbinGetWorkbinsSubUser}}-->
 
  
 
*{{#topic:WorkitemAPI}}
 
*{{#topic:WorkitemAPI}}
Line 277: Line 330:
 
**{{#topic:WorkitemTransfer}}
 
**{{#topic:WorkitemTransfer}}
  
*{{#topic:StandardResponsesAPI}}
 
**{{#topic:GWS_GetStandardResponse}}
 
**{{#topic:GWS_RenderStandardResponse}}
 
**{{#topic:GWS_ReportStandardResponseUsage}}
 
**{{#topic:GWS_GetStandardResponseFavorites}}
 
**{{#topic:GWS_AddStandardResponseFavorite}}
 
**{{#topic:GWS_DeleteStandardResponseFavorite}}
 
**{{#topic:GWS_DeleteAllStandardResponseFavorites}}
 
**{{#topic:GWS_GetDocumentStandardResponse}}
 
 
*{{#topic:SMSAPI}}
 
**{{#topic:SMSResources}}
 
**{{#topic:SMSAccept}}
 
**{{#topic:SMSReject}}
 
**{{#topic:SMSSendMessage}}
 
**{{#topic:SMSLeave}}
 
**{{#topic:SMSComplete}}
 
**{{#topic:SMSSendUrl}}
 
**{{#topic:SMSSendStartType}}
 
**{{#topic:SMSSendStopType}}
 
**{{#topic:SMSSetInFocus}}
 
**{{#topic:SMSSetDisposition}}
 
**{{#topic:SMSAddComment}}
 
**{{#topic:SMSSendCustomNotice}}
 
**{{#topic:SMSGetMessages}}
 
**{{#topic:SMSAttachUserData}}
 
**{{#topic:SMSUpdateUserData}}
 
**{{#topic:SMSDeleteUserData}}
 
**{{#topic:SMSTransfer}}
 
**{{#topic:SMSInvite}}
 
**{{#topic:SMSConsult}}
 
**{{#topic:SMSCancelConsult}}
 
**{{#topic:SMSSendToAgents}}
 
**{{#topic:SMSSendStartTypingToAgentsNotification}}
 
**{{#topic:SMSSendStopTypingToAgentsNotification}}
 
**{{#topic:SMSRemoveParticipantFromConference}}
 
**{{#topic:SMSSendCustomNoticeToAgents}}
 
**{{#topic:SMSMonitor}}
 
**{{#topic:SMSCoach}}
 
**{{#topic:SMSBargeIn}}
 
**{{#topic:SMSCancelSupervisorMonitoring}}
 
**{{#topic:SMSIntrude}}
 
**{{#topic:SMSSwitchtoBargeIn}}
 
**{{#topic:SMSSwitchtoMonitor}}
 
**{{#topic:SMSSwitchtoCoach}}
 
**{{#topic:SMSGetAgentInteractions}}
 
  
 
{{#topic:ChannelsAPI}}
 
{{#topic:ChannelsAPI}}
Line 366: Line 373:
 
**{{#topic:DevicesUnassign}}
 
**{{#topic:DevicesUnassign}}
 
**{{#topic:DevicesCreateAssign}}
 
**{{#topic:DevicesCreateAssign}}
 
 
*{{#topic:PlaceManAPI}}
 
*{{#topic:PlaceManAPI}}
 
**{{#topic:PlaceManGet}}
 
**{{#topic:PlaceManGet}}
Line 384: Line 390:
 
*{{#topic:Users}}
 
*{{#topic:Users}}
 
**{{#topic:UsersResource}}
 
**{{#topic:UsersResource}}
 +
**{{#topic:UsersCreateUser}}
 +
**{{#topic:UsersDeleteUser}}
 +
**{{#topic:UsersUpdateUser}}
 
**{{#topic:UsersGetUsers}}
 
**{{#topic:UsersGetUsers}}
 
**{{#topic:UsersGetUser}}
 
**{{#topic:UsersGetUser}}
Line 456: Line 465:
 
*{{#topic:CHGetInteractionContent}}
 
*{{#topic:CHGetInteractionContent}}
  
 
+
{{#topic:UCSIntegrationVoice}}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
*{{#topic:DigitalUserEvents}}
 
 
 
*{{#topic:DigitalUserEventsPublish}}
 
 
 
*{{#topic:DigitalUserEventsSubscribe}}
 
 
 
*{{#topic:DigitalUserEventsUnsubscribe}}
 
 
 
*{{#topic:OpenMediaAPIAddContent}}
 
 
 
*{{#topic:OpenMediaAPIGetContent}}
 
 
 
*{{#topic:UsersCreateUser}}
 
 
 
*{{#topic:UsersDeleteUser}}
 
 
 
*{{#topic:UsersUpdateUser}}
 
 
 
*{{#topic:UCSIntegrationVoice}}
 
 
 
 
*{{#topic:UCSIVIdentifyUCSContent}}
 
*{{#topic:UCSIVIdentifyUCSContent}}
 
 
*{{#topic:UCSIVFindPhoneCall}}
 
*{{#topic:UCSIVFindPhoneCall}}
 
 
*{{#topic:UCSIVSetCallNote}}
 
*{{#topic:UCSIVSetCallNote}}
 +
*{{#topic:UCSIVSetCallCompleted}}
 +
*{{#topic:UCSIVSetCallContact}}
  
*{{#topic:UCSIVSetCallCompleted}}
+
{{#topic:AgentStateControl}}
 +
*{{#topic:AgentStateControlReady}}
 +
*{{#topic:AgentStateControlNotReady}}
 +
*{{#topic:AgentStateControlDoNotDisturbOff}}
 +
*{{#topic:AgentStateControlDoNotDisturbOn}}
 +
*{{#topic:AgentStateControlOffline}}
  
 +
{{#topic:ServiceAPI}}
 +
*{{#topic:ServiceRuntime}}
 +
*{{#topic:ServiceConfigurations}}
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 18:23, April 27, 2018

Welcome title: Web Services API Reference

QuickStart title: Getting started

General title: API basics

VoiceAPI title: Voice API

MultimediaAPI title: Multimedia Interactions API


ChannelsAPI title: Channels API

ProvisioningAPI title: Provisioning API

ContactsAPI title: Contacts API

SettingsAPI title: Settings API

StatisticsAPI title: Statistics API

HierarchicalDispositionsAPI title: Hierarchical Dispositions API

InternalConfigAPI title: Platform Configuration API

OutboundAPI title: Outbound API

InteractionHistory title: Interaction History API

UCSIntegrationVoice title: UCS Integration with Voice API

AgentStateControl title: Supervisor Agent State Control API

ServiceAPI title: Service API

Help


* Use {{#topic:TopicName}} to create chapters, without no space in the TopicName.
* Use {{#topic:TopicName}} within a bullet to create topics.
* Use {{#topic:TopicName}} within a second-level bullet to create topics.
After save, click on the create link to edit the page and set up a H1 for the new topic.

This page was last edited on April 27, 2018, at 18:23.
Comments or questions about this documentation? Contact us for support!