Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 3.14 KB

README.markdown

File metadata and controls

82 lines (56 loc) · 3.14 KB
Raw

Repo Deprecation Warning

This is no longer the official repository for the Adhearsion project. The official source code repository is now located at http://github.com/adhearsion/adhearsion. Please watch that repository going forward.

Adhearsion

Adhearsion is an open-source voice application development framework. Adhearsion users write applications atop the framework with Ruby and call into their code.

Adhearsion rests above a lower-level telephony platform, for example Asterisk or Voxeo PRISM, and provides a framework for integrating with various resources, such as SQL, LDAP and XMPP (Jabber).

Features

  • An elegant system of call controllers for writing the code which controls a live phone call.
  • An events subsystem which maintains a Thread-pool for executing your namespaced callbacks.
  • A very useful plugin architecture with which you may write Adhearsion plugins and share them with the world via RubyGems.
  • JRuby compatibility for running atop the Java Virtual Machine and using virtually any Java library.
  • Ability to re-use existing Ruby on Rails database models with ActiveRecord/ActiveLDAP
  • Easy interactive communication via XMPP instant messages using the Blather library
  • Strong test coverage
  • Much more

Requirements

  • Ruby 1.9.2+ or JRuby 1.6.7+
  • A VoIP platform:
    • Asterisk 1.8+
    • Prism 11+ with rayo-server
  • An interest in building cool new things

Install

gem install adhearsion

Examples

An Adhearsion application can be as simple as this:

answer
say 'Hello, and thank you for your call. We will put you through to the front desk now...'
dial 'tel:+18005550199'
hangup

For more examples, check out the website.

Documentation

Visit Adhearsion's website for code examples and more information about the project. Also checkout the Adhearsion wiki on Github for community documentation.

If you're having trouble, you may want to try asking your question on the IRC channel (#adhearsion on irc.freenode.net), mailing list or, if you've found a bug, report it on the bug tracker.

Author

Original author: Jay Phillips

Core team:

Contributors: https://github.com/adhearsion/adhearsion/contributors

Contributions

Adhearsion has a set of contribution guidelines which help to smooth the contribution process. There is a pre-commit hook that runs encoding checks available in pre-commit. To use it, please copy it to .git/hooks/pre-commit and make it executable.

Copyright

Copyright (c) 2011 Individual contributors. GNU LESSER GENERAL PUBLIC LICENSE (see LICENSE for details).