CGRateS Documentation

Welcome to CGRateS’s documentation!

CGRateS is a very fast (50k+ CPS) and easily scalable (load-balancer + replication included) Real-time Enterprise Billing Suite targeted especially for ISPs and Telecom Operators (but not only).

• Overview
  • Features
  • Links
  • License
• Architecture
  • cgr-engine
    • Agents
      • DiameterAgent
      • RadiusAgent
      • HTTPAgent
      • DNSAgent
      • AsteriskAgent
      • FreeSWITCHAgent
      • KamailioAgent
      • EventReaderService
    • SessionS
      • Parameters
      • Processing logic
    • RALs
      • Rating
      • Accounting
      • ActionTrigger
      • Action
      • Configuration
      • Use cases
    • CDRs
      • Parameters
      • APIs logic
      • Use cases
    • CDRe
      • Export types
      • Parameters
    • AttributeS
      • Selection
      • Parameters
      • Use cases
    • ChargerS
      • DerivedCharging
      • Processing logic
      • Parameters
      • Use cases
    • ResourceS
      • Parameters
      • Processing logic
      • Use cases
    • RouteS
      • Processing logic
      • APIs logic
      • Parameters
      • Use cases
    • StatS
      • Processing logic
      • Parameters
      • Use cases
    • ThresholdS
      • Processing logic
      • APIs logic
      • Parameters
      • Use cases
    • FilterS
      • Filter profile
      • Filter rule
      • Inline Filter
      • Subsystem profiles selection based on Filters
    • DispatcherS
    • SchedulerS
    • APIerS
    • LoaderS
    • CacheS
    • DataDB
    • StorDB
  • cgr-console
  • cgr-loader
  • cgr-migrator
  • cgr-tester
• Installation
  • Package Installation
    • Debian or Debian-based Distributions
    • Redhat-based Distributions
  • Installing from Source
    • Prerequisites:
    • Installation:
  • Creating Your Own Packages
    • For Debian-based distros:
    • For Redhat-based distros:
  • Post-install Configuration
    • Database Setup
    • Set Versions Data
• Configuration
• Administration
• Advanced Topics
  • API Calls
  • Rating logic
    • User balances
• Tutorial
  • Introduction
  • Scenario Overview
  • Software Installation
  • Configuration and initialization
  • Loading CGRateS Tariff Plans
  • Test calls
    • 1001 -> 1002
    • 1002 -> 1001
    • 1001 -> 1003
  • CDR Processing
  • CDR Exporting
  • Fraud detection
• Troubleshooting
  • Memory Profiling
    • Creating the memory profile files
    • Reading the memory profile files
• Miscellaneous
  • FreeSWITCH integration
    • SessionManager