Anruf HTTP GET Schnittstelle V2 - Versionsgeschichte

Karsten: /* Optionale Parameter */

2026-10-22T13:43:19Z

Optionale Parameter

← Nächstältere Version		Version vom 22. Oktober 2026, 13:43 Uhr
Zeile 110:		Zeile 110:
	\| recall		\| recall
	\| Angabe, ob ein Rückruf gewünscht ist als "ja" oder "nein"		\| Angabe, ob ein Rückruf gewünscht ist als "ja" oder "nein"
			\|-
			\| ownerInitial
			\| Benutzerkürzel des internen Benutzers, der das Gespräch geführt hat
			\|-
			\| fileSourceOut
			\| Ausgehender Audiostream als binärer Datei-Upload; nur via POST mit <code>multipart/form-data</code>
			\|-
			\| fileSourceIn
			\| Eingehender Audiostream als binärer Datei-Upload; nur via POST mit <code>multipart/form-data</code>
	\|}		\|}

Karsten am 22. Oktober 2026 um 13:42 Uhr

2026-10-22T13:42:15Z

@@ Zeile 125: / Zeile 125: @@
 | Audiodatei im '''Binary-Format''' (nur via '''POST''' möglich, wegen Größe und Format)
 |}
 == 4. Fehlercodes ==

Karsten am 22. Oktober 2026 um 13:41 Uhr

2026-10-22T13:41:17Z

← Nächstältere Version		Version vom 22. Oktober 2026, 13:41 Uhr
Zeile 236:		Zeile 236:
	* Als Grund wird ''Rückruf gewünscht'' gespeichert.		* Als Grund wird ''Rückruf gewünscht'' gespeichert.
	* Der Anruf wird als '''angenommen durch Benutzer AB''' markiert.		* Der Anruf wird als '''angenommen durch Benutzer AB''' markiert.

			=== 5.4 POST-Beispiel: Getrennte Audiostreams hochladen und Anruf zusammenfassen ===

			<pre>
			curl -X POST "https://netzkultur-classic.infra-struktur.com/api/calllist/update.php" \
			-H "Content-Type: multipart/form-data" \
			-F "isdnKey=247790" \
			-F "ownerInitial=CT" \
			-F "externalId=21cf1ada-a93c-4436-b3c9-eb404c1b954c" \
			-F "fileSourceOut=@/var/starface/module/instances/repo/5dd8302c-eb41-4a3d-8479-29755315f960/var/files/monitor/21cf1ada-a93c-4436-b3c9-eb404c1b954c_00492941272630_0049532134070-in.wav" \
			-F "fileSourceIn=@/var/starface/module/instances/repo/5dd8302c-eb41-4a3d-8479-29755315f960/var/files/monitor/21cf1ada-a93c-4436-b3c9-eb404c1b954c_00492941272630_0049532134070-out.wav"
			</pre>

			'''Bedeutung der Parameter:'''

			{\| class="wikitable"
			! Parameter
			! Beispielwert
			! Bedeutung
			\|-
			\| isdnKey
			\| <code>247790</code>
			\| ISDN-Key der ''infra-struktur''-Instanz
			\|-
			\| ownerInitial
			\| <code>CT</code>
			\| Kürzel des internen Benutzers, der das Gespräch geführt hat
			\|-
			\| externalId
			\| <code>21cf1ada-a93c-4436-b3c9-eb404c1b954c</code>
			\| Eindeutige Gesprächs-ID des Telefonsystems
			\|-
			\| fileSourceOut
			\| <code>@/pfad/zum/audiostream.wav</code>
			\| Ausgehender Audiostream als binärer Datei-Upload
			\|-
			\| fileSourceIn
			\| <code>@/pfad/zum/audiostream.wav</code>
			\| Eingehender Audiostream als binärer Datei-Upload
			\|}

			'''Ergebnis:'''

			* Der über <code>externalId</code> identifizierte Anruf wird aktualisiert.
			* Der eingehende und der ausgehende Audiostream werden dem Anruf zugeordnet.
			* Das Benutzerkürzel aus <code>ownerInitial</code> kennzeichnet den internen Gesprächsteilnehmer.
			* Die Audiostreams werden automatisch verarbeitet.
			* Im Anruf wird eine automatische Transkription beziehungsweise Anrufzusammenfassung gespeichert.
			* Die zugehörigen Audiodateien bleiben beim Anruf verfügbar.

			'''Hinweis:''' Die Zuordnung von <code>fileSourceOut</code> und <code>fileSourceIn</code> richtet sich nach der Perspektive beziehungsweise Exportlogik des angebundenen Telefonsystems. Bei der STARFACE-Integration kann die Bezeichnung innerhalb des Dateinamens von der Bezeichnung des API-Parameters abweichen. Maßgeblich ist daher die im Integrationsmodul konfigurierte Zuordnung.

Karsten: /* 2. Anruf aktualisieren */

2025-11-06T15:12:05Z

2. Anruf aktualisieren

← Nächstältere Version		Version vom 6. November 2025, 15:12 Uhr
Zeile 81:		Zeile 81:
	\| number		\| number
	\| Rufnummer des zu aktualisierenden Anrufs ('''muss URL-encodiert werden''') (Wird nicht gebraucht wenn eine externalId übergeben wird.)		\| Rufnummer des zu aktualisierenden Anrufs ('''muss URL-encodiert werden''') (Wird nicht gebraucht wenn eine externalId übergeben wird.)
	\|-
	~~\| externalId~~
	~~\| wurde beim initialen Eintrag des Anrufs eine externalId übergeben kann das update damit genau auf den Eintrag gemünzt werden.~~
	\|}		\|}

Zeile 93:		Zeile 90:
	! Beschreibung		! Beschreibung
	\|-		\|-
	\| id		\| AnrufID
	\| ID des Anrufs (hat Vorrang vor <code>number</code>)		\| ID des Anrufs (hat Vorrang vor <code>number</code>)
			\|-
			\| externalId
			\| wurde beim initialen Eintrag des Anrufs eine externalId übergeben kann das update damit genau auf den Eintrag gemünzt werden.
	\|-		\|-
	\| reason		\| reason

Karsten: /* Rückgabe/Response */

2025-11-06T15:10:06Z

Rückgabe/Response

← Nächstältere Version		Version vom 6. November 2025, 15:10 Uhr
Zeile 63:		Zeile 63:
	\|-		\|-
	\|Done XYZ		\|Done XYZ
	\|Der Wert "Done" zeigt den erfolgreichen Eintrag an gefolgt von der vom ~~system~~ vergebenen ID. Über die kann der Anruf später weiter aktualisiert werden.		\|Der Wert "Done" zeigt den erfolgreichen Eintrag an gefolgt von der vom System vergebenen ID. Über die kann der Anruf später weiter aktualisiert werden.
	\|}		\|}

Karsten: /* 1. Anruf eintragen */

2025-11-06T15:09:38Z

1. Anruf eintragen

← Nächstältere Version		Version vom 6. November 2025, 15:09 Uhr
Zeile 55:		Zeile 55:
	\| externalId		\| externalId
	\| Eine eigene ID des Telefonsystems über den ich später mit dem update Aufruf einen Eintrag exakt diesem Eintrag zuordnen kann.		\| Eine eigene ID des Telefonsystems über den ich später mit dem update Aufruf einen Eintrag exakt diesem Eintrag zuordnen kann.
			\|}

			=== Rückgabe/Response ===
			{\| class="wikitable"
			! Parameter
			! Beschreibung
			\|-
			\|Done XYZ
			\|Der Wert "Done" zeigt den erfolgreichen Eintrag an gefolgt von der vom system vergebenen ID. Über die kann der Anruf später weiter aktualisiert werden.
	\|}		\|}

Karsten am 6. November 2025 um 14:46 Uhr

2025-11-06T14:46:54Z

← Nächstältere Version		Version vom 6. November 2025, 14:46 Uhr
Zeile 49:		Zeile 49:
	\| direction		\| direction
	\| <code>"in"</code> oder <code>"out"</code> (Standard: <code>in</code>)		\| <code>"in"</code> oder <code>"out"</code> (Standard: <code>in</code>)
			\|-
			\| duration
			\| Dauer in Minuten eines Anrufs.
			\|-
			\| externalId
			\| Eine eigene ID des Telefonsystems über den ich später mit dem update Aufruf einen Eintrag exakt diesem Eintrag zuordnen kann.
	\|}		\|}

Zeile 65:		Zeile 71:
	\|-		\|-
	\| number		\| number
	\| Rufnummer des zu aktualisierenden Anrufs ('''muss URL-encodiert werden''')		\| Rufnummer des zu aktualisierenden Anrufs ('''muss URL-encodiert werden''') (Wird nicht gebraucht wenn eine externalId übergeben wird.)
			\|-
			\| externalId
			\| wurde beim initialen Eintrag des Anrufs eine externalId übergeben kann das update damit genau auf den Eintrag gemünzt werden.
	\|}		\|}

Karsten: /* Pflichtparameter */

2025-09-16T14:15:54Z

Pflichtparameter

← Nächstältere Version		Version vom 16. September 2025, 14:15 Uhr
Zeile 67:		Zeile 67:
	\| Rufnummer des zu aktualisierenden Anrufs ('''muss URL-encodiert werden''')		\| Rufnummer des zu aktualisierenden Anrufs ('''muss URL-encodiert werden''')
	\|}		\|}

			Mit der Rufnummer wird nach Anrufen in den letzten 60 Minuten mit der gleichen Rufnummer gesucht und der Anruf wird dann für den Grund verwendet.

	=== Optionale Parameter ===		=== Optionale Parameter ===

Karsten am 22. August 2025 um 10:30 Uhr

2025-08-22T10:30:22Z

← Nächstältere Version		Version vom 22. August 2025, 10:30 Uhr
Zeile 89:		Zeile 89:
	\|-		\|-
	\| recall		\| recall
	\| Angabe, ob ein Rückruf gewünscht ist		\| Angabe, ob ein Rückruf gewünscht ist als "ja" oder "nein"
	\|}		\|}

Karsten am 22. August 2025 um 10:28 Uhr

2025-08-22T10:28:34Z

← Nächstältere Version		Version vom 22. August 2025, 10:28 Uhr
Zeile 1:		Zeile 1:
	= 📞 Anruf-API – Version 2 =		= 📞 Anruf-API – Version 2 =

	Die '''Anruf-API''' dient dazu, Anrufe per Webhook in die CRM-Infrastruktur ''infra-struktur'' einzutragen und zu aktualisieren.		Die '''Anruf-API''' dient dazu, Anrufe per Webhook in die CRM-Infrastruktur ''infra-struktur'' einzutragen und zu aktualisieren.
	Die Schnittstelle kann per '''HTTP GET''' oder '''POST''' aufgerufen werden – '''GET hat Vorrang'''.		Die Schnittstelle kann per '''HTTP GET''' oder '''POST''' aufgerufen werden – '''GET hat Vorrang'''.

Zeile 7:		Zeile 7:

	'''Endpoint:'''		'''Endpoint:'''
	<code>		<code>http://[instance]-classic.infra-struktur.[eu\|com]/api/calllist/index.php</code>
	http://[instance]-classic.infra-struktur.[eu\|com]/api/calllist/index.php
	</code>

	=== Pflichtparameter ===		=== Pflichtparameter ===
Zeile 56:		Zeile 54:

	'''Endpoint:'''		'''Endpoint:'''
	<code>		<code>http://[instance]-classic.infra-struktur.[eu\|com]/api/calllist/update.php</code>
	http://[instance]-classic.infra-struktur.[eu\|com]/api/calllist/update.php
	</code>

	=== Pflichtparameter ===		=== Pflichtparameter ===
Zeile 98:		Zeile 94:
	== 3. Sonderfall: OpenAI Whisper Integration 🎙️ ==		== 3. Sonderfall: OpenAI Whisper Integration 🎙️ ==

	Jede ''infra-struktur''-Instanz verfügt über einen lokalen Whisper-Server, der Audiodateien automatisch transkribiert.		Jede ''infra-struktur''-Instanz verfügt über einen lokalen Whisper-Server, der Audiodateien automatisch transkribiert.
	Die '''Transkription wird im Anruf gespeichert''', die Originaldatei bleibt zusätzlich im Anruf per Mediaplayer abspielbar.		Die '''Transkription wird im Anruf gespeichert''', die Originaldatei bleibt zusätzlich im Anruf per Mediaplayer abspielbar.

Zeile 187:		Zeile 183:

	=== 5.1 POST-Beispiel: Audiodatei hochladen & transkribieren (Whisper) ===		=== 5.1 POST-Beispiel: Audiodatei hochladen & transkribieren (Whisper) ===
	<~~syntaxhighlight lang="bash"~~>		<pre>
	curl -X POST "http://[instance]-classic.infra-struktur.eu/api/calllist/update.php" \		curl -X POST "http://[instance]-classic.infra-struktur.eu/api/calllist/update.php" \
	-F "isdnKey=DEIN_ISDN_KEY" \		-F "isdnKey=DEIN_ISDN_KEY" \
	-F "number=%2B492941247790" \		-F "number=%2B492941247790" \
	-F "fileSourceRaw=@anruf.mp3;type=audio/mpeg"		-F "fileSourceRaw=@anruf.mp3;type=audio/mpeg"
	</~~syntaxhighlight~~>		</pre>

	Ergebnis:		Ergebnis:
Zeile 200:		Zeile 196:

	=== 5.2 POST-Beispiel: Audiodatei mit zusätzlichen Parametern ===		=== 5.2 POST-Beispiel: Audiodatei mit zusätzlichen Parametern ===
	<~~syntaxhighlight lang="bash"~~>		<pre>
	curl -X POST "http://[instance]-classic.infra-struktur.eu/api/calllist/update.php" \		curl -X POST "http://[instance]-classic.infra-struktur.eu/api/calllist/update.php" \
	-F "isdnKey=DEIN_ISDN_KEY" \		-F "isdnKey=DEIN_ISDN_KEY" \
Zeile 207:		Zeile 203:
	-F "acceptedBy=AB" \		-F "acceptedBy=AB" \
	-F "fileSourceRaw=@anruf.mp3;type=audio/mpeg"		-F "fileSourceRaw=@anruf.mp3;type=audio/mpeg"
	</~~syntaxhighlight~~>		</pre>

	Hier wird neben der Audiodatei zusätzlich ein '''Anrufgrund''' gesetzt (reason) und ein Bearbeiter eingetragen (acceptedBy).		Hier wird neben der Audiodatei zusätzlich ein '''Anrufgrund''' gesetzt (reason) und ein Bearbeiter eingetragen (acceptedBy).

	=== 5.3 GET-Beispiel: Text-Update ohne Datei ===		=== 5.3 GET-Beispiel: Text-Update ohne Datei ===
	<~~syntaxhighlight lang="bash"~~>		<pre>
	curl "http://[instance]-classic.infra-struktur.eu/api/calllist/update.php?isdnKey=DEIN_ISDN_KEY&number=%2B492941247790&reason=Rückruf+gewünscht&acceptedBy=AB"		curl "http://[instance]-classic.infra-struktur.eu/api/calllist/update.php?isdnKey=DEIN_ISDN_KEY&number=%2B492941247790&reason=Rückruf+gewünscht&acceptedBy=AB"
	</~~syntaxhighlight~~>		</pre>

	Ergebnis:		Ergebnis: