Jump to: navigation, search

API Table of Contents Page

(Updated TOC with SMSSwitchtoMonitor)
(Updated TOC with ServiceConfigurations)
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{#topic:Welcome}}
 
{{#topic:Welcome}}
+
 
 
{{#topic:QuickStart}}
 
{{#topic:QuickStart}}
 
*{{#topic:MakingaRequest}}
 
*{{#topic:MakingaRequest}}
Line 13: Line 13:
 
*{{#topic:ErrorHandling}}
 
*{{#topic:ErrorHandling}}
 
*{{#topic:RequestTypes}}
 
*{{#topic:RequestTypes}}
 +
*{{#topic:Roles}}
 
*{{#topic:Filtering}}
 
*{{#topic:Filtering}}
 
*{{#topic:FilteringAndSorting}}
 
*{{#topic:FilteringAndSorting}}
 
*{{#topic:Subresources}}
 
*{{#topic:Subresources}}
 
 
 
*{{#topic:ReturnValues}}
 
*{{#topic:ReturnValues}}
 
*{{#topic:RecoveringExistingState}}
 
*{{#topic:RecoveringExistingState}}
Line 100: Line 99:
 
**{{#topic:ChatComplete}}
 
**{{#topic:ChatComplete}}
 
**{{#topic:ChatSendURL}}
 
**{{#topic:ChatSendURL}}
 +
**{{#topic:ChatAddAttachment}}
 +
**{{#topic:ChatGetAttachment}}
 +
**{{#topic:ChatRemoveAttachment}}
 +
**{{#topic:ChatUploadFile}}
 +
**{{#topic:ChatDeleteFile}}
 
**{{#topic:ChatSendStartTypingNotification}}
 
**{{#topic:ChatSendStartTypingNotification}}
 
**{{#topic:ChatSendStopTypingNotification}}
 
**{{#topic:ChatSendStopTypingNotification}}
Line 112: Line 116:
 
**{{#topic:ChatInviteUser}}
 
**{{#topic:ChatInviteUser}}
 
**{{#topic:ChatConsult}}
 
**{{#topic:ChatConsult}}
 +
**{{#topic:ChatCancelConsult}}
 
**{{#topic:ChatSendToAgents}}
 
**{{#topic:ChatSendToAgents}}
 
**{{#topic:ChatSendStartTypingToAgentsNotification}}
 
**{{#topic:ChatSendStartTypingToAgentsNotification}}
Line 127: Line 132:
 
**{{#topic:ChatSwitchToCoach}}
 
**{{#topic:ChatSwitchToCoach}}
 
**{{#topic:ChatGetAgentInteractions}}
 
**{{#topic:ChatGetAgentInteractions}}
 +
**{{#topic:ChatSendNicknameUpdatedNotice}}
  
 
*{{#topic:CustomerChat}}
 
*{{#topic:CustomerChat}}
Line 139: Line 145:
 
**{{#topic:CustomerChatGetChat}}
 
**{{#topic:CustomerChatGetChat}}
 
**{{#topic:CustomerChatGetMessages}}
 
**{{#topic:CustomerChatGetMessages}}
 +
 +
*{{#topic:DigitalUserEvents}}
 +
**{{#topic:DigitalUserEventsPublish}}
 +
**{{#topic:DigitalUserEventsSubscribe}}
 +
**{{#topic:DigitalUserEventsUnsubscribe}}
  
 
*{{#topic:Email}}
 
*{{#topic:Email}}
Line 211: 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 242: Line 302:
 
**{{#topic:WorkbinResource}}
 
**{{#topic:WorkbinResource}}
 
**{{#topic:WorkbinGetWorkbins}}
 
**{{#topic:WorkbinGetWorkbins}}
**{{#topic:WorkbinGetWorkbinsSub}}
 
**{{#topic:WorkbinGetWorkbinsSubUser}}
 
 
**{{#topic:WorkbinGetWorkbinContent}}
 
**{{#topic:WorkbinGetWorkbinContent}}
 
**{{#topic:WorkbinAddInteractionToWorkbin}}
 
**{{#topic:WorkbinAddInteractionToWorkbin}}
Line 251: Line 309:
 
**{{#topic:WorkbinSupPullIntFromWorkbin}}
 
**{{#topic:WorkbinSupPullIntFromWorkbin}}
 
**{{#topic:WorkbinSupAddIntToWorkbin}}
 
**{{#topic:WorkbinSupAddIntToWorkbin}}
 +
**{{#topic:WorkbinGetGWContent}}
 +
**{{#topic:WorkbinAddInteractionToGW}}
 +
**{{#topic:WorkbinPullInteractionFromGW}}
 +
**{{#topic:WorkbinSubscribingToGWNotif}}
 +
**{{#topic:WorkbinUnsubscribingFromGWNotif}}
 +
**{{#topic:WorkbinRequestStats}}
 +
**{{#topic:WorkbinRequestAgentStats}}
  
 
*{{#topic:WorkitemAPI}}
 
*{{#topic:WorkitemAPI}}
Line 265: Line 330:
 
**{{#topic:WorkitemTransfer}}
 
**{{#topic:WorkitemTransfer}}
  
*{{#topic:StandardResponsesAPI}}
 
**{{#topic:SRResponseTemplateResource}}
 
**{{#topic:SRGroupResource}}
 
**{{#topic:SRGetResponseTemplateGroups}}
 
**{{#topic:SRGetResponseTemplates}}
 
**{{#topic:SRReportResponseTemplateReal}}
 
**{{#topic:SRReportResponseTemplateUsage}}
 
**{{#topic:SRGetAgentsFavoriteResponseTemplate}}
 
**{{#topic:SRAddResponseTemplatetoFavorites}}
 
**{{#topic:SRRemoveResponseTemplate}}
 
  
 
{{#topic:ChannelsAPI}}
 
{{#topic:ChannelsAPI}}
Line 286: Line 341:
 
*{{#topic:ChannelsSetDNDOn}}
 
*{{#topic:ChannelsSetDNDOn}}
 
*{{#topic:ChannelsSetDNDOff}}
 
*{{#topic:ChannelsSetDNDOff}}
 
 
 
 
 
 
  
 
{{#topic:ProvisioningAPI}}
 
{{#topic:ProvisioningAPI}}
Line 314: Line 363:
 
**{{#topic:BusinessRetrieveContent}}
 
**{{#topic:BusinessRetrieveContent}}
 
**{{#topic:BusinessRetrieveList}}
 
**{{#topic:BusinessRetrieveList}}
 +
 
*{{#topic:DevicesAPI}}
 
*{{#topic:DevicesAPI}}
 
**{{#topic:DevicesOps}}
 
**{{#topic:DevicesOps}}
Line 337: Line 387:
 
**{{#topic:PlaceAssignBU}}
 
**{{#topic:PlaceAssignBU}}
 
**{{#topic:PlaceUnassignBU}}
 
**{{#topic:PlaceUnassignBU}}
 +
 
*{{#topic:Users}}
 
*{{#topic:Users}}
 
**{{#topic:UsersResource}}
 
**{{#topic:UsersResource}}
 +
**{{#topic:UsersCreateUser}}
 +
**{{#topic:UsersDeleteUser}}
 +
**{{#topic:UsersUpdateUser}}
 
**{{#topic:UsersGetUsers}}
 
**{{#topic:UsersGetUsers}}
 
**{{#topic:UsersGetUser}}
 
**{{#topic:UsersGetUser}}
Line 408: Line 462:
 
*{{#topic:CHGetContactInteractions}}
 
*{{#topic:CHGetContactInteractions}}
 
*{{#topic:CHGetAgentInteractions}}
 
*{{#topic:CHGetAgentInteractions}}
 +
*{{#topic:CHGetInteractions}}
 
*{{#topic:CHGetInteractionContent}}
 
*{{#topic:CHGetInteractionContent}}
  
*{{#topic:WorkbinGetGWContent}}
+
{{#topic:UCSIntegrationVoice}}
 
+
*{{#topic:UCSIVIdentifyUCSContent}}
*{{#topic:WorkbinAddInteractionToGW}}
+
*{{#topic:UCSIVFindPhoneCall}}
 
+
*{{#topic:UCSIVSetCallNote}}
*{{#topic:WorkbinPullInteractionFromGW}}
+
*{{#topic:UCSIVSetCallCompleted}}
 
+
*{{#topic:UCSIVSetCallContact}}
*{{#topic:WorkbinSubscribingToGWNotif}}
 
 
 
*{{#topic:WorkbinUnsubscribingFromGWNotif}}
 
 
 
*{{#topic:ChatAddAttachment}}
 
 
 
*{{#topic:ChatGetAttachment}}
 
 
 
*{{#topic:ChatRemoveAttachment}}
 
 
 
*{{#topic:ChatUploadFile}}
 
 
 
*{{#topic:ChatDeleteFile}}
 
 
 
*{{#topic:ChatCancelConsult}}
 
 
 
*{{#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:CHGetInteractions}}
 
 
 
*{{#topic:Roles}}
 
 
 
*{{#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:SMSAccept}}
 
 
 
*{{#topic:SMSReject}}
 
 
 
*{{#topic:SMSSendMessage}}
 
 
 
*{{#topic:SMSLeave}}
 
 
 
*{{#topic:SMSComplete}}
 
 
 
*{{#topic:SMSSendUrl}}
 
 
 
*{{#topic:SMSSendStartType}}
 
 
 
*{{#topic:SMSSendStopType}}
 
 
 
*{{#topic:SMSSetInFocus}}
 
 
 
*{{#topic:SMSSetDisposition}}
 
 
 
*{{#topic:SMSAPI}}
 
 
 
*{{#topic:SMSResources}}
 
 
 
*{{#topic:SMSSwitchtoBargeIn}}
 
  
*{{#topic:SMSSwitchtoMonitor}}
+
{{#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!