Anruf HTTP GET Schnittstelle V2: Unterschied zwischen den Versionen

← Zum vorherigen Versionsunterschied Zum nächsten Versionsunterschied →

Version vom 22. August 2025, 10:19 Uhr

Anruflisten API

Adresse: http://[instance]-classic.infra-struktur.[eu|com]/api/calllist/index.php

Übergabe als webhook per GET oder POST (GET hat Vorrang vor POST)

Folgende Werte müssen übergeben werden:

isdnKey - Der ISDN-Key.
location - Der Name eines in der Anrufliste konfigurierten Standortes.
msn - Der Name einer in der Anrufliste konfigurierten eingehenden Rufnummern/Nebenstellen. 
number - Die Nummer des Anrufers.

Es sollte beachtet werden, das z.b. die Nummer „+492941247790“ zur Übergabe als Parameter codiert werden muss, damit das führende + auf dem Server passend ausgewertet werden kann. (http://de.wikipedia.org/wiki/URL-Encoding)

Folgende Werte können übergeben werden:

reason - Der base64 codierte Grund eines Anrufes.
fileSource - Der base64 codierte Inhalt einer Datei.
fileType - Der Typ einer Datei. Der Standardwert liegt auf „fax“.
mimeType - Der mimetype einer Datei. Der Standardwert liegt auf „application/download“.
timestamp - Ein Unixtimestamp mit der der Eintrag erzeugt werden soll. Der Standardwert liegt auf dem Zeitpunkt des Aufrufs.
direction - entweder "in" oder "out für eingehende oder ausgehende Anrufe. Default ist "in".

Um einen bestehenden Anruf zu aktualisieren kann folgender Webhook genutzt werden.

Adresse: http://[instance]-classic.infra-struktur.[eu|com]/api/calllist/update.php

Übergabe als webhook per GET oder POST (GET hat Vorrang vor POST)

Folgende Werte müssen übergeben werden:

isdnKey - Der ISDN-Key.
number - Die Nummer des Anrufs der aktualisiert werden soll.

Es sollte beachtet werden, das z.b. die Nummer „+492941247790“ zur Übergabe als Parameter codiert werden muss, damit das führende + auf dem Server passend ausgewertet werden kann. (http://de.wikipedia.org/wiki/URL-Encoding)

Folgende Werte können übergeben werden:

id - die ID des Anrufs die beim anlegen des Anrufs zurückgegeben wurde. Die hat auch vorrang vor einer übergebenen Rufnummer.
reason - ein Anrufgrund der als base64 oder im Klartext übergeben werden kann. Als GET ert muss das natürlich URLencoded werden.
reasonAppend - ein Ergänzung zu einem Anrufgrund der als base64 oder im Klartext übergeben werden kann. Als GET ert muss das natürlich URLencoded werden.
acceptedBy - das Kürzel des Benutzer der in "angenommen durch" eingetragen werden soll.
callFor - das Kürzel des Benutzer der in "Anruf für" eingetragen werden soll.
recall - Die Information ob ein Rückruf gewünscht ist.

Sonderfall OpenAI Whisper Integration

Jede infra-struktur hat einen integrierten lokalen Whisper-Server der aus Audiodateien transkriptionen erzeugen kann.
Dafür kann der update.php eine Audiodatei übergeben werden. Diese wird dann in Text gewandelt und der Text wird in den Anruf geschrieben. Die Audiodatei 
ist mit einem Mediaplayer auch noch abspielbar unter dem Anruf.

fileSourceRaw - Eine Audiodatei im binary Format. Aufgrund des Formats und der Größe nur mit POST zu nutzen.

Es können folgende Fehlerwerte auftreten:

1001 - MISSING_MANDATORY_REQUEST_PARAM_ISDNKEY

Meldung: „isdnKey“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)

1002 - MISSING_MANDATORY_REQUEST_PARAM_LOCATION

Meldung: „location“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)

1003 - MISSING_MANDATORY_REQUEST_PARAM_MSN

Meldung: „msn“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)

1004 - MISSING_MANDATORY_REQUEST_PARAM_NUMBER

Meldung: „number“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)

2001 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_HOST

Meldung: „host“ database connection param is mandatory, please contact the support

2002 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_USERNAME

Meldung: „username“ database connection param is mandatory, please contact the support

2003 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_PASSWORD

Meldung: „password“ database connection param is mandatory, please contact the support

2004 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_DATABASE

Meldung: „database“ database connection param is mandatory, please contact the support

3001 - DATABASE_CONNECTION_CREATE

Meldung: Connection Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]

3101 - DATABASE_QUERY_ON_VALIDATE_ISDNKEY_IN_DB