JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example some fixes Sep 5, 2015
lib
spec
.gitignore add grunt task for coverage Mar 16, 2015
.travis.yml
Gruntfile.js
LICENSE
README.md fix Jan 1, 2016
app.js
config.js
index.js
package.json

README.md

voicer

AGI voice recognizer for Asterisk [use Yandex, Google or Wit.ai ASR online services]

Call to special extension, say "Vasya" and Asterisk connect you with Vasya! Excellent!

Build Status

Workflow

Voicer work as AGI-server. Voicer accept request from asterisk via AGI app. It run handler for each request. Handler command asterisk record file.

After this send file to recognition service, receive text, search by text in source of data for finding concordance, if source have this text it return channel for call, voicer set dialplan vars RECOGNITION_RESULT as SUCCESS and RECOGNITION_TARGET for finded result.

After this voicer return control to dialplan. Build rules of dialplan using RECOGNITION_RESULT and RECOGNITION_TARGET.

Use

Install

$ npm install voicer -g [--save]

Config

create config.js (see @configuration)

Run

config.js set env var VOICER_CONFIGFILE or must be in current dir

$ voicer

set env var:

 export VOICER_CONFIGFILE=/etc/voicer/config.js

remove

 unset VOICER_CONFIGFILE

Configuration

Config.js

{
    agi: {
        port: 3000
    },
    web: {
        port: 3100,
        auth: true,    // or false 
        username: 'vasya',
        password: 'password',
        realm: 'My company'
    },
    processing: {
        totalAttempts: 2,
        playGreeting: true,
        playBeepBeforeRecording: false   //use system beep
    },
    asterisk: {
        sounds: {
            onErrorBeforeFinish: 'invalid',
            onErrorBeforeRepeat: 'invalid',
            greeting: 'beep'
        },
        recognitionDialplanVars: {
            status: 'RECOGNITION_RESULT',
            target: 'RECOGNITION_TARGET'
        }
    },
    record: {
        directory: '/tmp',
        type: 'wav',
        duration: 2,
    },
    recognize: {
        directory: '/tmp',
        type: 'witai',    // ['yandex', 'google', 'witai']
        options: {
            developer_key: '6SQV3DEGQWIXW3R2EDFUMPQCVGOEIBCR'
        }
    },
    lookup: {
        type: 'file',
        options: {
            dataFile: 'data/peernames.json'
        }
    },
    logger: {
        console: {
            colorize: true
        },
        file: {
            filename: '/var/log/voicer.log',
            json: false
        }
    }
};

Asterisk

Write dialplan for call to AGI-server voicer like

[default]
exten=1000,1,AGI(agi://localhost:3000)
exten=1000,n,GotoIf($[${RECOGNITION_RESULT}=SUCCESS]?:default,1000,4)
exten=1000,n,Dial(${RECOGNITION_TARGET})

Format peernames

[
    ....

    {
        "name": "Vasya",
        "target": "SIP/Sf567890",
        "variants": ["vasya", "vasya petrov"]
    },
    
    ....

]

Some more

Also you can tune additional options in config.js.

Try find optimal value for duration of record.

Errors?!

Bugs?! Oh, contact with me. I want to eat them.

Links

Yandex API key: https://developer.tech.yandex.ru/

Google API key: https://console.developers.google.com/

Wit.ai API key: http://wit.ai

Voice speed dial on Asterisk http://habrahabr.ru/post/248263/ (russian)

Development

Test

npm test

Code coverage

grunt