common/types/ConfigTypes | @screenmeet/js-sdk

Index

Type aliases

CobrowseDeployment

CobrowseDeployment: { CobrowseDomains: CobrowseDomain[]; OrganizationId: number; createdAt: string; entrypoint: string; id: number; is_multidomain: false; key: string; name: string; updatedAt: string }

Type declaration

CobrowseDomains: CobrowseDomain[]
OrganizationId: number
createdAt: string
entrypoint: string
id: number
is_multidomain: false
key: string
name: string
updatedAt: string

CobrowseDomain

CobrowseDomain: { CobrowseDeploymentId: number; OrganizationId: number; createdAt: string; domain: string; id: number; is_entrypoint: boolean; is_validated: boolean; updatedAt: string }

Type declaration

CobrowseDeploymentId: number
OrganizationId: number
createdAt: string
domain: string
id: number
is_entrypoint: boolean
is_validated: boolean
updatedAt: string

EndpointConfig

EndpointConfig: { widgetConfig: { activation_base_url: string; agent_portal_base_url: string; cobrowse: true; embedded_live_url: string; live: true; live_url: string; remote_support: true; replay: true; replay_url: string; vanity_url: string; viewer_base_url: string } }

Type declaration

widgetConfig: { activation_base_url: string; agent_portal_base_url: string; cobrowse: true; embedded_live_url: string; live: true; live_url: string; remote_support: true; replay: true; replay_url: string; vanity_url: string; viewer_base_url: string }
- activation_base_url: string
  
  The base URL for the remote-support landing page for end-users
- agent_portal_base_url: string
  
  The agent UI base interface
- cobrowse: true
  
  Is cobrowse enabled for the org
- embedded_live_url: string
  
  The embedded live URL that can be used to embed the meeting join experience
- live: true
  
  Is live enabled for the org
- live_url: string
  
  The base Live URL used to construct links for end-users and agents
- remote_support: true
  
  Is remote support enabled for the org
- replay: true
  
  Is replay enabled for the org
- replay_url: string
  
  The base Replay URL used to construct links for end-users
- vanity_url: string
  
  The vanity URL that can be given to users by phone to enter their PIN to enter the session
- viewer_base_url: string
  
  The base URL for the remote-support viewer user interface