Onderwerp: MINI-HOWTO: Naamherkenning in Asterisk (AGI/PHP)

Introductie

Gezien er al genoeg HOWTO's zijn over hoe je een Asterisk-server opzet en deze koppelt aan diverse VOIP- en PSTN-netwerken, maar eens even heel iets anders.

In deze tutorial zal ik uitleggen hoe je de nummerherkenning in Asterisk kan uitbreiden met de namen van de bellers. De bedoeling is een eenvoudig maar compleet werkend voorbeeld te presenteren dat je zelf naar eigen wens kan uitbreiden.

Technische basis

We maken gebruik van de AGI-interface in Asterisk. Dit is vergelijkbaarheid met CGI's in je webserver. Maar -zoals duidelijk mag zijn- dan om de functionaliteit van je VOIP-server uit te breiden. In dit voorbeeld maken we gebruik van PHP als programmeertaal met MySQL als backend voor het telefoonboek. Ik ga ervanuit dat iedereen hier deze tools wel klaar voor gebruik heeft.

Tenslotte ga ik ervanuit dat je over een toestel beschikt dat niet alleen nummers, maar ook namen kan weergeven. Veel VOIP-toestellen kunnen dit wel, maar de goedkopere Grandstream-toestellen bijvoorbeeld niet, en ook mensen met een gewone telefoon aangesloten op een ATA zullen hier geen profijt van trekken.

PHPAGI package

Om eenvoudig AGI's te kunnen programmeren in PHP is er het PHPAGI-project. Download de tarball van http://phpagi.sourceforge.net/ en pak het zaakje uit. De PHP-scripts in de hoofdmap hiervan zet je in je /var/lib/asterisk/agi-bin directory.

Een eerste testscript

Lekker snel to the point nu. We willen immers resultaat zien!

Maak het bestand callerid.php in /var/lib/asterisk/agi-bin/ waarbij je in het onderstaande voorbeeld de variabele $miniBook kan vullen met nummers en namen.

PHP Code:

#!/usr/local/bin/php -q
<?php

    // agi stuff
    require "phpagi.php";
    $agi = new AGI();
    $as = $agi->new_AsteriskManager();

    // get callerid
    $cid = $agi->parse_callerid();
    $callernum = $cid["username"];
    if (substr($callernum, 0, 4) == "0031") $callernum = "0".substr($callernum, 4);
    if (substr($callernum, 0, 2) == "31") $callernum = "0".substr($callernum, 2);

    // mini-adresboek
    $miniBook = array();
    $miniBook["020638ENZO"] = "Basemotive";
    $miniBook["06ENZOENZO"] = "Ikzelf GSM";

    foreach ($miniBook as $nr => $name) {
        if ($nr == $callernum) {
            $agi->set_callerid("\"$name\"<$callernum>");
            exit;
        }
    }
?>

Pas je dialplan aan in /etc/asterisk/extensions.conf, stel je dialplan voor vanaf extern is:

Code:

[from-external]
exten => _X.,1,Verbose(Call from ${CALLERIDNUM} to ${EXTEN})
exten => _X.,2,Ringing
exten => _X.,3,Dial(SIP/200,60,tT)

dan voeg je daar een aanroep voor callerid.agi in. Het wordt dan:

Code:

[from-external]
exten => _X.,1,Verbose(Call from ${CALLERIDNUM} to ${EXTEN})
exten => _X.,2,Ringing
exten => _X.,3,agi,callerid.php
exten => _X.,4,Dial(SIP/200,60,tT)

Zodra je nu vanaf een van de bekende nummers belt zal je zien dat op je telefoontoestel de naam van die beller zal verschijnen.

De volgende stap: MySQL

Als je heel erg veel namen wilt plaatsen, of je telefoonboek via het web toegankelijk wilt maken, dan wil je natuurlijk je gegevens in een database zetten. Hier geef ik een voorbeeld met MySQL.

Maak een MySQL-database aan voor deze zaken, en maak de pbook-tabel met de volgende query:

Code:

create table pbook (
    phone text,
    name text
);

vul je tabel met wat gegevens:

Code:

insert into pbook values ('06ENZOENZO', 'Ikzelf GSM');

Vul je callerid.php-script met de volgende code:

PHP Code:

#!/usr/local/bin/php -q
<?php
    // settings
    $dbhost = "localhost";
    $dbuser = "foonboek";
    $dbname = "foonboek";
    $dbpass = "f7892JeDO";

    // agi stuff
    require "phpagi.php";
    $agi = new AGI();
    $as = $agi->new_AsteriskManager();

    // get callerid
    $cid = $agi->parse_callerid();
    $callernum = $cid["username"];
    if (substr($callernum, 0, 4) == "0031") $callernum = "0".substr($callernum, 4);
    if (substr($callernum, 0, 2) == "31") $callernum = "0".substr($callernum, 2);

    // connect to db
    mysql_connect($dbhost, $dbuser, $dbpass) or die ("Failed to connect to the database!");
    mysql_select_db($dbname) or die(mysql_error());

    // No caller-id? Show 'Onbekend'
    if ($result_cid == "" && ($callernum == "" || $callernum == "asterisk"))
        $result_cid = "\"Onbekend\"<onbekend>";

    // check local phonebook
    if ($result_cid == "") {
        $query = "select * from pbook where phone = '$callernum'";
        $result = mysql_query($query) or die(mysql_error());
        if ($row = mysql_fetch_array($result))
            $result_cid = "\"".$row["name"]."\"<$callernum>";
    }

    // Unknown......
    if ($result_cid == "") {
        $result_cid = "\"$callernum\"<$callernum>";
    }

    $agi->set_callerid($result_cid);
?>

Als alles klopt zal je nu ook zien dat keurig een naam wordt weergegeven op het display. Je kan nu zelf een web-applicatie maken waarmee je het telefoonboek kan vullen (als je dat wilt natuurlijk).

Het ultieme telefoonboek: De CD-foongids

Wil je echt heel graag veel namen zien, maar heb je geen zin om alle vage bekenden die je ooit weleens bellen in de database te gaan lopen kloppen, weet dan dat een ander al voor je heeft zitten kloppen.

Met een CD-foongids en het programma Foondump heb je de mogelijkheid je MySQL-database in no-time te vullen met een hele berg namen en nummers. Let op: Met de implementatie hiervan balanceer je op het randje van de wet. Ik laat jullie dit zien omdat het technisch gezien KAN. Zorg voor jezelf dat je je aan de regelgevingen houdt.

De foondump-documentatie vertelt genoeg over hoe je de gegevens in een database krijgt. Dat hoef ik volgens mij niet verder toe te lichten.

Afijn. Genoeg gezeurd. Hier is het laatste stukje PHP-code. De fijne query voor het zoeken van een naam bij een nummer heb ik onttrokken aan het programma fs2005.php dat ook op de foondump-site te vinden is.

Het volgende fragment plaats je boven de laatste regel (die met 'agi->...'):

PHP Code:

    // check public phonebook
    if ($result_cid == "") {
        $query = "select white_subscriber.*, (housenumber+0.00) as housenr, count(white_info.id) as infocnt from white_subscriber ,white_phonenumber left join white_info on white_info.id = white_subscriber.id where white_phonenumber.phone='$callernum' and white_phonenumber.id = white_subscriber.id group by white_subscriber.id, white_info.id order by postalcode,housenr limit 1";
        $result = mysql_query($query) or die(mysql_error());
        if ($row = mysql_fetch_array($result)) {
            $name = $row["firstname"]." ".($row["infix"]?$row["infix"]." ":"").$row["lastname"];
            $result_cid = "\"$name\"<$callernum>";
        }
    } 


Slotsom

Zoals ik heb laten zien is de functionaliteit van Asterisk middels AGI op eenvoudige wijze uit te breiden. Ik hoop dat jullie hier iets aan hebben, en er zo mogelijk zelfs nog iets van geleerd hebben. Laat me weten of dit leuk gevonden wordt!

De voorbeelden hier steken niet perfect in elkaar. Zorg dat je in een productie-omgeving de variabelen goed checkt en je variabelen in queries netjes afhandelt.

Vervolg?

Indien er interesse is kan ik bijvoorbeeld nog uit de doeken doen hoe je met AGI bepaalt welke toestellen er over moeten gaan, en dit zelfs web-based kan configureren.

Of misschien hebben jullie meer interesse in de Manager API. Ook hiermee zijn leuke dingen te realiseren.

Ga hier binnenkort eens mee aan de slag, Bedankt Ziet er netjes uit

Ik ben nu bezig met mijn eigen asterisk server, en neem dit in iedergeval mee. heb wel intresse in meer info

Ik denk dat ik ook hier eens binnenkort mee ga spelen, ziet er intressant uit.

Wij gaan binnenkort ook testen met een asterisk server, om al onze telefonie via VOIP te laten gaan. Ook dit zal zeker handig zijn. Ik vraag me alleen af als je met keuze menu's zou willen werken, kan je volgens mij de keuzes ook nog door laten geven op je display. Ik neem aan dat je die hier ook nog gewoon achter of voor de naam kan plakken?

- Dennie

Bedankt voor de scripts! Werkt perfect!

Bedankt voor de post. Ik werk zelf met Asterisk@Home (versie 2.8), als ik in de extensions.conf op zoek ga naar [from-external] dan kom ik die niet tegen, ook niet in extensions_additional.conf en extensions_custom.conf. Heeft iemand toevallig hier ervaring mee? Voordat ik (en anderen?!?) het wiel moeten gaan uitvinden? (Ik ben een asterisk-beginner...)

Ik wil namelijk graag proberen de cd-foongids te gaan koppelen...

De extensie [from-external] heb ik zelf bedacht. Ik weet niet hoe in asterisk@home de extensie heet die de (externe) oproepen afhandelt. Dat vind je weer terug in je sip.conf, alwaar je bij de gegevens van je SIP-provider een regeltje 'context=......' vindt. In plaats van die puntjes staat er dan de betreffende context.

Ok, bedankt! Ik denk dat ik het wel gevonden heb. Alleen het wil nog niet echt vlotten, zal hier of daar iets niet helemaal goed doen. Via "asterisk -r" verschijnt het volgende in de laatste regels bij een binnenkomend gesprek:

== Manager 'admin' logged off from 127.0.0.1
dialparties.agi: Extension 103 is available...skipping checks
-- dialparties.agi: DbSet CALLTRACE/103 to telefoonnummer
-- AGI Script dialparties.agi completed, returning 0
-- Executing AGI("SIP/einsteyn-ba48", "callerid.php") in new stack
-- Launched AGI Script /var/lib/asterisk/agi-bin/callerid.php
-- AGI Script callerid.php completed, returning 0
-- Executing Dial("SIP/einsteyn-ba48", "SIP/103|15|tr") in new stack
-- Called 103
-- SIP/103-cb72 is ringing

Hier is te zien dat het script start, voordat deze gaat de "dial" handeling uitvoerd, echter vervolgens zonder resultaat, terwijl de juiste nummers in callerid.php staan.

Toch bedankt voor het op weg helpen!

Same here

Mooi script! Dit is natuurlijk ook te koppelen aan je klanten database, waardoor je meteen ziet welke klant belt (en alle info bij elkaar te zoeken is). Je zou bijvoorbeeld een ID op het scherm van je foon kunnen toveren en dit op een simpele pagina op je intraweb in kunnen kloppen. Hierna krijg je een kort en bondig overzicht van de klant.

Nog mooier is natuurlijk je eigen voip applicatie ontwikkelen waarmee je dit alles automatisch te zien krijgt. Of er zou een telefoon/app moeten bestaan met een groot genoeg scherm om veel info te tonen.

Zodra we aan het opzetten van een geheel nieuwe Asterisk server toe komen, zal dit zeker een onderdeel ervan worden.

Jochem

Nu werkt het bij mij ook wel! Het probleem zat hem bij mij in het feit dat het niet 777 ge-chmod was.

Oorspronkelijk geplaatst door XBL

Nog mooier is natuurlijk je eigen voip applicatie ontwikkelen waarmee je dit alles automatisch te zien krijgt. Of er zou een telefoon/app moeten bestaan met een groot genoeg scherm om veel info te tonen.

Als je een softphone zoekt moet je eens kijken naar idefiskBiz van www.asteriskguru.com die ondersteund URL's. Komt erop neer dat je * een URL naar de applicatie stuurt die automatisch in je browser geopend wordt terwijl de telefoon overgaat.

Dit wil niet echt werken onder windows met asteriskwin32,
Iemand een idee hoe ik asterisk win32 aan een database koppel?
Ik wil zeg maar als iemand een call bevestigd, dat dat dan in een database ofzo komt te staan, die ik dan weer met php kan uitlezen

Ik ben bezig om dit script werkend te krijgen onder trixbox
Het lukt niet om dit werkend te krijgen

is er iemand die dit werkend heeft onder trixbox ?

alvast bedankt Ad