API Table of Contents Page

Welcome title: Genesys Web Engagement API Reference

MonitoringAPI title: Monitoring JS API

Chat title: Chat JS API

• ChatWidgetAPI title: Chat Widget JS API
  
  • MoreMethods title: Additional Methods
    
  • CustomizationExamples title: Customization Examples
    
  • StartChat title: startChat(options)
    
  • RestoreChat title: restoreChat(options)
    
  • StartChatInThisWindow title: startChatInThisWindow(options)
    
  • onBeforeChatOptionsApplied title: onBeforeChatOptionsApplied(callback)
    
  • onSession title: onSession(callback)
    
  • close title: close()
    
  • toggle title: toggle()
    
  • onMinimized title: onMinimized(callback)
    
  • isMinimized title: isMinimized()
    
  • VERSION title: VERSION
    
• ChatService title: Chat Service JS API
  
  • ObtainChat title: Launching the Chat Session
    
  • ControlChat title: Controlling the Chat Session
    
• ErrorCodes title: Error Codes
  

NotificationAPI title: Notification Service REST API

EngagementAPI title: Engagement REST API

HistoryREST title: History REST API

• HTTPResponseCodesandErrors title: HTTP Response Codes and Errors
  
• Authentication title: Authentication
  
• OperationsIndex title: Operations and Resources Index
  
• EventResource title: Event Resource
  
  • Queryevent title: Query event
    
• GlobalVisits title: Global Visit Resource
  
  • QueryidentitiesbyglobalVisitID title: Query identities by globalVisitID
    
• IdentityResource title: Identity Resource
  
  • Queryeventsbyidentity title: Query events by identity
    
  • Queryidentity title: Query identity
    
  • Queryidentities title: Query identities
    
  • Querypagesbyidentity title: Query pages by identity
    
  • Queryuseragentsbyidentity title: Query user agents by identity
    
  • Queryvisitsbyidentity title: Query visits by identity
    
• PageResource title: Page Resource
  
  • Queryeventsbypage title: Query events by page
    
  • Querypage title: Query page
    
• VisitResource title: Visit Resource
  
  • Createneweventforvisit title: Create new event for visit
    
  • Createnewvisit title: Create new visit
    
  • Queryeventsbyvisit title: Query events by visit
    
  • Queryidentitiesbyvisit title: Query identities by visit
    
  • Querypagesbyvisit title: Query pages by visit
    
  • Queryvisit title: Query visit
    

PacingAPI title: Pacing REST API

MonitoringDSL title: Business Events DSL