====== Outbound Dialer ======

===== Synopsis =====

Dialer is an addon for Vxi platforms to provide automatic outbound dialing over Asterisk.

===== VXI prerequisites =====   

 - The VXI license needs options **userevents=yes**

 - The vxml.conf, general sections needs **cdroverwrite=yes**, to have correct CDR datas.

===== Web Interface command calls =====

Purge and create a campaign named "campaign" :
    >dialer -c campaign -a drop
    >dialer -c campaign -a create
    >dialer -c campaign -a file -p /tmp/list.txt
    >dialer -c campaign -a insert -phone 12345678
    >dialer -c campaign -a insert -phone 12345678 param

Start  in background :
    >dialer --start
    
Start do not fork, stop on last call :
    >dialer

Stop all dialer (killall)  :
    >dialer --stop

Get log :
    >dialer -a fulldump -c campaign

Get statistics :
    >dialer -a statistics -c campaign 

    
===== Description =====

<code>
Dialer [options] param
</code>

Options:

|–safe |Starts in "safe" mode (auto-restart). |
|–k | clipping, update call row just at the end of call with final results only (override by "clipping" bool dialer.conf file option)|
|–help |This help screen. |
|–stop |Unconditionally stop the dialer. |
|–start |Run as a daemon. |
|–action |Execute a command. |
|–campaign |Name of the campaign for the command. |
|–paramater |Parameter for the command. |
|createdatabase |Create the database. |
|dropdatabase |Drop the database. |
|create |Create the campaign table. |
|drop |Drop the campaign table. |
|truncate |Remove all the phones. |
|file |Use the text file to fill the campaign. The file is CSV, composed of 2 rows separated by a ',' (comma). First row is the phone number, second is an optional parameter string. |
|insert |Insert a phone in the campaign. |
|delete |Delete a phone in the campaign. |
|count |Phones in the campaign. |
|dump |Dump the campaign in csv. |
|fulldump |Dump the campaign in csv with header. |
|statitics |Statistics of the campaign. |

NOTE: Dialer is an application located at this directory:

<code>
/opt/dialer/
</code>

===== Call Return Codes =====

The dialer generates return's codes for each call in the Log file. Please find here the list of codes and its description:

|-8 |Burned (We give up) |
|-7 |Disconnected Number – No Answer |
|-6 |Fax Machine |
|-5 |Network Congestion |
|-4 |Busy |
|-3 |Voicemail – Get called back |
|-2 |No Answer |
|-1 |Undefined%%*%% |
|1 |Not Yet Called – Get called back |
|0 |Callback |
|2 |No Answer |
|3 |Voicemail – Get called back |
|4 |Busy |
|5 |Fast Busy |
|6 |Fax Machine |
|7 |Disconnected Number |
|8 |Do Not Call – Don't count as contacts |
|9 |Invalid Lead |
|10 |No Sale |
|11 |No Sale – These both… |
|12 |Sale – count as contacts |

===== Configuration file =====

The dialer's configuration file is located at:

<code>
/etc/dialer.conf
</code>

Please find here the list of codes and its description:

<code>
;
; Dialer Configuration
;

[general]
debug=true
log=true
mysqlhost=localhost
mysqluser=dialer
mysqlpassword=dialeri6net
asteriskuser=dialer
asteriskpassword=1234
asteriskhost=localhost
asteriskport=5038
mysqldatabase=dialer

[default]
active=true
function=vxml
calltoday=true  ;this avoid call attempts same day, caution!
usednc=false
maxlines=30
attemptsdelay=600
timeout=5000 ; max time in ms before line comes UP
dspmode=none
multiplecalls=false
trunk=SIP
dialprefix=none
callerid=9987803065
filter=0
chanvar=0
chanstr=0
debug=true
skip=0
f_mode=0
f_areacode=0
f_areacode_prefix=0
f_zipcode=0
orderby=attempts_pickups
mode=vxml
timeslot=9h-18h
pause=none
blacklist=none
attempts=1
dialformat=SIP/00%s@voztele-out
maxcaps=10
</code>

Default is the default section campaign parameters.

<code>
Parameters:
active=true                   
function=vxml
calltoday=true                  ; Set it true if you do not do any attemps, nor care of today, simpified loop SQL
usednc=false
maxlines=30			; Number of simultaneous calls
maxcaps=10                      ; Number of calls added on each iteration, "speed of dialing"
attemptsdelay=600		; Delay in seconds between two attempts, default 10minutes (600 seconds)
timeout=5000			; Time out
dspmode=none
multiplecalls=false
trunk=SIP			; Trunk type SIP
dialprefix=none
callerid=9987803065		; SIP account
filter=0
chanvar=0
chanstr=0
debug=true                      ; Enable very verbose debug, and debug files in /tmp
skip=0
f_mode=0
f_areacode=0
f_areacode_prefix=0
f_zipcode=0
orderby=attempts_pickups
mode=vxml                       ; Use VXML uri
uri=http://some/index.vxml
timeslot=9h-18h			; Timeslot
pause=none
blacklist=none
attempts=1			; Number of Attempts (1..n  calls)
dialformat=SIP/00%s@voztele-out	; Dial format chain
clipping=false                  ; do not update intermediate call status, speed up calling
</code>

===== Installation =====

==== Install from package ====

Use root to install the packages. Unzip the video package by using the command:

<code>
tar xvfz dialer_V0-0_2008-08-18_i386.tar.gz
</code>

Go to the directory of the video and type the following command:

<code>
cd dialer_V0-0_2008-08-18
./install.sh
</code>

==== Check Asterisk Setup ====

Stop and Restart Asterisk on your server using the commands:

<code>
/etc/init.d/asterisk stop
/etc/init.d/asterisk start
asterisk -r
</code>

To see the currently installed version of asterisk:

<code>
CLI*> show version
</code>

Access to Dialer at:

<code>
/opt/dialer/
</code>

Access to Dialer Control Panel at:

<code>
http://xxxxxxxx.i6net.org/dialer/
</code>

\\