IPSymconSipgate

Dokumentation

Inhaltsverzeichnis

1. Funktionsumfang
2. Voraussetzungen
3. Installation
4. Funktionsreferenz
5. Konfiguration
6. Anhang
7. Versions-Historie

1. Funktionsumfang

Dieses Modul benutzt die Sipgate-API V2 und stellt Funktionen für die folgende Punkte zur Verfügung:

• Kontostand
• Anrufhistorie abrufen
• SMS verschicken
  Hierzu muss im sipgate die Funktion SMS versenden aktivert werden. Die Funktion an sich ist (zur Zeit) kostenlos, es wird pro SMS bezahlt.
  Besonderheit: wird die SMS an ein Festnetzanschluss geschickt, ruft Sipgate diese Nummer an und liest den Text vor.
• Status der Umleitung abrufen und einstellen

2. Voraussetzungen

• IP-Symcon ab Version 6.0
• Sipgate Basic-Account, ggfs Freischaltung bestimmter Funktionen

3. Installation

a. Laden des Moduls

Die Webconsole von IP-Symcon mit http://<IP-Symcon IP>:3777/console/ öffnen.

Den Modulstore öffnen und im Suchfeld nun Sipgate-Client eingeben, das Modul auswählen und auf Installieren auswählen. Alternativ kann das Modul auch über ModulControl (im Objektbaum innerhalb Kern Instanzen die Instanz Modules) installiert werden, als URL muss https://github.com/demel42/IPSymconSipgate angegeben werden.

b. Einrichtung in IPS

In IP-Symcon nun unterhalb des Wurzelverzeichnisses die Funktion Instanz hinzufügen auswählen, als Gerät Sipgate Basic auswählen.

In dem Konfigurationsdialog siehe **Anmeldung bei Sipgate""

4. Funktionsreferenz

zentrale Funktion

boolean Sipgate_InitiateCall(integer $InstanzID, string Telno)
Leitet einen Anruf an die angegebene Nummer ein.

boolean Sipgate_SendSMS(integer $InstanzID, string Telno, string Message)
Sendet eine SMS an die angegebene Nummer. Die Länge der SMS wird ggfs auf 160 Zeichen verkürzt. Der Rückgabewert ist true, wenn die SMS an Sipgate abgesendet werden konnte, eine Information, ob die SMS den Empfänger erreicht hat, gibt es (leider) nicht.

string Sipgate_GetHistory(integer $InstanzID)
liefert einen String mit einer kodierte JSON-Struktur zurück mit den Daten der Anruf-Historie.
Beispiel siehe Funktion TestHistory() in modul.php.

string Sipgate_GetCallList(integer $InstanzID)
liefert einen String mit einer kodierte JSON-Struktur zurück mit der Gesprächsliste.
Beispiel siehe Funktion ShowCallList() in modul.php.

string Sipgate_GetForwardings(integer $InstanzID, string $deviceId)
liefert einen String mit einer kodierte JSON-Struktur mit den aktuellen Umleitungen des angegebenen Telefons.
Beispiel siehe Funktion ShowForwardings() in modul.php.

boolean Sipgate_SetForwarding(string $destination, int $timeout, bool $active, string $deviceId)
setzt/löscht die Umleitung des angegebenen Telefons. Beispiel siehe Funktion TestForwarding() in modul.php.

5. Konfiguration:

Variablen

Eigenschaft	Typ	Standardwert	Beschreibung
Aktualisiere Daten ...	integer	24	Aktualisierungsintervall, Angabe in Stunden

Schaltflächen

Bezeichnung	Beschreibung
Aktualisieren Daten	führt eine sofortige Aktualisierung durch
Zugangsdaten überprüfen	Testet die Zugangsdaten und gibt Accout-Details aus

Variablenprofile

Es werden folgende Variablenprofile angelegt:

• Integer
  Sipgate.Currency

6. Anhang

GUIDs

• Modul: {A110B4EA-FE52-4351-8922-B2B751179BAD}
• Instanzen:
  • Sipgate: {D8C71279-8E04-4466-8996-04B6B6CF2B1D}

API-Dokumentation: https://api.sipgate.com/v2/doc bzw. https://developer.sipgate.io/rest-api/api-reference/

7. Versions-Historie

• 2.10 @ 18.01.2025 09:17

  • Neu: Anruf einleiten via InitiateCall() (Dank an @thomas für die Implementierung)

• 2.9 @ 02.01.2025 14:28

  • interne Änderung
  • update submodule CommonStubs

• 2.8 @ 29.01.2024 10:46

  • Änderung: Medien-Objekte haben zur eindeutigen Identifizierung jetzt ebenfalls ein Ident
  • Neu: Schalter, um Daten zu API-Aufrufen zu sammeln Die API-Aufruf-Daten stehen nun in einem Medienobjekt zur Verfügung
  • update submodule CommonStubs

• 2.7 @ 03.11.2023 11:06

  • Neu: Ermittlung von Speicherbedarf und Laufzeit (aktuell und für 31 Tage) und Anzeige im Panel "Information"
  • update submodule CommonStubs

• 2.6 @ 04.07.2023 14:44

  • Vorbereitung auf IPS 7 / PHP 8.2
  • update submodule CommonStubs
    • Absicherung bei Zugriff auf Objekte und Inhalte

• 2.5.1 @ 07.10.2022 13:59

  • update submodule CommonStubs Fix: Update-Prüfung wieder funktionsfähig

• 2.5 @ 05.07.2022 15:47

  • Verbesserung: IPS-Status wird nur noch gesetzt, wenn er sich ändert
  • update submodule CommonStubs Fix: RegisterOAuth()

• 2.4.1 @ 22.06.2022 10:33

  • Fix: Angabe der Kompatibilität auf 6.2 korrigiert

• 2.4 @ 29.05.2022 15:31

  • update submodule CommonStubs Fix: Ausgabe des nächsten Timer-Zeitpunkts
  • einige Funktionen (GetFormElements, GetFormActions) waren fehlerhafterweise "protected" und nicht "private"
  • interne Funktionen sind nun entweder private oder nur noch via IPS_RequestAction() erreichbar

• 2.3.4 @ 17.05.2022 15:38

  • update submodule CommonStubs Fix: Absicherung gegen fehlende Objekte

• 2.3.3 @ 10.05.2022 15:06

  • update submodule CommonStubs

• 2.3.2 @ 29.04.2022 12:31

  • Überlagerung von Translate und Aufteilung von locale.json in 3 translation.json (Modul, libs und CommonStubs)

• 2.3.1 @ 26.04.2022 12:20

  • Korrektur: self::$IS_DEACTIVATED wieder IS_INACTIVE
  • IPS-Version ist nun minimal 6.0

• 2.3 @ 25.04.2022 15:36

  • Übersetzung vervollständigt
  • Implememtierung einer Update-Logik
  • diverse interne Änderungen

• 2.2.1 @ 13.04.2022 15:31

  • potentieller Namenskonflikt behoben (trait CommonStubs)
  • Aktualisierung von submodule CommonStubs

• 2.2 @ 25.03.2022 18:31

  • automatische Abfrage des Kontostands aktviert
  • libs/common.php -> submodule CommonStubs
  • Anzeige der Referenzen der Instanz

• 2.1 @ 10.02.2022 17:45

  • Aktion "SMS senden" hinzugefügt

• 2.0 @ 01.02.2022 10:58

  • Umstellung auf Anmeldung per OAuth

• 1.5 @ 18.12.2020 14:57

  • PHP_CS_FIXER_IGNORE_ENV=1 in github/workflows/style.yml eingefügt
  • LICENSE.md hinzugefügt

• 1.4 @ 30.12.2019 10:56

  • Anpassungen an IPS 5.3
    • Formular-Elemente: 'label' in 'caption' geändert

• 1.3 @ 10.10.2019 17:27

  • Anpassungen an IPS 5.2
    • IPS_SetVariableProfileValues(), IPS_SetVariableProfileDigits() nur bei INTEGER, FLOAT
    • Dokumentation-URL in module.json
  • Umstellung auf strict_types=1
  • Umstellung von StyleCI auf php-cs-fixer

• 1.2 @ 28.04.2019 14:24

  • Dokumentation überarbeitet

• 1.1 @ 29.03.2019 16:19

  • SetValue() abgesichert

• 1.0 @ 20.03.2019 14:56

  • Anpassungen IPS 5, Abspaltung von Branch ips_4.4