Beschreibung Auerswald API

Beschreibung Auerswald API


Die folgenden Kapitel beschreiben die Auerswald API, mit deren Hilfe Informationen aus dem Kommunikationsserver abgerufen und Funktionen geschaltet werden können.

Unterstützte Kommunikationsplattformen:

  • COMpact 4000
  • COMpact 5000
  • COMpact 5000R
  • COMmander 6000
  • COMmander 6000R
  • COMmander 6000RX

Allgemeines / Anmeldung am System

Neue Funktionen mit der API-Version 2

Mit der COMmander 6000-Serie,ab Firmwareversion 5.6A, und COMpact 5000-Serie steht die erweiterte API-Version 2 zur Verfügung. Folgende Funktionen sind mit dieser Version verfügbar:

  • Abruf der Gesprächsdatenliste
  • Definition der Zielrufnummer einer MSN-/DDI-Rufumleitung
    (Ergänzung der vorhandenen Funktion „MSN-Rufumleitung schalten")
  • Änderung der Gruppenlogzustände

Login, Digest Access Authentication (DAA)
Bevor ein Befehl im ITK-System aufgerufen werden kann, ist ein Login zwingend erforderlich. Einzige Ausnahme stellt das Abfragen der Systeminformationen dar.

Eine Autorisierung an der COMmander-6000-Serie und COMpact 5000-Serie erfolgt über Digest Access Authentication (DAA) nach RFC 2617. Dabei läuft die Session-Wiedererkennung abseits der normal üblichen Digest-Implementierung. Sie erfolgt mittels eines Cookies AUERSessionID (15 Zeichen langer Wert) vom Webserver des ITK-Systems, im ersten erfolgreichen Login. Wird dieses Cookie von der Anwendung nicht übertragen, so fordert der Konfigurationsserver bei jedem Aufruf eine erneute Autorisierung mittels Digest Access Authentication. Hierbei ist zu beachten, dass dann eine weitere Session angelegt wird. Aktuell unterstützt die COMmander-6000-Serie und die COMpact 5000-Serie maximal 100 Sessions. Bei einer Überschreitung dieses Wertes werden die ältesten Teilnehmer-Sessions im Webserver des ITK-Systems gelöscht.

Aufruf
Der Aufruf der folgenden Befehle erfolgt ausschließlich per https. Die einzelnen Befehle werden an die URL angefügt, z. B. https://192.168.0.240/app_.

Antworten
Alle Antworten vom System erfolgen mit dem content-type application/json (charset=utf-8). Die einzelnen Datensätze eines Typs, z. B. zwei aufeinander folgende Anrufer in der Anruferliste, werden durch ein Komma getrennt.
Ab Version 2 der API wird im http-Header der Versionsstand der API mit „X-AppVersion2“ ausgegeben.

Inhaltsverzeichnis

Systeminformationen abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_about keine keine

Beispiel-Aufruf:
https://192.168.0.240/app_about

Antworttyp Mögliche Inhalte
pbx Namen des Anlagentyps, z. B. COMmander 6000, passend zum pbxType.
pbxType 0   undefiniert
10  COMmander 6000
11  COMmander 6000R/6000RX
12  COMpact 5000
13  COMpact 5000R
20  COMpact 4000
version Firmwareversion des Kommunikationsservers.
serial Seriennummer des Kommunikationsservers (26-stellig).
date Datum im Kommunikationsserver.
macaddr MAC-Adresse des Kommunikationsservers (Ethernetinterface des Grundboards)
svn Revisionsnummer der Firmware im SVN.
donglesn

Seriennummer des Anlagen-Dongles (12-stellig).

Bemerkung:
Wenn die Seriennummer nicht ausgelesen werden kann, wird "donglesn":"---" ausgegeben.

Beispiel-Antwort:

{
    "pbx": "COMmander 6000",
    "pbxType": 10,
    "version": "Version 5.0A - Build 001 ",
    "serial": "0000000001AU0110710900434C",
    "date": "01.05.2011",
    "macaddr": "00:09:52:00:01:45",
    "svn": "00000 ",
    "donglesn": "---"
}

 

Inhaltsverzeichnis

Anruferliste abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_call_list Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_call_list

Bemerkung:

  • Bei Anmeldung als Admin liefert der Kommunikationsserver ein leeres Array, angezeigt als [].
Antworttyp Mögliche Inhalte
id

Eindeutige Nummer des Anruferlisteneintrages.

Bemerkung:
Die IDs müssen nicht fortlaufend sein, da sie aus der zentralen Gesprächsdatenerfassung stammen und dort auch abgehende Verbindungen gespeichert werden.

extName Name des Anrufers, wenn Rufnummer bzw. Name bekannt. Der Name kann aus dem zentralen Telefonbuch, von der Online-Namenssuche oder aus dem Netz (Displaymeldung aus Richtung Netzbetreiber) kommen.
extRufNr Rufnummer des Anrufers, wenn bekannt.
datum Datum des Anrufs.
startZeit Uhrzeit des Anrufs.
msn Eigene angerufene Rufnummer des Kommunikationsservers.

Beispiel-Antwort (2 Anrufe in Abwesenheit):

[
    {
        "id": 8,
        "extName": "Auerswald",
        "extRufNr": "05306920099",
        "datum": "01.05.11",
        "startZeit": "12:44:59",
        "msn": "4711"
    },
    {
        "id": 7,
        "extName": "Auerswald",
        "extRufNr": "0530692000",
        "datum": "02.02.11",
        "startZeit": "12:10:29",
        "msn": "4711"
    }
]

Inhaltsverzeichnis

Gesprächsdatenliste abrufen (ab Version 2)


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_gespr_list Benutzer
Sub-Admin

Ohne Angabe von Parametern,
alle Datensätze werden ausgegeben

offset
Ausgabe der Gesprächsdaten ab Datensatz X.

limit
Anzahl der auszugebenden Datensätze.

Beispiel-Aufruf – Ausgabe aller Datensätze:
https://192.168.0.240/app_gespr_list

Beispiel-Aufruf – Ausgabe der ersten 10 Datensätze:
https://192.168.0.240/app_gespr_list?limit=10

Beispiel-Aufruf – Ausgabe von aller Datensätze ab Datensatz 100:
https://192.168.0.240/app_gespr_list?offset=100

Beispiel-Aufruf – Ausgabe von 10 Datensätzen ab Datensatz 100:
https://192.168.0.240/app_gespr_list?offset=100&limit=10

Bemerkung:

  • Bei Anmeldung als „Admin“ liefert der Kommunikationsserver ein leeres Array, angezeigt als [].
Antworttyp Mögliche Inhalte
id Eindeutige Nummer des Gesprächsdatenlisteneintrages.
Bemerkung:
Die IDs müssen nicht fortlaufend sein, da sie aus der zentralen Gesprächsdatenerfassung stammen und dort auch abgehende Verbindungen gespeichert werden.
extName Name des Anrufers, wenn Rufnummer bzw. Name bekannt. Der Name kann aus dem zentralen Telefonbuch, von der Online-Namenssuche oder aus dem Netz (Displaymeldung aus Richtung Netzbetreiber) kommen.
extRufNr Rufnummer des Anrufers, wenn bekannt.
datum Datum des Anrufs.
startZeit Uhrzeit des Anrufs.
dauer Dauer des Gesprächs in Sekunden.
msn Eigene angerufene Rufnummer des Kommunikationsservers.

Beispiel-Antwort (2 Gespräche):

[
    {
        "id": 58447,
        "extName": "",
        "extRufNr": "053069219551",
        "datum": "04.02.11",
        "startZeit": "12:44:59",
        "dauer": "48",
        "msn": "970851"
    },
    {
        "id": 58448,
        "extName": "",
        "extRufNr": "053069219551",
        "datum": "02.02.11",
        "startZeit": "12:10:29",
        "dauer": "147",
        "msn": "970851"
    }
]

Inhaltsverzeichnis

Nachrichtenliste (Voice- und Faxmails) abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_vmf_msg_list Benutzer
Sub-Admin

boxType
1 Nur Voice-Nachrichten
2 Nur Fax-Nachrichten
leer Alle Nachrichten

archived
0 NICHT archivierte Nachrichten
1 NUR archivierte Nachrichten
leer Alle Nachrichten

Beispiel-Aufruf – alle Nachrichten abrufen (inkl. Archiv):
https://192.168.0.240/app_vmf_msg_list

Beispiel-Aufruf – alle Voicemails abrufen (inkl. Archiv):
https://192.168.0.240/app_vmf_msg_list?boxType=1

Beispiel-Aufruf – alle Voicemails abrufen (ohne Archiv):
https://192.168.0.240/app_vmf_msg_list?boxType=1&archived=0

Bemerkung:

  • Bei Anmeldung als Admin liefert der Kommunikationsserver die Nachrichten aller Voicemail- bzw. Faxboxen.
Antworttyp Mögliche Inhalte
id Eindeutige Nummer der Nachricht.
boxid Eindeutige Nummer der Voicemail- oder Faxbox.
msgtype Gibt an, ob es eine Voicemail- oder Faxbox ist.
1 Voicemailbox
2 Faxbox
extname Name des Anrufers, wenn Rufnummer bzw. Name bekannt. Der Name kann aus dem zentralen Telefonbuch, von der Online-Namenssuche oder aus dem Netz (Displaymeldung aus Richtung Netzbetreiber) kommen.
extrufnr Rufnummer des Anrufers, wenn bekannt.
intrufnr Interne Rufnummer der Voicemail- bzw. Faxbox.
amtname Name der eigenen angerufenen Rufnummer des Kommunikationsservers.
msgdate Datum der Voicemail bzw. Faxnachricht.
msgtime Uhrzeit der Voicemail bzw. Faxnachricht.
msglengh Voicemail: Dauer der Aufzeichnung (hh:mm:ss).
Fax: Gesamtzahl der Seiten.
msgFaxResult Nur Fax: Versand bzw. Empfang erfolgreich.
0 erfolgreich
> 0 nicht erfolgreich (Angabe des T.30-Statuscodes)
msgFaxJobState Nur Fax: Status des Versands.
0 Initialisierung
1 wartend
2 sendet
3 Senden erfolglos beendet
4 Senden erfolgreich beendet
msgFaxSendPages Nur Fax: Anzahl der tatsächlich versendeten bzw. empfangenen Seiten.
msgarchived Voicemail- bzw. Faxnachricht ist archiviert.
0 Ist NICHT im Archiv
1 Ist im Archiv
msgdatelong Angabe der Sekunden nach dem 01.01.1970 (gut zur Sortierung der Einträge geeignet).
msgisoutgoing Richtungsangabe.
0 Empfangen
1 Versendet
msgdeleted Die Nachricht wurde im System bereits zum Löschen markiert.
0 keine Löschmarkierung
1 zum Löschen markiert (sollte in der Liste ausgeblendet werden)
msgfilelen Größe der Nachricht (WAVE bzw. PDF) in Byte.
isnewmsg Neue und noch nicht abgerufene Nachricht:
0 Alt
1 Neu

Beispiel-Antwort (Voicemail):

[
    {
        "id": 147357617,
        "boxid": 8209,
        "msgtype": 1,
        "extname": "Auerswald",
        "extrufnr": "0530692000",
        "intrufnr": "8750",
        "amtname": "MSN1",
        "msgdate": "04.02.11",
        "msgtime": "12:49:14",
        "msglength": "00:00:11",
        "msgFaxResult": 0,
        "msgFaxJobState": 0,
        "msgFaxSendPages": 0,
        "msgarchived": 0,
        "msgdatelong": 1296820154,
        "msgisoutgoing": 0,
        "msgdeleted": 0,
        "msgfilelen": 368684,
        "isnewmsg": 1
    }
]

Beispiel-Antwort (Fax):

{
    "id": 810336319,
    "boxid": 8210,
    "msgtype": 2,
    "extname": "Auerswald",
    "extrufnr": "0530692000",
    "intrufnr": "9750",
    "amtname": "MSN2",
    "msgdate": "05.01.11",
    "msgtime": "15:36:59",
    "msglength": "2",
    "msgFaxResult": 0,
    "msgFaxJobState": 1,
    "msgFaxSendPages": 2,
    "msgarchived": 0,
    "msgdatelong": 1294238219,
    "msgisoutgoing": 0,
    "msgdeleted": 0,
    "msgfilelen": 557100,
    "isnewmsg": 1
}

Inhaltsverzeichnis

Nachrichtenstatus (Voice- und Faxmails) ändern


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_set_msg_state Benutzer
Sub-Admin

msgId
Angabe der eindeutigen Nachrichten-ID (id).

boxId
Angabe der eindeutigen Box-ID (boxid).

msgStatus
0 Als gelesen markieren
1 Als ungelesen (neu) markieren

Beispiel-Aufruf – Nachricht als gelesen markieren:
https://192.168.0.240/app_set_msg_state?boxId=8209&msgId=147357617&msgStatus=0

Antworttyp Mögliche Inhalte
successful true Statusänderung erfolgreich
false Statusänderung nicht erfolgreich

Beispiel-Antwort:

{"successful":true}

Inhaltsverzeichnis

Nachrichten (Voice- und Faxmails) download


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_get_msg Benutzer
Sub-Admin

msgId
Angabe der eindeutigen Nachrichten-ID (id).

boxId
Angabe der eindeutigen Box-ID (boxid).

Beispiel-Aufruf:
https://192.168.0.240/app_get_msg?boxId=8209&msgId=147357617

Bemerkung:

  • Der Nachrichtenstatus bleibt unverändert.
Antworttyp Mögliche Inhalte
successful false Download nicht erfolgreich

Beispiel-Antwort:

{"successful":false}

Inhaltsverzeichnis

Nachricht (Voice- und Faxmails) löschen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_delete_msg Benutzer
Sub-Admin

msgId
Angabe der eindeutigen Nachrichten-ID (id).

boxId
Angabe der eindeutigen Box-ID (boxid).

Beispiel-Aufruf:
https://192.168.0.240/app_delete_msg?boxId=8209&msgId=810336319

Antworttyp Mögliche Inhalte
successful true Löschen erfolgreich
false Löschen nicht erfolgreich

Beispiel-Antwort:

{"successful":true}

Inhaltsverzeichnis

Weckzeitenliste abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_weckzeiten_list Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_weckzeiten_list

Bemerkung:

  • Bei Anmeldung als Admin liefert der Kommunikationsserver ein leeres Array, angezeigt als [].
Antworttyp Mögliche Inhalte
id Eindeutige Nummer der eingestellten Weckzeit.
zeit Weckzeit, Angabe in hh:mm.
tag Angabe des Tages oder der Tage.
1 Montag
2 Dienstag
4 Mittwoch
8 Donnerstag
16 Freitag
32 Samstag
64 Sonntag
31 Montag bis Freitag
96 Samstag bis Sonntag
127 täglich
aktiv Zeigt an, ob die Weckzeit ein- oder ausgeschaltet ist.
0 aus
1 ein
immer Zeigt an, ob die Weckzeit einmal oder wiederholt ausgeführt wird.
0 einmal
1 wiederkehrend
fwProg Zeigt an, ob die Weckzeit vom Teilnehmertelefon eingestellt wurde.
0 über Weboberfläche bzw. API
1 über Programmierfunktion per Telefon

Beispiel-Antwort:

[
    {
        "id": 5070,
        "zeit": "08:16",
        "tag": 31,
        "aktiv": 1,
        "immer": 1,
        "fwProg": 0
    },
    {
        "id": 5813,
        "zeit": "09:15",
        "tag": 96,
        "aktiv": 1,
        "immer": 1,
        "fwProg": 1
    },
    {
        "id": 3358,
        "zeit": "18:10",
        "tag": 127,
        "aktiv": 1,
        "immer": 1,
        "fwProg": 0
    },
    {
        "id": 5872,
        "zeit": "22:22",
        "tag": 32,
        "aktiv": 1,
        "immer": 1,
        "fwProg": 0
    },
    {
        "id": 7463,
        "zeit": "22:23",
        "tag": 8,
        "aktiv": 0,
        "immer": 1,
        "fwProg": 0
    }
]

Inhaltsverzeichnis

Weckzeit einfügen/ändern/löschen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_weckzeiten_set Benutzer
Sub-Admin

action
0 Anlegen
1 Ändern
2 Löschen

weckId
Angabe der eindeutigen Weckzeit-ID (id).

zeit
Angabe der Weckzeit in hh:mm.

tag
Angabe des Tages oder der Tage.
1 Montag
2 Dienstag
4 Mittwoch
8 Donnerstag
16 Freitag
32 Samstag
64 Sonntag
31 Montag bis Freitag
96 Samstag bis Sonntag
127 täglich

immer
Gibt an, ob einmal oder wiederholt geweckt wird.
leer einmal
immer wiederkehrend

aktiv
Gibt an, ob die Weckzeit ein- oder ausgeschaltet ist.
leer aus
aktiv ein

Beispiel-Aufruf:
https://192.168.0.240/app_weckzeiten_set?action=1&weckId=5070&zeit=08:16&tag=31&immer=immer&aktiv=aktiv

Bemerkung:

  • Der Admin kann keine Weckzeiten anlegen
  • Neue Weckzeiten anlegen: action=0 + zeit + tag
    (immer=immer und aktiv=aktiv je wenn gewünscht)
  • Weckzeiten ändern: action=1 + weckId + zeit + tag
    (immer=immer und aktiv=aktiv je wenn gewünscht)
  • Weckzeiten löschen: action=2 + weckId
Antworttyp Mögliche Inhalte
successful true Änderung, Löschen bzw. Anlegen erfolgreich
false Änderung, Löschen bzw. Anlegen nicht erfolgreich

Beispiel-Antwort:

{"successful":true}

Inhaltsverzeichnis

Telefonbuchliste abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_telefonbuch Benutzer
Sub-Admin
App-Schnittstelle bis Version 2: keine
App-Schnittstelle ab Version 3: catId
Angabe der eindeutigen Kategorie-ID des Telefonbuches oder Übermittlung des Parameters catId=0 zur Anzeige aller Einträge

Beispiel-Aufruf App-Schnittstelle bis Version 2:
https://192.168.0.240/app_telefonbuch

Antworttyp Mögliche Inhalte
id Eindeutige Nummer des Telefonbucheintrags.
kwNr Interne Kurzwahlnummer des Telefonbucheintrags.
zielNummer Die externe Zielrufnummer.
kwName Der Name zur externen Zielrufnummer.
callThrough Zeigt an, ob die Zielrufnummer dieses Eintrages Call Through des TK-Systems nutzen darf, wenn es ankommend die für Call Through definierte eigene Amtrufnummer anruft.
0 aus
1 ein
callThroughSperr Zeigt an, ob für abgehende Call-Through-Verbindungen ein im TK-System definiertes Sperrwerk (gehend) berücksichtigt wird.
0 Sperrwerk wird nicht berücksichtigt
1 Sperrwerk wird berücksichtig

Beispiel-Antwort:

[
    {
        "id": 4601,
        "kwNr": 7095,
        "zielNummer": "045904944012",
        "kwName": "Alice",
        "callThrough": 0,
        "callThroughSperr": 0
    }
]

Ab der App-Schnittstelle Version 3 muss an den Request eine Kategorie-Id angehängt werden. Aufrufe ohne diesen Parameter werden mit einem Hinweis auf ein erforderliches Update der App im bestehenden (alten) Format beantwortet

Beispiel-Aufruf App-Schnittstelle Version 3 ohne den Parameter catId:
https://192.168.0.240/app_telefonbuch

Beispiel-Antwort (im alten Telefonbuchformat):

[
    {
        "id": 0,
        "kwNr": 0,
        "zielNummer": "",
        "kwName": "Bitte updaten",
        "callThrough": 0,
        "callThroughSperr": 0
    }
]

Beispiel-Aufruf App-Schnittstelle Version 3 mit Parameter catId:
https://192.168.0.240/app_telefonbuch

Antworttyp Mögliche Inhalte
id Eindeutige Nummer des Telefonbucheintrags.
surname Nachname
givenname Vorname
company Firma
displayname Displayname - Angezeigter Name in Auerswald Systemtelefonen
number1 Externe Rufnummer 1
type1 Typ der externen Rufnummer 1
0 Benutzerdefiniert
1 Geschäftlich
2 Privat
3 Mobil
4 Fax geschäftlich
5 Fax privat
number2 Externe Rufnummer 2
type2 Typ der externen Rufnummer 2
- siehe Auflistung unter type1 -
number3 Externe Rufnummer 3
type3 Typ der externen Rufnummer 2
- siehe Auflistung unter type1 -
number4 Externe Rufnummer 4
type4 Typ der externen Rufnummer 4
- siehe Auflistung unter type1 -

https://192.168.0.240/app_telefonbuch?catId=0

Beispiel-Antwort:

[
    {
        "id": 7842,
        "surname": "Duck",
        "givenname": "Daisy",
        "company": "Entenhaus AG & CO.KG",
        "displayname": "Daisy Duck",
        "number1": "0123456789",
        "type1": 1,
        "number2": "0987654321",
        "type2": 2,
        "number3": "",
        "type3": 0,
        "number4": "",
        "type4": 0
    }
]

Inhaltsverzeichnis

Telefonbuchkategorien abrufen (ab Version 3)


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_address_categories Benutzer
Sub-Admin
Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_address_categories

Antworttyp Mögliche Inhalte
id Eindeutige Id der Kategorie.
name Der Name der Kategorie.
default Zeigt an, ob es sich um die Standard-Kategorie
0 nein
1 ja
type Zeigt an, um welchen Kategorie-Typ es sich handelt
0 Standard-Kategorie mit maximal 2000 Einträgen im Telefonbuch
1 COMfortel DECT 900 Handsets 140 Einträge im Telefonbuch*
2 COMfortel DECT 900 Handsets 250 Einträge im Telefonbuch*
3 Telefonbuch Version 1 mit 400 Einträgen im Telefonbuch*

* nur COMpact 5000 (R), COMmander 6000(R, RX)

Beispiel-Antwort:

[
    {
        "id": 4205,
        "name": "Einkauf",
        "default": 1,
        "type": 0
    }
]

Inhaltsverzeichnis

Liste der Anlagenkonfigurationen abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_konfig_list Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_konfig_list

Antworttyp Mögliche Inhalte
id Eindeutige Nummer der Anlagenkonfiguration.
bezeich Der Name der Anlagenkonfiguration.
identnummer Identifikationsnummer der Anlagenkonfiguration, die zur Konfigurationsumschaltung mit einem internen Telefon verwendet wird.
current Zeigt an, ob die Anlagenkonfiguration eingeschaltet ist. Es kann immer nur einen Wert true geben.
false aus
true ein

Beispiel-Antwort:

[
    {
        "id": 34,
        "bezeich": "Konfig-1",
        "identnummer": "201",
        "current": true
    },
    {
        "id": 5408,
        "bezeich": "Konfig-3",
        "identnummer": "203",
        "current": false
    }
]

Inhaltsverzeichnis

Anlagenkonfiguration schalten


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_konfig_set Benutzer
Sub-Admin

configId
Angabe der eindeutigen Anlagenkonfigurations-ID (id).

Beispiel-Aufruf:
https://192.168.0.240/app_konfig_set?configId=5408

Bemerkung:

  • Damit ein Benutzer die Anlagenkonfiguration umschalten kann, muss in den Teilnehmer-Eigenschaften unter Berechtigungen" die Funktion Konfigurationsumschaltung" eingeschaltet sein.
Antworttyp Mögliche Inhalte
successful true Umschaltung erfolgreich
false Umschaltung nicht erfolgreich

Beispiel-Antwort:

{"successful":true}

Inhaltsverzeichnis

Speicherübersicht des Voicemail- und Faxsystems abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_vmf_mem_state Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_vmf_mem_state

Antworttyp Mögliche Inhalte
storage_type Zeigt die Art des Speichers an.
0 unbekannt
1 SD-Karte
sdstatus Zeigt den Status des verwendeten Speichers an.
AVAIL Speicher ist bereit
ERROR Speicher ist vorhanden, aber nicht benutzbar
(z. B. nicht unterstütztes Format)
UNAVAIL kein Speicher gefunden
sdfreeSpace Zeigt den freien Speicher in Prozent (%) an.
sdMBfree Zeigt den freien Speicher in KByte an.
sdMBtotal Zeigt die maximal mögliche Speicherkapazität in KByte an.
readonly Zeigt an, ob der verwendete Speicher einen Schreibschutz aktiviert hat.
0 Kein Schreibschutz eingeschaltet
1 Schreibschutz eingeschaltet
sd_name Zeigt den Produktnamen der SD-Karte an.
sd_rev Zeigt die Revisionsnummer der SD-Karte an.
sd_oid Zeigt die OEM-/Application-ID der SD-Karte an.
showSDInfos Zeigt an, ob die ausgelesenen Werte gültig sind.
0 ungültig
1 gültig
sd_mid Zeigt die Manufacture-ID der SD-Karte an.

Beispiel-Antwort:

{
    "storage_type": 1,
    "sdstatus": "AVAIL",
    "sdfreeSpace": 99,
    "sdMBfree": 1903648,
    "sdMBtotal": 1920736,
    "readonly": 0,
    "sd_name": "SD02G",
    "sd_rev": "0.0",
    "sd_oid": 21581,
    "showSDInfos": false,
    "sd_mid": 2
}

Inhaltsverzeichnis

Liste der Ämter (externe Anschlüsse) abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_amt_list Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_amt_list

Antworttyp Mögliche Inhalte
amtID Eindeutige Nummer des Amtanschlusses (nicht die Amtrufnummer).
name Name des Amtanschlusses.
ptpNumber Zeigt die Basisrufnummer eines TK-Anlagenanschlusses an (PTP).
art Zeigt den Typ bzw. Art des Anschlusses an.
0 ISDN-PTP
1 ISDN-PTMP
2 VoIP-PTMP
3 POTS (Analog)
4 VoIP-PTP

Beispiel-Antwort:

[
    {
        "amtId": 749,
        "name": "AMT Grundboard",
        "ptpNumber": "",
        "art": 1
    },
    {
        "amtId": 9044,
        "name": "VoIP PTMP",
        "ptpNumber": "",
        "art": 2
    }
]

Inhaltsverzeichnis

Portübersicht (extern)


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_ext_ports_status Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_ext_ports_status

Antworttyp Mögliche Inhalte
amtId Eindeutige Nummer des Amtanschlusses (nicht die Amtrufnummer).
anschlArt Zeigt den Typ bzw. Art des Anschlusses an.
0 ISDN-PTP
1 ISDN-PTMP
2 VoIP-PTMP
4 VoIP-PTP
bKanalGesperrt Zeigt an, ob der B-Kanal gesperrt ist (nur bei einem S2M-Amtport).
0 nicht gesperrt
1 gesperrt
bKanalStatus Zeigt den Status des Gesprächskanals an.
0 frei
1 belegt
moduleId Eindeutige Nummer des Moduls im System.
(Hinweis: Beim Firmwarestand 5.6A der COMmander 6000 verwenden Sie bitte den Befehl "moduleID")
portId Eindeutige Nummer des ISDN-Ports (S0 oder S2M) im System.
portNr Zeigt den Port auf dem Modul an.

Für jeden Kanal (VoIP, ISDN) wird ein kompletter Satz Antworttypen ausgegeben. Bei einem S2M-Port bedeutet dies 30 und bei einem S0-Port 2 komplette Sätze amtID bis portNR.

Beispiel-Antwort:

[
    {
        "amtId": "749",
        "anschlArt": "0",
        "bKanalGesperrt": "0",
        "bKanalStatus": "0",
        "moduleId": "3",
        "portId": "8054",
        "portNr": "0"
    },
    {
        "amtId": "749",
        "anschlArt": "0",
        "bKanalGesperrt": "0",
        "bKanalStatus": "0",
        "moduleId": "3",
        "portId": "8054",
        "portNr": "0"
    }
]

Beispiel-Antwort:

[
    {
        "amtId": "750",
        "anschlArt": "1",
        "bKanalGesperrt": "0",
        "bKanalStatus": "0",
        "moduleId": "3",
        "portId": "8055",
        "portNr": "2"
    },
    {
        "amtId": "750",
        "anschlArt": "1",
        "bKanalGesperrt": "0",
        "bKanalStatus": "0",
        "moduleId": "3",
        "portId": "8055",
        "portNr": "2"
    }
]

Beispiel-Antwort:

[
    {
        "amtId": "4659",
        "anschlArt": "0",
        "bKanalGesperrt": "0",
        "bKanalStatus": "0",
        "moduleId": "2",
        "portId": "5999",
        "portNr": "0"
    },
    {
        "amtId": "4659",
        "anschlArt": "0",
        "bKanalGesperrt": "0",
        "bKanalStatus": "0",
        "moduleId": "2",
        "portId": "5999",
        "portNr": "0"
    }
]

Inhaltsverzeichnis

Übersicht MSN-/DDI-Anrufweiterschaltungen abrufen


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_msn_aws_list Benutzer
Sub-Admin
keine

Beispiel-Aufruf:
https://192.168.0.240/app_msn_aws_list

Antworttyp Mögliche Inhalte
msnId Eindeutige Nummer der Amtrufnummer (nicht die Amtrufnummer).
amtId Eindeutige Nummer des Amtanschlusses (nicht die Amtrufnummer).
name Zeigt den Namen der Amtrufnummer an.
rufNummer Zeigt die tatsächliche Amtrufnummer an.
awssoforttyp Zeigt den Status der sofortigen Anrufweiterschaltung an.
0 ausgeschaltet
1 eingeschaltet
awssofortziel Zeigt das Rufziel der sofortigen Anrufweiterschaltung an.
awsnrtyp Zeigt den Status der Anrufweiterschaltung bei Nichtmelden an.
0 ausgeschaltet
1 eingeschaltet
awsnrziel Zeigt das Rufziel der Anrufweiterschaltung bei Nichtmelden an.
awsbstyp Zeigt den Status der Anrufweiterschaltung bei besetzt an.
0 ausgeschaltet
1 eingeschaltet
awsbsziel Zeigt das Rufziel der Anrufweiterschaltung bei besetzt an.

Beispiel-Antwort:

[
    {
        "msnId": 6399,
        "amtId": 749,
        "name": "MSN1",
        "rufNummer": "4712",
        "awssoforttyp": 0,
        "awssofortziel": "6549432",
        "awsnrtyp": 1,
        "awsnrziel": "486433241",
        "awsbstyp": 0,
        "awsbsziel": "6548911"
    },
    {
        "msnId": 864,
        "amtId": 749,
        "name": "MSN2",
        "rufNummer": "970852",
        "awssoforttyp": 0,
        "awssofortziel": "",
        "awsnrtyp": 0,
        "awsnrziel": "",
        "awsbstyp": 0,
        "awsbsziel": ""
    }
]

Inhaltsverzeichnis

MSN-/DDI-Rufumleitung ein- und ausschalten (Zielrufnummer ab Version 2)


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_msn_aws_set Benutzer
Sub-Admin

msnId
Angabe der MSN-ID (msnID).

msnTyp
0 sofort
1 bei besetzt
2 bei Nichtmelden

switchOnOff
0 einschalten
1 ausschalten

ziel
Gibt die Zielrufnummer inkl. Amtzugangsziffer der Anrufweiterschaltung an.

Beispiel-Aufruf – Rufumleitung „sofort“ einschalten (gespeicherte Zielrufnummer wird übernommen):
https://192.168.0.240/app_msn_aws_set?msnId=6399&msnTyp=1&switchOnOff=1

Beispiel-Aufruf – Rufumleitung „sofort“ einschalten, inkl. Zielrufnummer:
https://192.168.0.240/app_msn_aws_set?msnId=6399&msnTyp=1&switchOnOff=1&ziel=00530692000

Bemerkung:

  • Damit der Benutzer die MSN-/DDI-Rufumleitung schalten kann, muss in den Teilnehmer-Eigenschaften unter Berechtigungen die Option Einrichtung von Leistungsmerkmalen beim Netzbetreiber (AWS, Keypad)" eingeschaltet sein.
Antworttyp Mögliche Inhalte
successful true Umschaltung erfolgreich
false Umschaltung nicht erfolgreich

Beispiel-Antwort:

{"successful":true}

Inhaltsverzeichnis

Status der Gruppenloggzustände (ab Version 2)


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_group_logstate Benutzer
Sub-Admin

keine

Beispiel-Aufruf:
https://192.168.0.240/app_group_logstate

Bemerkung:

  • Bei Anmeldung als „Admin“ liefert der Kommunikationsserver ein leeres Array, angezeigt als [].
Antworttyp Mögliche Inhalte
grpId Eindeutige Nummer der Gruppe (nicht die Gruppenrufnummer).
nr Interne Rufnummer der Gruppe.
name Zeigt den Namen der Gruppe an.
kommend Zeigt den Status des Logzustandes „kommend“ an.
0 ausgeschaltet
1 eingeschaltet
gehend Zeigt den Status des Logzustandes „gehend“ an.
0 ausgeschaltet
1 eingeschaltet

Beispiel-Antwort:

[
    {
        "grpId": 8224,
        "nr": "301",
        "name": "Test",
        "kommend": 1,
        "gehend": 0
    },
    {
        "grpId": 5476,
        "nr": "302",
        "name": "",
        "kommend": 1,
        "gehend": 0
    },
    {
        "grpId": 8014,
        "nr": "303",
        "name": "Amt 2",
        "kommend": 1,
        "gehend": 0
    },
    {
        "grpId": 4142,
        "nr": "308",
        "name": "Service",
        "kommend": 1,
        "gehend": 0
    }
]

Inhaltsverzeichnis

Änderung der Gruppenlogzustände (ab Version 2)


Funktionsaufruf (URL) Berechtigungen Mögliche Parameter
/app_group_logchange Benutzer
Sub-Admin
Admin

grpId
Id der Gruppe, in die der Teilnehmer ein- oder ausgeloggt werden soll.

kommend
Es wird Logstatus „kommend“ definiert.
0 ausloggen
1 einloggen

gehend
Es wird Logstatus „gehend“ definiert.
0 ausloggen
1 einloggen

Beispiel-Aufruf – Teilnehmer in Gruppe mit ID 5476 kommend einloggen:
https://192.168.0.240/app_group_logchange?grpId=5476&kommend=1

Beispiel-Aufruf – Teilnehmer in Gruppe mit ID 5476 kommend und gehend einloggen:
https://192.168.0.240/app_group_logchange?grpId=5476&kommend=1&gehend=1

Beispiel-Aufruf – Teilnehmer in Gruppe mit ID 5476 kommend und gehend ausloggen:
https://192.168.0.240/app_group_logchange?grpId=5476&kommend=0&gehend=0

Bemerkung:

  • Bei Anmeldung als „Admin“ liefert der Kommunikationsserver ein leeres Array, angezeigt als [].
  • Die Parameter kommend und gehend können zusammen oder getrennt verwendet werden. Der Status kommend oder gehend fest eingeloggter Teilnehmer kann nicht geändert werden.
Antworttyp Mögliche Inhalte
successful

true Umschaltung erfolgreich
false Umschaltung nicht erfolgreich

kommend
0 ausgeloggt
1 eingeloggt
2 fest eingeloggt

gehend
0 ausgeloggt
1 eingeloggt
2 fest eingeloggt


Beispiel-Antwort:


    {
    "successful": true,
    “gehend“: 0
}{
    "successful": true,
    “kommend“: 1,
    “gehend“: 1
}

Inhaltsverzeichnis