Asterisk VoIP

Asterisk VoIP Adapter

Aktueller Release
2.0.3
Entwickler
Thorsten Stueben
Lizenz
MIT

Deutsches Handbuch / Deutsche Anleitung

Der Asterisk-Adapter wandelt Textnachrichten in Audiodateien um und ruft dann über Asterisk per VoIP eine beliebige Telefonnummer an, um die Audionachricht abzuspielen.

Installation / Konfigurationen

Asterisk muss für ausgehende Anrufe eine Verbindung zu Ihrem VoIP-Anbieter wie Telekom oder Vodfone oder zu Ihrer Fritz!Box herstellen! Bitte folgen Sie einer dieser Installationsanleitungen.

Linux-Pakete / ioBroker & Asterisk laufen auf demselben Server wie ffmpeg

sudo apt-get install ffmpeg
# if asterisk package is missing, follow the instructions "Install asterisk manual"
sudo apt-get install asterisk

Linux-Pakete / ioBroker & Asterisk laufen auf demselben Server wie SOX

Falls Sie Probleme beim Transkodieren mit ffmpeg haben, können Sie sox als Transcoder verwenden. Dazu müssen Sie die folgenden Pakete installieren und sox in der Adapterkonfiguration auswählen.

sudo apt-get install lame
sudo apt-get install sox
sudo apt-get install libsox-fmt-mp3
# if asterisk package is missing, follow the instructions "Install asterisk manual"
sudo apt-get install asterisk

Linux-Pakete / ioBroker & Asterisk laufen auf unterschiedlichen Servern mit ffmpeg

# ioBroker server
sudo apt-get install ffmpeg
sudo apt install openssh-client

# asterisk server
# if asterisk package is missing, follow the instructions "Install asterisk manual"
sudo apt-get install asterisk
sudo apt-get install openssh-server

Linux-Pakete / ioBroker & Asterisk laufen auf einem anderen Server mit sox

Falls Sie Probleme beim Transkodieren mit ffmpeg haben, können Sie sox als Transcoder verwenden. Dazu müssen Sie die folgenden Pakete installieren und sox in der Adapterkonfiguration auswählen.

sudo apt-get install lame
sudo apt-get install sox
sudo apt-get install libsox-fmt-mp3

# asterisk server
# if asterisk package is missing, follow the instructions "Install asterisk manual"
sudo apt-get install asterisk
sudo apt-get install openssh-server

Asterix-Installationsanleitung

Falls das apt-Paket Asterisk fehlt, können Sie Asterisk manuell installieren:

sudo apt install git vim curl wget libnewt-dev libssl-dev libncurses5-dev subversion libsqlite3-dev build-essential libjansson-dev libxml2-dev uuid-dev

cd /usr/src/
sudo wget https://downloads.asterisk.org/pub/telephony/asterisk/old-releases/asterisk-16.30.1.tar.gz
sudo tar xvf asterisk-16*.tar.gz
cd asterisk-16*/
sudo contrib/scripts/get_mp3_source.sh
sudo contrib/scripts/install_prereq install
sudo ./configure
sudo make menuselect

# Choose following packages in the menu:
## Add-ons: chan_ooh323 & format_mp3
## Core Sound Packages: Audio packets CORE-SOUNDS-EN-*
## Music On Hold: MOH-OPSOUND-WAV bis MOH-G729
## Extra Sound: EXTRA-SOUNDS-EN-WAV bis EXTRA-SOUNDS-EN-G729
## Applications: app_macro
## Exit with "Save&Exit".

sudo make
sudo make install
sudo make progdocs # (optional documentation)
sudo make samples
sudo make config
sudo ldconfig

sudo groupadd asterisk
sudo useradd -r -d /var/lib/asterisk -g asterisk asterisk
sudo usermod -aG audio,dialout asterisk
sudo chown -R asterisk:asterisk /etc/asterisk
sudo chown -R asterisk:asterisk /var/{lib,log,spool}/asterisk
sudo chown -R asterisk:asterisk /usr/lib/asterisk

# asterisk as default user for asterisk
sudo nano /etc/default/asterisk
AST_USER="asterisk"
AST_GROUP="asterisk"

# Insert/ replae follwoing in the config file /etc/asterisk/asterisk.conf
sudo nano /etc/asterisk/asterisk.conf
runuser = asterisk ; The user to run as.
rungroup = asterisk ; The group to run as

sudo ufw allow proto tcp from any to any port 5060,5061 # (optional open Firewall, if activ)

sudo systemctl restart asterisk
sudo systemctl enable asterisk

# Check state of asterisk
sudo systemctl status asterisk
sudo asterisk -rvv

Konfiguration von Asterisk

Die folgenden Dokumente beschreiben detailliert, wie Asterisk konfiguriert wird.

Konfiguration über SSH

Wenn ioBroker und Asterisk auf unterschiedlichen Benutzerkonten installiert sind, benötigen Sie auf dem Asterisk-Server einen Benutzer mit SSH-Zugriff vom ioBroker-Server. Dieser Benutzer muss über Unix-Benutzerrechte verfügen, um Dateien zu schreiben, die von Asterisk gelesen werden können. Erstellen Sie auf dem Asterisk-Server das Verzeichnis „Pfad für temporäre Audiodateien“ mit dem Namen, den Sie in der ioBroker-Asterisk-Adapterkonfiguration festgelegt haben. Dieser Pfad muss für Asterisk und SSH zugänglich und autorisiert sein, da ioBroker die generierte Audiodatei (Ihre Textnachricht) per SCP an den Asterisk-Server sendet und im Verzeichnis „Pfad für temporäre Audiodateien“ speichert. Anschließend sendet ioBroker über die AMI-API eine Nachricht an Asterisk, um die im angegebenen Pfad gespeicherte Audiodatei abzuspielen.

ssh

Verwendung von Asterisk

Verwendung von Asterisk mit Objekten/Zuständen für ausgehende Anrufe

Die einfachste Möglichkeit, Asterisk zu verwenden, ist über die ioBroker-Objektseite. Dort geben Sie unter dem Parameter „dialout“ die folgenden Werte ein:

  • Anruf: Drücken Sie die Taste, um einen Anruf zu initiieren.
  • Anrufer-ID: Telefonnummer, die dem Angerufenen angezeigt wird
  • DTMF: Der Angerufene drückte Ziffern auf dem Tastenfeld
  • telnr: die zu wählende Nummer
  • Text: Der Text, der dem Angerufenen vorgespielt wird
  • Sprache: Der Text wird in dieser Sprache in Audio umgewandelt.

iobroker_dialout

Verwendung von Asterisk mit Objekten/Zuständen für die Einwahl

Wenn Sie Ihren SIP-Anbieter (z. B. Fritzbox, Sipgate usw.) und die Asterisk-Konfiguration so eingerichtet haben, dass Einwahlgespräche möglich sind, können Sie den folgenden Parameter festlegen.

  • Anrufer-ID: Telefonnummer, die angerufen hat (Sternchen)
  • DTMF: Anrufer drückten Zahlen auf dem Tastenfeld
  • Text: Der Text, der dem Anrufer vorgespielt wird.
  • Sprache: Der Text wird in dieser Sprache in Audio umgewandelt.

iobroker_dialin

Verwendung von Asterisk mit JavaScript oder Blocky zum Wählen von externen Standorten

Jetzt können Sie den Adapter in Ihren Javascript- oder Blocky-Programmen verwenden.

const number   = '040 666-7766';
const callerid = '040 123 999'; // optional, if not set anonymous call
const msg      = 'Hello, this textmessage will be converted to audio';

// call telephone nummber 040 666-7766 and play text message as audio
sendTo('asterisk.0', 'dial', { telnr: number, callerid: callerid, text:  msg},  (res) => {
      console.log(`Result: ${JSON.stringify(res)}`);
});

// call telephone nummber 040 666-7766 and play mp3 audio file
// mp3 file has to exist on asterix server
sendTo('asterisk.0', 'dial', { telnr: number, callerid: callerid, audiofile: '/tmp/audio.mp3'},  (res) => {
      console.log(`Result: ${JSON.stringify(res)}`);
});

// call telephone nummber 040 666-7766 and play gsm audio file
// gsm file has to exist on asterix server
sendTo('asterisk.0', 'dial', { telnr: number, callerid: callerid, audiofile: '/tmp/audio.gsm'},  (res) => {
      console.log(`Result: ${JSON.stringify(res)}`);
});

// create dial in message
sendTo('asterisk.0', 'dial', { text:  'Please enter PIN after hashtag.' },  (res) => {
      console.log(`Result: ${JSON.stringify(res)}`);
});

// Show entered DTMF code
on({ id: 'asterisk.0.dialin.dtmf'/*DTMF Code*/ },  (obj) => {
    const dtmf = obj.state.val;
    console.log(`DTMF: ${dtmf}`);
});

// Show entered DTMF code
on({ id: 'asterisk.0.dialout.dtmf'/*DTMF Code*/ },  (obj) => {
    const dtmf = obj.state.val;
    console.log(`DTMF: ${dtmf}`);
});

Sie können den folgenden Parameter in der sendTo-Anweisung verwenden:

  • Sprache: Die für die Text-zu-Sprache-Funktion (TTS) vorgesehene Sprache. (Zulässige Werte: 'DE', 'EN', ... Standardmäßig wird die Systemsprache von ioBroker verwendet.)
  • Wiederholung: Wie oft soll die Audionachricht wiederholt werden? (Zulässige Werte: 1 bis n, Standardwert: 5)
  • Priorität: Wenn Sie mehrere sendTo-Anweisungen parallel senden, werden die Nachrichten mit der niedrigsten Priorität zuerst gesendet (zulässige Werte 1 bis n, Standardwert 1).
  • Text: Textnachricht, die als Audio gesendet wird
  • timeout: Wartezeit in Millisekunden für den Verbindungsaufbau (Standardwert: 60000 ms)
  • async: Ermöglicht das Generieren mehrerer Aufrufe, ohne auf eine Antwort zu warten (zulässige Werte: false/true, Standardwert: false)
  • Audiodatei: Wenn Sie den Parameter „Text“ verwenden, wird der in Audio umgewandelte Text in einer Audiodatei gespeichert. Falls die Audiodatei bereits existiert, wird sie überschrieben. Wenn Sie den Parameter „Text“ nicht verwenden, wird die Audiodatei abgespielt.
  • Anrufer-ID: Definiert die Kennung (Ihre Absender-Telefonnummer). Fehlt die Anrufer-ID, wird die weitergeleitete Telefonnummer anonym übermittelt.
  • telnr: Telefonnummer zum Wählen.

Problemlösung

Bei Problemen mit Asterisk können Sie in den Logdateien unter `/var/log/asterisk` nach Hinweisen suchen. Nach dem Start von Asterisk können Sie es zur Fehlersuche in der Kommandozeile mit `asterisk -rvvvvvv` aufrufen. Anschließend können Sie mit `iobroker` einen Aufruf initialisieren und das Ergebnis beobachten.

Changelog

2.0.3 (2025-03-30)

  • (Stübi) Bugfixing in sendto function
  • (Stübi) Add Object repeat
  • (Stübi) Fixing @iobroker/adapter-dev 1.0.1 specified. 1.3.0 is required as minimum, 1.3.0 is recommended (Issue #57)
  • (Stübi) Fixing dependency (Issue #58)
  • (Stübi) Fixing issue with missing template directory (Issue #56 and #65)

2.0.2 (2025-02-01)

  • (Stübi) Add Create Directory
  • (Stübi) Add translation for configuration
  • (Stübi) Bugfixing

2.0.1 (2025-01-24)

  • (Stübi) Fix error by using asterisk and iobroker on the same server
  • (Stübi) Add action command for send messages
  • (Stübi) Add dial in command for send messages
  • (Stübi) Add create butteon for create dial in file

2.0.0 (2025-01-24)

  • (Stübi) Redesign of Asterisk
  • (Stübi) Switching from Javascript to Typescript
  • (Stübi) Nodes 20 and 22 are now supported
  • (Stübi) js controllers in versions 6 and 7 are supported
  • (Stübi) Attention: Passwords must be re-entered from this version!
  • (Stübi) Language object added
  • (Stübi) Revision of the reconnect if Asterisk is restarted once
  • (Stübi) Fixing errors from repository checker (Issue #51)
  • (Stübi) Add documentation how to install asterisk manual (Issue #33)

1.0.6 ((2019-02-27)

  • (Stübi) Update documentation and templates
  • (Stübi) Asterisk adapter can create now asterisk configuration files. You have to rename and move them afterwards to the /etc/asterisk directory
  • (Stübi) a new documentation for using Sipgate as provide.
  • (Stübi) Now you can call internal fritzbox numbers. You must change your extensions.ael if you install the version 1.0.4! (replace 10 => { ... } with _. => { ... })
  • (Stübi) You can install asterisk on a different server and use scp to transfer audio files from ioBroker to asterisk.
  • (Stübi) You can use the service PJSIP instead of SIP now.
  • (Stübi) Support js-controller compact mode
  • (Stübi) Calling without extension, if you do not use the fritzbox for example (leave sip.conf username in adapter config empty)
  • (Stübi) Instead of ffmpeg you can use now sox too
  • (Stübi) Update with languages
  • (Stübi) Add Callerid to dialin states
  • (Stübi) A lot of new features. Now you can call ioBroker / Asterisk by telephone number and enter a DTMF Code.
  • (Stübi) You can enter a DTMF Code if you get called by ioBroker / Asterisk
  • (Stübi) Bugfixing and password will be saved encrypted and text message size can be unlimited
  • (Stübi) First Version

License

The MIT License (MIT)

Copyright (c) 2025 Thorsten Stueben thorsten@stueben.de / https://github.com/schmupu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.