Welcome to jaspion Docs

Jaspion is a python library designed to process events received from FreeSwitch via ESL.

What is FreeSwitch?

FreeSWITCH is a free and open-source application server for real-time communication, WebRTC, telecommunications, video and Voice over Internet Protocol (VoIP). Multiplatform, it runs on Linux, Windows, macOS and FreeBSD. It is used to build PBX systems, IVR services, videoconferencing with chat and screen sharing, wholesale least-cost routing, Session Border Controller (SBC) and embedded communication appliances. It has full support for encryption, ZRTP, DTLS, SIPS. It can act as a gateway between PSTN, SIP, WebRTC, and many other communication protocols. Its core library, libfreeswitch, can be embedded into other projects. It is licensed under the Mozilla Public License (MPL), a free software license. wikipedia.

What is ESL?

ESL is a way to communicate with FreeSwitch. See more details here.

How to contribute

If you are thinking of contributing in any way to the project, you will be very welcome. Whether it’s improving existing documentation, suggesting new features or running existing bugs, it’s only by working together that the project will grow. Do not forget to see our Contributing Guide and our Code of Conduct to always be aligned with the ideas of the project.

Library Documentation

• Get Started
  • Show me the code
  • Understanding Jaspion
  • Choosing Events
• Installation Instructions
  • PyPi
  • Source Code
• Package Tools
  • Filtrate
  • AbstractBaseHandler
  • Command
• Commnad Line Interface
  • Settings
  • Application Factory
  • Commands

Examples

• Monitoring an Extension
• How to use Sketch
• How to use a class to handle events
• Record registers on Redis