The free Java library for Asterisk PBX integration.
Java
Pull request Compare This branch is 498 commits behind asterisk-java:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
examples
lib/clover
src
.gitignore
ANNOUNCEMENT
CHANGES
LICENSE.txt
README.md
atlassian-ide-plugin.xml
checkstyle.xml
codestyle.xml
pom.xml

README.md

README for Asterisk-Java

INTRODUCTION

The Asterisk-Java package consists of a set of Java classes that allow you to easily build Java applications that interact with an Asterisk PBX Server. Asterisk-Java supports both interfaces that Asterisk provides for this scenario: The FastAGI protocol and the Manager API.

The FastAGI implementation supports all commands currently available from Asterisk.

The Manager API implementation supports receiving events from the Asterisk server (e.g. call progess, registered peers, channel state) and sending actions to Asterisk (e.g. originate call, agent login/logoff, start/stop voice recording).

A complete list of the available events and actions is available in the javadocs.

See docs/tutorial.html for examples.

GETTING ASTERISK-JAVA

Asterisk-Java is available from http://asterisk-java.org

INSTALLATION FROM SOURCE

git clone https://github.com/srt/asterisk-java.git
cd asterisk-java
mvn install

After the build is complete, the jar will then be built as target/asterisk-java.jar in the asterisk-java directory.

EXAMPLE

The file 'examples/ExampleCallIn.java' will answer the call and playback the audio file 'tt-monkeys'.

import org.asteriskjava.fastagi.AgiChannel;
import org.asteriskjava.fastagi.AgiException;
import org.asteriskjava.fastagi.AgiRequest;
import org.asteriskjava.fastagi.BaseAgiScript;
/* Example incoming call handler
Answer call, speak message */
public class ExampleCallIn extends BaseAgiScript {
  public void service(AgiRequest request, AgiChannel channel) throws AgiException {
    answer();
    exec("Playback", "tt-monkeys"); 
    hangup();
  }
}

The file 'examples/fastagi-mapping.properties' maps your Asterisk diaplan context to the class you would like to invoke above.

callin.agi = ExampleCallIn

To compile and run do:

javac -cp asterisk-java.jar ExampleCallIn.java
java -cp asterisk-java.jar org.asteriskjavafastagi.DefaultAgiServer

SYSTEM REQUIREMENTS

Asterisk-Java needs a Java Virtual Machine of at least version 1.6 (Java SE 6.0). If you want to build the jar from source, you will also need Maven.

LEGAL

Asterisk-Java is subject to the terms detailed in the license agreement accompanying it.