What changes with the new system in the sipgate REST API and sipgate.io?

An overview of all changes to the sipgate REST API and sipgate.io after the switch to the new sipgate Neo system.

In September 2025, sipgate released sipgate neo, a new system for end customers. All accounts newly created since September 2025 already run on this new system; older sipgate classic accounts that already existed before September 2025 are to be migrated gradually. The change also affects the behavior of the sipgate REST API and sipgate.io. All relevant changes concerning the REST API and sipgate.io are described in detail in the article below.

Account type

The account type can be viewed in the web interface on the one hand and is technically specified in the JSON Web Token. In the field featureScope it is either "CLASSIC_PBX" or "NEO_PBX".

History

Events such as fax and SMS can for new customers be viewed in the web interface and remain accessible via the history endpoints. Call events will no longer be available via these endpoints in the future; a request will return an empty result. Instead, call events, both incoming and outgoing, are stored in the channel and made available via the API through the channel endpoint GET /channels/{channelId}/events.

For migrated existing customers with a sipgate Neo account, call events are additionally written to the familiar event list in the web interface and will therefore initially continue to be available via the existing history endpoints.

Push API

The Push API has been extended for sipgate Neo and supports incoming and outgoing channel calls there. The webhook configuration is still done in the Appweb. There you can specify for which channels webhooks should be triggered.

With sipgate Neo, only HTTPS webhooks can be configured.

Devices

Endpoint (api.sipgate.com/v2)	Description
GET /{userId}/devices	Extended by the query parameter type and the output of the app extension. Possible values as a comma-separated list: all, app, register, mobile, external.

RTCM - Real Time Call Manipulation

The RTCM endpoints are functionally extended in the backend so that controlling the new channel calls with the existing endpoints remains possible. The response structure remains in place for compatibility reasons.

Endpoint	Status for sipgate Neo	Information
GET /calls	In progress	BETA: Starting calls to the device's default channel is possible. Channel inbox events and channel selection are in progress. Starting a call on an external phone (X extension) is currently not yet possible.
POST /calls/{callId}/dtmf	Implemented	Changed HTTP response status codes: empty request body: Classic = 400 Bad Request, Neo = 204 No Content
PUT /calls/{callId}/hold	Implemented
PUT /calls/{callId}/recording	Implemented	Analogous to starting/stopping a recording with *6. The announcement "Recording is starting" is always played.
POST /calls/{callId}/transfer	Implemented	Attended and unattended transfer.
PUT /calls/{callId}/mute	Under review	The use of the endpoint is currently being reviewed.
DELETE /calls/{callId}	Implemented
POST /calls/{callId}/announcements	No implementation	An extension of this endpoint for sipgate Neo is not planned so far.

Channels

Channels replace groups and the previously known personal routings (phonelines).

With sipgate Neo, phone calls are always associated with a channel. To derive this reference, the following endpoints are currently available:

Endpoint (api.sipgate.com/v2)	Description
GET /channels	Retrieve the channels of an account.
GET /channels/{channelId}/events	Retrieve the call events of a channel. Only authorized users (channel members or admins for non-private channels) can access the events. To navigate through larger amounts of events, use the position parameter: 1. The initial request delivers the first events and a position value 2. Pass this position value in the next request to retrieve the next page 3. The position marks the starting point ("start after") - the event with this key is not returned again
PUT /channels/{channelId}/users	Set the user list of a channel.
PUT /channels/{channelId}/users/{userId}/devices	For a user, set the list of devices with which they should be represented in the channel.
PUT /channels/{channelId}/name	Set the name of a channel.
DELETE /channels/{channelId}	Delete a channel.

Please refer to the feature roadmap for the plan to extend the channel endpoints at: https://feedback.sipgate.de.

Fax

Group faxes are being discontinued. Existing fax connections will be converted accordingly to a global fax connection during the Neo account migration. For the use of the REST API, the /groupfaxlines endpoints will therefore be discontinued. Instead, the /{userId}/faxlines endpoints are available. Work is currently underway on new endpoints that provide a global view of fax connections.