Asterisk-IM Plugin Readme

Prerequesites

Asterisk installed with the Manager API enabled.

Installation

1. Copy the phone plugin jar file to the OPENFIRE_HOME/plugins directory.
2. Restart Openfire.
3. Configure the asterisk manager connection on the PBX Integration page.

Configuration

Once the plugin is configured, Asterisk-IM can be configured by clicking on the "Asterisk-IM" tab in the Openfire. Required field on the admin page will be marked by an asterisk. You will see the following fields on the admin tool:

• Enabled: Determines whether or not the server is connected to asterisk, receiving events, and allowing actions to occur. When the plugin is first installed this will default to "No".
• Server: The Server where Asterisk is installed. This field is required.
• Port: Port on the Asterisk server that the Asterisk Manager Proxy is listening on. This field will default to 5038 if it is not specified.
• Username: Username to use when connecting to the Asterisk Manager Proxy. This field is required.
• Password: Password to use when connecting to the Asterisk Manager Proxy. This field is required.
• Asterisk Context: The Asterisk context that users will be dialing from. If this field is not specified it will default to "from-sip". Please note that this default value may change for the final release.
• Default Caller ID: The caller id to default to if there is non specified for a particular user. This field will default to an empty value.

Client API

The client API first requires that the Asterisk-IM server plugin is installed. To initialize the client do the following:

XMPPConnection conn = new XMPPConnection("myserver.foo.com", "user", "password");
PhoneClient client = new PhoneClient(conn);

Phone Events

Phone events are notifications from the server that the PBX is going through a state change with one of the current users' devices. Phone events are XMPP packets with a child element phone-event that belongs to the namespace http://jivesoftware.com/xmlns/phone. Phone events are XML elements that contain a type attribute describing what kind of event is being dispatched. They can also contain an attribute device which tells which device (line) the user is receiving a call on. This is useful if the user has more than one telephone line.

Current Phone Events

To listen for events, register an event listener with PhoneClient.addEventListener(..) method:

PhoneClient client = new PhoneClient(conn);
client.addEventListener(new BasePhoneEventListener() {

   // Override the handleRing event to see when we are receiving a call
   public void handleRing(RingEvent event) {
      log.info("receiving a call from " + event.getCallerID());
   }

});

Phone Actions

Phone actions are requests from the client to perform tasks such as dialing an number. They are implemented as IQ packets with child node of phone-action that belongs to the namespace http://jivesoftware.com/xmlns/phone. Phone actions have a type attribute which determines what action to be performed (ie DIAL, FORWARD).

Current Phone Actions:

Links