> For the complete documentation index, see [llms.txt](https://help.sipgate.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.sipgate.de/cloud-telefonanlage/en/connections-and-integrations/api/was-aendert-sich-mit-dem-neuen-system-in-der-sipgate-rest-api-und-bei-sipgateio.md).
# What changes with the new system in the sipgate REST API and sipgate.io?
In September 2025, sipgate released a new system for end customers with sipgate neo. 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 switch also affects the behavior of the sipgate REST API and sipgate.io. All relevant changes affecting 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 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 retrievable via the history endpoints. Call events will no longer be available through 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 provided 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 are therefore initially still available via the previous history endpoints.
#### **Push API**
The Push API has been expanded for sipgate Neo and there supports incoming and outgoing channel calls. Webhook configuration still takes place in the app web interface. There you can define 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 expanded in the backend so that control of the new channel calls remains possible with the existing endpoints. The response structure remains in place for compatibility purposes.
| **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 being started*" 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 expansion 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, 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 event volumes, use the position parameter: 1. The initial request returns 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 | Set the list of devices for a user 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. |
Refer to the feature roadmap for the plan to expand the channel endpoints at: [https://feedback.sipgate.de](https://feedback.sipgate.de/).
#### **Fax**
Group fax lines are being phased out. Existing fax lines will be converted accordingly into a global fax line during the Neo account migration. For use of the REST API, the /groupfaxlines endpoints are therefore being removed. Instead, the /{userId}/faxlines endpoints are available. Work is currently underway on new endpoints that provide a global view of fax lines.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://help.sipgate.de/cloud-telefonanlage/en/connections-and-integrations/api/was-aendert-sich-mit-dem-neuen-system-in-der-sipgate-rest-api-und-bei-sipgateio.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.