Was ändert sich mit dem neuen System in der sipgate REST API und bei sipgate.io?

Alle Änderungen der sipgate REST API und sipgate.io nach der Umstellung auf das neue sipgate Neo System im Überblick.

Im September 2025 hat sipgate ein neues System für Endkunden veröffentlicht. Alle seit September 2025 neu angelegten Accounts laufen bereits über dieses neue System, ältere Accounts, die bereits vor September 2025 existiert haben, sollen schrittweise migriert werden. Die Umstellung hat auch Auswirkungen auf das Verhalten der sipgate REST API und sipgate.io. Alle Änderungen, die die REST API und sipgate.io betreffen, werden in dem nachfolgenden Artikel ausführlich beschrieben.

Account-Type

Der Account-Type ist einerseits in der Weboberfläche einsehbar und technisch im JSON-Web-Token angegeben. Im Feld featureScope steht entweder "CLASSIC_PBX" oder "NEO_PBX".

History

Ereignisse wie Fax und SMS können für Neukunden in der Weboberfläche eingesehen werden und bleiben über die History-Endpunkte abrufbar. Anrufereignisse sind über diese Endpunkte zukünftig nicht mehr verfügbar, eine Anfrage wird ein leeres Ergebnis zurückgeben. Stattdessen werden Anrufereignisse, sowohl eingehende als auch ausgehende, im Channel hinterlegt und per API über den Channel-Endpunkte GET /channels/{channelId}/events angeboten.

Für migrierte Bestandskunden mit einem sipgate Neo Account, werden Anrufereignisse zusätzlich in die gewohnte Ereignisliste der Weboberfläche geschrieben und stehen damit zunächst auch weiterhin über die bisherigen History-Endpunkte zur Verfügung.

Push API

Die Push-API wurde für sipgate Neo erweitert und unterstützt dort eingehende und ausgehende Channel-Anrufe. Die Webhook-Konfiguration erfolgt weiterhin im Appweb. Dort können Sie festlegen, für welche Channels Webhooks ausgelöst werden sollen.

Mit sipgate Neo können nur noch HTTPS Webhooks konfiguriert werden.

Devices

Endpunkt (api.sipgate.com/v2)

Beschreibung

GET /{userId}/devices

Erweitert um den Query-Parameter type und die Ausgabe der App-Extension. Mögliche Werte als comma-separierte Liste: all, app, register, mobile, external.

RTCM - Real Time Call Manipulation

Die RTCM Endpunkte werden im Backend funktional erweitert, sodass eine Steuerung der neuen Channel-Calls mit den bestehenden Endpunkten möglich bleibt. Die Response-Struktur bleibt zum Zweck der Kompatibilität bestehen.

Endpunkt

Stand für sipgate Neo

Informationen

GET /calls

In Bearbeitung

BETA: Calls zum Default Channel des Devices starten ist möglich. Channel-Inbox-Events und Auswahl des Channels ist in Bearbeitung. Das Starten eines Calls auf einem externen Telefon (X-Extension) ist zur Zeit noch nicht möglich.

POST /calls/{callId}/dtmf

Umgesetzt

Geänderter HTTP Response Status Codes: Leerer Request-Body: Classic = 400 Bad Request, Neo = 204 No Content

PUT /calls/{callId}/hold

Umgesetzt

PUT /calls/{callId}/recording

Umgesetzt

Analog zum Starten/Stoppen eines Recordings mit *6. Das Announcement "Aufnahme wird gestartet" wird immer eingespielt.

POST /calls/{callId}/transfer

Umgesetzt

Attended und unattended Transfer.

PUT /calls/{callId}/mute

In Prüfung

Die Nutzung des Endpunkts wird zur Zeit geprüft.

DELETE /calls/{callId}

Umgesetzt

POST /calls/{callId}/announcements

Keine Umsetzung

Eine Erweiterung dieses Endpunkts für sipgate Neo ist bisher nicht vorgesehen.

Channels

Channels lösen Gruppen (groups) und die bisher bekannten persönlichen Routings (phonelines) ab.

Mit sipgate Neo stehen Telefonate immer in Bezug zu einem Channel. Um diese Referenz herzuleiten, stehen aktuell folgende Endpunkte zur Verfügung:

Endpunkt (api.sipgate.com/v2)

Beschreibung

GET /channels

Die Channels eines Accounts abrufen.

GET /channels/{channelId}/events

Die Anrufereignisse eines Channels abrufen. Nur berechtigte Nutzer (Channel-Mitglieder bzw. Admins bei nicht-privaten Channels) können auf die Events zugreifen. Für die Navigation durch größere Event-Mengen verwenden Sie den position-Parameter: 1. Die initiale Request liefert die ersten Events und einen position-Wert 2. Übergeben Sie diesen position-Wert im nächsten Request, um die nächste Seite abzurufen 3. Die Position markiert dabei den Startpunkt ("start after") - das Event mit diesem Key wird nicht erneut zurückgegeben

PUT /channels/{channelId}/users

Die Userliste eines Channels setzen.

PUT /channels/{channelId}/users/{userId}/devices

Für einen User die Liste der Geräte setzen, mit denen er im Channel vertreten sein soll.

PUT /channels/{channelId}/name

Den Namen eines Channels setzen.

DELETE /channels/{channelId}

Einen Channel löschen.

Entnehmen Sie den Plan zur Erweiterung der Channel-Endpunkte der Feature-Roadmap auf: https://feedback.sipgate.dearrow-up-right.

Fax

Die Gruppenfaxe fallen weg. Bestehende Faxanschlüsse werden bei der Neo-Account-Migration entsprechend in einen globalen Faxanschluss umgestellt. Für die Nutzung der REST API fallen die /groupfaxlines -Endpunkte deshalb weg. Stattdessen stehen die /{userId}/faxlines -Endpunkte zur Verfügung. An neuen Endpunkten die eine globale Sicht auf Faxanschlüsse bietet, wird zur Zeit gearbeitet.

Zuletzt aktualisiert