modules/asterisk/README.txt

$Id: README.txt,v 1.4 2006/09/19 16:00:32 thehunmonkgroup Exp $

This module provides integration with the Asterisk software PBX,
including both some basic built-in call/record/playback functionality,
and an API allowing other modules to make use of these functions.

Some things you can do with this module currently:

1. Call yourself: Visit your account page. Under the 'Telephone' section,
   click 'call me', and Asterisk will call you and play a demo. 
2. Call another user: Visit a user's account page. Under the 'Telephone'
   section, click 'call user', and Asterisk will first call your number,
   then call the user's number and bridge the call. 
3. Call another person: Enter the person's phone number in the 'Make call'
   block. Click 'call now'. Asterisk will first call your number, then
   call the number you entered and bridge the call. 
4. Record a message and attach it to a node: Create, for example, a blog
   entry. Save it, and on the blog page, click on 'record attachment'.
   Enter a filename for the attachment, select whether you want it
   initially displayed in the listings or not, and click 'Record file'.
   Asterisk will call you, and when you hear the beep, record your
   message, then hang up. Wait a few moments and refresh the page. The
   file you recorded will now be attached to the blog entry. 
5. Listen to a recorded asterisk file by phone: Click on one of the links
   under the 'Recent audio files' block. Asterisk will call you and play
   the recording. 

See INSTALL.txt for installation instructions.

It is a distributed system. The Drupal site communicates with the
Asterisk server via XML-PRC-- therefore, the Drupal site can be on a
regular webserver while the remote Asterisk server (properly configured
for Drupal integration) completes the calls.

Please note: setting up an Asterisk server can be a challenging and
frustrating process if you've never done it before--it's highly
recommended that you find somebody who knows what they are doing to help
you! Also, there is no support of any kind provided for the server-side
functionality of this module--it is expected that if you're attempting to
set it up, then you have the requisite Asterisk/Drupal/sysadmin skillsets
to troubleshoot any issues on your own!

If you don't have an Asterisk server properly set up for Drupal
integration you can email me. I can configure my Asterisk server to
complete your calls so that you may test this system, or you can visit
the demo site and set up an account there for demonstration purposes.

This module was originally developed by Herman Webley, and has been
rewritten for Drupal 4.7 and beyond (and is currently maintained by)
Chad Phillips.

Chad Phillips <thehunmonkgroup at gmail dot com>
hunmonk in #drupal on irc.freenode.net
Demo site: http://asterisk.drupal.xcarnated.com
1	$Id: README.txt,v 1.4 2006/09/19 16:00:32 thehunmonkgroup Exp $
2
3	This module provides integration with the Asterisk software PBX,
4	including both some basic built-in call/record/playback functionality,
5	and an API allowing other modules to make use of these functions.
6
7	Some things you can do with this module currently:
8
9	1. Call yourself: Visit your account page. Under the 'Telephone' section,
10	click 'call me', and Asterisk will call you and play a demo.
11	2. Call another user: Visit a user's account page. Under the 'Telephone'
12	section, click 'call user', and Asterisk will first call your number,
13	then call the user's number and bridge the call.
14	3. Call another person: Enter the person's phone number in the 'Make call'
15	block. Click 'call now'. Asterisk will first call your number, then
16	call the number you entered and bridge the call.
17	4. Record a message and attach it to a node: Create, for example, a blog
18	entry. Save it, and on the blog page, click on 'record attachment'.
19	Enter a filename for the attachment, select whether you want it
20	initially displayed in the listings or not, and click 'Record file'.
21	Asterisk will call you, and when you hear the beep, record your
22	message, then hang up. Wait a few moments and refresh the page. The
23	file you recorded will now be attached to the blog entry.
24	5. Listen to a recorded asterisk file by phone: Click on one of the links
25	under the 'Recent audio files' block. Asterisk will call you and play
26	the recording.
27
28	See INSTALL.txt for installation instructions.
29
30	It is a distributed system. The Drupal site communicates with the
31	Asterisk server via XML-PRC-- therefore, the Drupal site can be on a
32	regular webserver while the remote Asterisk server (properly configured
33	for Drupal integration) completes the calls.
34
35	Please note: setting up an Asterisk server can be a challenging and
36	frustrating process if you've never done it before--it's highly
37	recommended that you find somebody who knows what they are doing to help
38	you! Also, there is no support of any kind provided for the server-side
39	functionality of this module--it is expected that if you're attempting to
40	set it up, then you have the requisite Asterisk/Drupal/sysadmin skillsets
41	to troubleshoot any issues on your own!
42
43	If you don't have an Asterisk server properly set up for Drupal
44	integration you can email me. I can configure my Asterisk server to
45	complete your calls so that you may test this system, or you can visit
46	the demo site and set up an account there for demonstration purposes.
47
48	This module was originally developed by Herman Webley, and has been
49	rewritten for Drupal 4.7 and beyond (and is currently maintained by)
50	Chad Phillips.
51
52	Chad Phillips <thehunmonkgroup at gmail dot com>
53	hunmonk in #drupal on irc.freenode.net
54	Demo site: http://asterisk.drupal.xcarnated.com