Documentation

Incoplax-platform

    • Architecture
      • Platform stack architecture
        • Introduction
        • Chapter 1. Input data
        • Chapter 2. Basic categories and technologies
        • Chapter 3. Cases for deep architecture immersion
        • Chapter 4. Product scheme
        • Chapter 5. Quality attribute management methodologies
      • Articles
        • Site availability and data integrity
        • Functional capabilities
    • Configuration
      • Server local configuration (local.cfg.json)
      • Categories
        • aliases
        • domains
        • sites
        • servers
        • roles
        • structure
        • general
      • Roles
        • ap
        • b2bua
        • bgmg
        • broker
        • callstore
        • conf
        • dfsync
        • dms
        • domstore
        • email
        • esg
        • fs
        • huntq
        • ic
        • im
        • ivr
        • logstore
        • mdc
        • meet
        • mg
        • mgc
        • mic
        • mix
        • msvc
        • mware
        • prompt
        • recmover
        • redirect
        • reg
        • rpci
        • rpco
        • rsv
        • sdc
        • sel
        • sg
        • st
        • sts
        • svc
        • usr
        • vmail
        • ws
        • wssubscr
    • Entities
      • master
        • borderrule (Border filter rule)
        • configuration (Cluster configuration)
        • product_layer_multi (Product layer of all domains)
        • sipmodrule (Border SIP message modification rule)
      • domain
        • domain (Child domain)
        • storage (Storage)
        • role (User role)
        • role_caches (Cache of users with role)
        • group (User group)
        • group_caches (Cache of users in group)
        • user_caches (Cache of user groups and roles)
        • mservice (Product microservice)
        • product_layer (Domain product layer)
        • project (Project)
        • roleapp (Role application)
        • setting (Domain settings)
        • storagerule (Storage rules)
        • subordination (Subordination)
        • subordination_caches (Subordination cache)
        • workday (Working days)
      • iam
        • user (User)
      • design
        • class (Class)
      • uc
        • sipuser (Internal subscriber account)
        • redirectrule (Redirect rule)
        • sipgroup (Simultaneous call group)
        • sipkit (Functional group)
        • route (Routing vector)
        • vectorrule (Routing rule)
        • representative (Representation rule)
        • provider (Telephony provider account)
        • provider_callerid (Normalization rule)
        • featurecode (Subscriber feature code)
        • featurerule (Feature code rule)
        • recordrule (Recording rule)
        • asrrule (Transcription rule)
        • hunt (Hunt group)
        • imchannel (Messenger channel)
        • ivrscript (IVR script)
        • selector (Selective meeting)
          • participant (Participant)
          • voting (Voting)
          • topology (Topology)
      • service
        • integration_point (Integration channel)
        • svcscript (Service script)
        • svctask (Service task)
      • journal
        • changes (Change history)
    • API
      • /rest/v1
        • public
          • resources
            • favicon
            • logo
            • defaults.json
          • domain_resources
            • favicon
            • logo
          • version
        • fs
          • targets
            • Metadata (METADATA)
            • Directory operations
            • Move and rename a file
            • Download and upload a directory as an archive
            • Non-standard methods in the path
            • alertcall
            • ap_configurations
            • ap_constants
            • ap_templates
            • cacerts
            • conf
            • cpd_templates
            • cpd_tests
            • custom
            • files
            • globalshare_domain
            • globalshare_public
            • parking
            • product
            • recnotify
            • selector
            • siteshare_domain
            • siteshare_public
            • syncroot_common
            • syncroot_domain
            • token
            • voicemail
            • waitonhold
            • waitonholdcustom
            • waitonhold_domain
            • waitonqueue
            • websocktemp
            • www
          • Section descriptions (targets)
        • reference
          • extobjs
        • master
          • activationcode
          • borderrules
          • sipmodrules
          • configurations
          • currentconfiguration
          • license
          • product_layer_multi
          • logicalroles
            • all
              • cacerts
            • ap
              • bannedaddrs
            • script
              • sections
            • esg
              • bannedaddrs
              • dashboards
            • sg
              • bannedaddrs
              • cert
              • dashboards
            • ws
              • bannedaddrs
              • bannedaddrs/site
              • cert
              • sessions
          • nodes
          • snmp
          • installer
        • addressbook
          • combined_contacts
          • contacts
          • contactgroups
        • iam
          • roles
          • sessions
          • pwd_reset_requests
          • invites
          • users
            • avatar
            • sessions
        • journal
          • changes
        • uc
          • alertcalls
          • calls
          • calls_by_participation
          • conferences
          • conferences_by_participation
          • featurecodes
          • sipgroups
          • hunts
          • hunt_runtimes
          • imchannels
          • ivrscripts
          • ivrscript_runtimes
          • provider_callerids
          • providers
          • recordrules
          • redirectrules
          • representatives
          • routes
          • selector
            • participants
            • topology
            • votings
          • sipusers
            • device
          • sipuser_states
          • vectorrules
        • service
          • integration_points
          • svcscripts
          • svcscript_runtimes
          • svctasks
          • webhooks
        • metadata
        • domain
          • crypto_values
          • domains
            • roles
            • users
          • groups
          • groups_caches
          • license
          • users_caches
          • subordinations
          • subordination_caches
          • mservices
            • attachment
          • nservices
          • product_layer
          • projects
          • roleapps
            • attachment
          • roles
          • roles_caches
          • settings
          • storagerules
          • storages
          • workdays
        • user
          • info
          • avatar
          • pwd
          • ext
          • settings
          • sip
            • accounts
              • redirect_rules
              • voicemail_messages
              • archive_voicemail_messages
              • callback_requests
            • calls - Current calls involving the user
            • conferences - Current conferences involving the user
        • design
          • classes
            • sections
            • metadata
        • model (dynamic data model)
          • API overview
          • Predefined collections
      • /api
        • admin
          • Downloading call recordings
          • Configuration file management
          • License management
          • Distribution build and role restart
          • Installing patches
          • System restart
          • System update management
        • monitor
          • System monitoring
          • Call tracing and log collection
          • Log collection
          • SIP gateway
          • B2BUA
          • External SIP gate
          • Web server
          • Conferences
          • IVR
          • Media gateway controllers
          • Configuration master
          • Domain centers
          • SIP device registrations
          • State storage
          • Subscription storage
          • Hunt groups
          • Active scripts
        • health (without authorization)
          • Web server state and availability
        • test
          • CallerId/CalledId transformation rule testing
          • Representation rule testing
          • Routing testing
        • token
          • Downloading call recordings
          • Messenger webhooks
          • Handling a request in a service script
          • Token check
          • Integration channel files
          • Event subscription with webhooks
      • External authorization and identification (OAuth 2.0 and OpenID Connect 1.0)
      • /exec
      • MCP server (/mcp/v1)
      • WebSocket-API
        • Token-API
          • rest
          • subscr
          • ivrapi
          • ccs
          • callrecord
        • User-API
          • rest
          • subscr
          • webconstr
          • dmsquery
    • Scripts
      • Script types
        • Service scripts
        • IVR scripts
      • Script components
        • Common script components
          • Region
          • Start
          • Stop
          • Pause
          • Comparison
          • Menu
          • Assignment
          • Run script
          • File operation
          • Voicemail
          • Notice
          • SQL query
          • Event generation
          • S3 storage access
          • Running process
          • Web request to direct URL
          • Sending e-mail
          • Receiving e-mail
          • Parser
          • Outgoing call
          • Script interaction
          • LDAP query
          • Web request to integration channel
          • Operation with websocket connection
          • Operation
          • Monitor
          • Mutex
          • Go to label
          • Label
          • Function call
          • Return from function
          • JS code
          • Calling a product layer microservice
          • GPT request
          • Query to product layer
        • IVR script components
          • End call
          • SIP-Response
          • Translation to number
          • Reproduction
          • Reproduction of numerals
          • DTMF reception
          • Sound recording
          • Sending a fax
          • Receiving a fax
          • Translation with shoulder substitution
          • Controlled call translation
          • Parking
          • Operation
          • Speech synthesis (MRCPv2)
          • Speech recognition (MRCPv2)
          • External control via API
          • Response detector
          • Speech synthesis (Sber SaluteSpeech)
          • Speech recognition (Sber SaluteSpeech)
          • Call Center
          • Speech synthesis (Azure Speech)
          • Speech recognition (Azure Speech)
      • Script engine
        • Variables
        • Arguments
        • Expressions
        • Functions
      • Script Editor
    • Events
      • alertcallevents
        • callanswered
        • callapproved
        • callfailed
        • callfinished
        • callinited
        • callpreanswered
        • callrejected
        • callstarted
        • prepared
        • statechanged
      • callevents
        • call_asr
        • call_rec_links
        • dlg_binding
        • dlg_call
        • dlg_dead
        • dlg_down
        • dlg_end
        • dlg_init
        • dlg_pcs
        • dlg_pickup
        • dlg_start
        • dlg_stop
        • dtmf
        • fork_answer
        • fork_cancel
        • fork_preanswer
        • fork_redirect
        • fork_start
        • fork_stop
        • hold
        • invite
        • media_migrate_done
        • rec_info
        • rec_changed
        • records_moved
        • refer
        • refer_aborted
        • referring_invite
        • replaces_invite
        • replaces_refer
        • route
        • route_dead
        • route_feature
        • route_fin
        • route_redirect
        • route_referred
        • route_replacing
        • unhold
        • user_redirect
      • ccsevents
        • call_attach_to_seance
        • call_create
        • call_delete
        • call_dtmf
        • call_set_state
        • call_update
        • connection_attach_to_seance
        • connection_create
        • connection_delete
        • connection_failure
        • connection_link_call
        • connection_record_changed
        • connection_set_asr
        • connection_set_record_info
        • connection_start_record
        • connection_update
      • confevents
        • call_attach
        • call_detach
        • conf_dead
        • conf_init
        • conf_rec_links
        • conf_start
        • conf_stop
        • fork_answer
        • fork_preanswer
        • fork_start
        • fork_stop
      • ctievents
        • call_cleared
        • call_delivered
        • call_established
        • call_held
        • call_retrieved
        • call_transfer
        • $system
      • ivrevents
        • init
        • sm_start
        • sm_stop
        • sm_dead
        • script_start
        • call_replace
        • api_start
        • api_stop
      • modelevents
        • data_changed
      • providerevents
        • provider_state_changed
      • scriptevents
        • script_start
        • script_stop
      • selectorevents
        • sel_abon_state_changed
        • sel_create
        • sel_delete
        • sel_state_changed
        • sel_update
        • sel_voting_state_changed
      • registrarevents
        • user_registered
        • user_unregistered
        • sipuser_registered
        • sipuser_unregistered
        • clear
      • statesevents
        • user_state_changed
        • sipuser_state_changed
        • sipuser_transtate_set
    • File system
      • Application directory
      • Node working directory
      • Local paths
    • Log files
    • License
    • Assets
      • System assets
        • DB
          • Requests for creating the initial DB structure
          • DB structure updates
        • Scripts
          • Script editor component icons
          • New script content
          • Default scripts for base services
          • Script structure metadata
        • Configuration
          • Default TLS certificate for SIP
          • Default TLS certificate for the web server
          • Sound accompaniment files
          • Service scripts for update hooks
          • RTX MediaGate application
          • RTX Mixer application
          • CPD application
          • SpeechAnalytics application
          • System scripts
          • VirtualIP management scripts
      • Product assets
        • Public resources
        • Base license
        • IAM access settings
        • Master domain events generated for subscribers and brokers
        • Static web server resources and applications
        • Web application routing
        • Preconfigured entities (fixtures)
        • Permissions
        • Connector
        • Language files (internationalization)
      • Domain category assets (solution)
        • Composition of required logical roles
        • IAM access settings
        • Integration channel types
        • Hidden script descriptor
        • Hidden scripts
        • Script restrictions
        • Working domain events generated for subscribers and brokers
        • System web application composition
        • Preconfigured entities (fixtures)
    • Instructions
      • Installation using the installer
        • Overview
        • Initial server configuration
        • Installing packages on a server without internet access
        • Installing the master server
        • Creating and activating the configuration
        • Installing the slave server
        • Initial master domain configuration
        • Creating a working domain
        • Installing the platform product layer
        • Configuring telephony for the first call
        • Configuring video conferencing (meet)
      • System update
        • Hot patch
        • Warm update
        • Cold upgrade
        • Rollback to version 1.11
      • System health monitoring
        • System state polling
        • System state warnings and actions
        • Administrator bot
        • SNMP traps
      • Moving a single-server system to another server
      • Platform installer
        • Getting started
          • What the installer does
          • Server requirements
          • Preparation
        • Installation
          • Installation on the current server
          • Installation on a remote server
          • PostgreSQL separate from the platform
          • Removal
          • Start command for an existing container
        • Unattended operation
          • Running without questions
          • Logs and return codes
          • What to do on error
          • End-to-end examples
        • References
          • Parameter reference
          • Return codes
          • What is installed on each OS
      • Application shelf
      • File management
    • Articles
      • Telephony providers
      • Codecs and media negotiation
      • Call recording
      • Connecting a new partition for recording storage
      • Subscriber accounts without registration
      • Subscribers behind a PBX
      • Preset user roles
      • CoS/CoR group access separation
      • Connecting SSL certificates
      • Adding a new OAuth authorization provider
      • Telephone call servicing
      • Two-server configuration: pros and cons
      • Conversation recovery
      • Virtual IP configuration
      • Platform control script via CLI
      • Hot domain redundancy
      • Encryption and keys
      • Integration channel tokens: where they are used and how they are protected
      • Working with the platform via an AI agent (MCP)
      • Split-brain problem and quorum monitoring
      • Notification channels from the system
      • Sizing approaches
      • Disk load
      • Ports used by the system
      • Frequently asked questions about video conferencing (meet)
      • Hunt group configuration
      • Call center data model class diagrams
    • Change history
      • v/1.13.0
      • v/1.12.0
      • v/1.11.0
      • v/1.10.0
      • v/1.9.0
      • v/1.8.0
      • v/1.7.0
      • v/1.6.0
      • v/1.5.0
Incoplax-platform 1.12.0
  • Incoplax-platform
    • 1.12.0
  • Incoplax-platform
  • API
  • /rest/v1
  • service

Service resources (service)

Resources representing instances of service processes, their execution settings, or integration functionality settings.

Contents

  • integration_points

  • svcscripts

  • svcscript_runtimes

  • svctasks

  • webhooks

  • Personalization
  • Increase font size
  • Decrease font size