DrICTVoip.dll v 2.1 Informatie en handleiding Nieuw in deze versie : Koppeling voor web gebaseerde toepassingen (DrICTVoIPwebClient.exe) (zie hoofdstuk 8)
1. Inleiding Met de DrICTVoIP.DLL maakt u uw software geschikt voor integratie met Broadsoft (o.a. RoutIT) , KPN ÉÉN en Asterisk (test fase). Met deze integratie ontstaat er een samenwerking tussen uw software en een telefoon. In volgende versies zal het aanbod van ondersteunde VoIP centrales verder uitgebreid worden zodat er een flexibele en universele integratie ontstaat. De DrICTVoIP.DLL vertaald de commando’s van de interface van de desbetreffende VoIP centrale naar functies welke simpel, snel en doeltreffend toepasbaar zijn binnen uw software. De twee hoofdfuncties bestaan uit het starten van uitgaande gesprekken via uw software en het gebruik van het nummer van het actieve gesprek. Laatst genoemde functie geeft veel mogelijkheden omdat een inkomend telefoonnummer de sleutel is naar informatie over relaties en andere gegevens. Door gebruik te maken van een inkomend telefoonnummer kan bijvoorbeeld snel een klant gevonden worden en vervolgens een dossier of order. Met deze integratie ervaren klanten en relaties een persoonlijke benadering en worden telefoongesprekken efficiënter afgehandeld. De DrICTVoip.DLL kan rechtstreeks worden aangeroepen vanuit een .NET applicatie of met behulp van de COM interface. Met de COM interface is de toepassing van de DLL in veel programmeertalen mogelijk. Ook oudere programmeer talen zoals Visual Basis 6 of Delphi kunnen hierdoor samenwerken met onze DLL. DrICTVoIP.DLL is ook geschikt voor web gebaseerde applicaties door gebruikt te maken van de DrICTVoIP Web Client. Voor het gebruik van de DLL dient de .NET 4 runtime geïnstalleerd te zijn op de betreffende computer. Voor het gebruik van de COM interface dient de DLL binnen Windows geregistreerd te zijn. Hiervoor is het noodzakelijk om de installatie van het bestand DrICTVoIPDLL.msi uit te voeren met de gebruiker Administrator of een gebruiker met gelijke beheerders rechten. Het registeren kan ook achteraf uitgevoerd worden door gebruik te maken van de snelkoppeling “Register DrICTVoip.dll” Deze snelkoppeling kunt u vinden in het startmenu onder de map “De Ruiter ICT advies B.V.” Gebruikt u de DLL vanuit een .NET applicatie dan is het niet noodzakelijk dat deze geregistreerd is. Het is dan voldoende om de DLL als referentie toe te voegen binnen u applicatie.
2. Licentie en verbinding Voor de licentie gegevens en de verbinding naar de VoIP omgeving is het van belang dat het bestand “DrICTVoIP.KEY” aanwezig is. Standaard moet dit bestand in dezelfde map aanwezig zijn als het dll bestand. Het is mogelijk om deze locatie aan te passen of de licentie vanuit het Windows register te gebruiken. In de standaard installatie is een demo licentie aanwezig die onbeperkt geldig is. Voor een productie omgeving zal het bestand “DrICTVoip.KEY” vervangen moeten worden. Met het gebruik van de demo licentie is het mogelijk om een inkomend en een uitgaand gesprek te simuleren.
3. PhoneID Voor de meeste functies is het noodzakelijk een PhoneID te gebruiken. Bij Broadsoft en KPN ÉÉN is dit het userid van het toestelaccount en bij Asterisk de extensie naam. (zonder SIP/)
4. Een gesprek starten en het nummer gebruiken De DLL is doormiddel van een functie of COM interface te gebruiken. In onderstaande voorbeelden ziet u hoe de twee basis functies gebruikt kunnen worden van uit .NET. Een gesprek starten naar 0643587025 met telefoon toestel1 : DrICTvoip.ManagedClass.Main.voipcommand("dial","toestel1",”0643587025”) (return : ok ) Het ophalen van het telefoonnummer van het actieve gesprek op toestel1 : DrICTvoip.ManagedClass.Main.voipcommand("getactivecall,"toestel1,NULL) (return : 0643587025,1) Bij het ophalen van een actief gesprek wordt er achter het telefoonnummer ,1 of , 0 teruggeven. Op deze wijze is te achterhalen of het een uitgaand of een inkomend gesprek betreft. Hiermee kunt u dit verschil weergeven in uw software door bijvoorbeeld de string te splitsen.
5. Het gebruik van de COM interface De COM interface kan gebruikt worden nadat de DLL is geregistreerd binnen Windows. Tijdens de installatie heeft dit plaats gevonden of later via de snelkoppeling. Tevens kunt u in de programma het bestand “RegDrICTVoIP.exe” vinden. In onderstaand voorbeeld wordt er gebruik gemaakt van Visual Basic 6.0 Dim ictvoip AS DrICTVoIP.voipcommand Set ictvoip = New DrICTVoip.ManagedClass Call ictvoip.Add(("dial","toestel1",”0643587025”)
6. DrictVoIP test In het startmenu vind u een snelkoppeling naar de DrICTVoipTest applicatie (DrICTVoIPtest.exe) Met deze applicatie is het onder andere mogelijk om de beschikbare commando’s te bekijken en te testen. Voor sommige functies en opties is het noodzakelijk om deze applicatie uit te voeren als Administrator.
De volgende commando’s zijn beschikbaar : Dial : Met dit commando kan een gesprek gestart worden Getactivecall : Geeft het telefoon nummer weer van het actieve gesprek op het desbetreffende toestel (PhoneID) getdllrunpath : Geeft de map weer van waaruit de DLL aangeroepen wordt. check connection* : Met dit commando kan de verbinding met de VoIP centrale gecontroleerd worden. Om dit commando te gebruiken is een geldig PhoneID nodig. check connectionsettings : Dit commando geeft het serveradres en de gebruikersnaam terug welke gebruikt wordt om verbinding te maken naar de VoIP centrale. check mode : Met dit commando kan gecontroleerd worden welke modus er gebruik wordt voor het key bestand. (zie key mode) check companyname: Geeft de bedrijfsnaam terug waarop de licentie is geregistreerd. check licensevalidtill : Geeft de vervaldatum van de licentie terug check licensevalid : Controleert of de licentie geldig is en gebruikt kan worden. set mode : Met dit commando kan de key mode ingesteld worden voor de software. set custompath : Met dit commando kan de map gewijzigd worden waarin dit licentie gevonden kan worden. Blindtransfer* : Met dit commando kan een gesprek doorverbonden worden zonder vooraankondiging. Transfer* : Met dit commando kan een gesprek doorverbonden worden met vooraankondiging. Voor het gebruik van dit commando is het noodzakelijk om twee actieve gesprekken te hebben. Het tweede gesprek kan opgezet worden door nogmaals het commando dial uit te voeren. Hold* : Met dit commando kan het actieve gesprek in de wachtstand gezet worden. Resume* : Met dit commando kan het gesprek uit de wachtstand gehaald worden. Redial* : Met dit commando kan het laatst gekozen nummer gebeld worden. Release : Met dit commando kan het gesprek beëindigt worden.
*nog niet beschikbaar voor Asterisk.
7. Test en diagnose functies en het gebruik zonder actieve VoIP omgeving Het gebruik van Phoneid “test” Met PhoneID “test” kan de DLL gebruik worden met de demo licentie. Een inkomend gesprek kan gesimuleerd worden met een inkomend gesprek op dit PhoneID. Dit kunt u doen door in de DrICTVoIP test applicatie een nummer in te vullen bij “Test phone number”. Vervolgens kan deze opgeslagen worden door op de knop “Set test phone number” te klikken. Hiermee wordt dit het nummer opgeslagen in het register van Windows.
Bij het gebruik van het commando getactivecall zal dit nummer terug komen.
Show outgoing call Door de optie “show outgoing calls” te activeren vanuit de test applicatie kan er gecontroleerd worden welk nummer er wordt doorgegeven aan de VoIP omgeving.
Bij gebruik van het commando dial wordt het volgende scherm getoond voor elk gesprek :
Na het klikken op de knop “ok” zal het commando doorgegeven worden aan de VoIP omgeving.
8. Web gebaseerde applicaties Via DrictVoipWebClient.exe is het mogelijk om vanuit een web applicatie gebruikt te maken van de DrICTVoIP.DLL. DrictVoipWebClient.exe is te gebruiken in combinatie met Internet Explorer , Firefox en Google Chrome. Dit programma is te vinden in de installatie map en is tijdens de installatie geregistreerd binnen Windows De applicatie kan ook handmatig geregistreerd worden doormiddel van DrictVoipWebClient.exe –install. Bij het aanroepen van een drictvoip:\\ link zal deze automatisch gestart worden. Het gebruik van de koppeling Deze koppeling werkt doormiddel van hyperlinks binnen de web applicatie. Een gesprek starten naar 0643587025 met telefoon toestel1 : drictvoip://answer=1#answerurl=http://www.deruiterictadvies.nl/demo/index.php?return=%return%&ph oneid=%phoneid%#browser=1#voipcommand=dial,toestel1,0643587025 Het ophalen van het telefoonnummer van het actieve gesprek op toestel1 : drictvoip://answer=1#answerurl=http://www.deruiterictadvies.nl/demo/index.php?return=%return%&ph oneid=%phoneid%#browser=1#voipcommand=getactivecall,toestel1,null
Uitleg structuur hyperlink answer= : Doormiddel van deze parameter kan er gekozen worden of de client een reactie terug geeft door het aanroepen van een url (answerurl), deze parameter kan 0 of 1 zijn. answerurl= : Deze url zal aangeroepen worden nadat het VoIP commando is uitgevoerd. In deze url kunnen twee variabelen gebruikt worden. Dit zijn %return% (antwoord VoIP command) en %phoneid% browser= : Doormiddel van deze parameter kan er gekozen worden of de answerurl op de achtergrond wordt aangeroepen of doormiddel van de default webbrowser. Als deze paramater 1 is dan zal de webpagina worden aangeroepen en op scherm verschijnen van de gebruiker. voipcommand = : Uitleg en de beschikbare commando’s zijn te vinden op pagina 4 van deze handleiding.
Voorbeeld webpagina met gebruik van PHP
dial 0643587025 getactivecall "; echo "DrICTVOIP phoneid = " .$phoneid; ?>
