RTC-VersionsverwaltungAPI
Die /v1 Versprechen
Abschnitt betitelt „Die /v1 Versprechen“Alles unter /v1 Änderungen lediglich zusätzlich. RTC behält sich vor, Folgendes hinzuzufügen:
- neue Routen, optionale Anfragefelder und Abfrageparameter;
- neue Antwortfelder, Fehlercodes, Webhook-Ereignistypen und Enum-Werte;
- neue Antwort-Header.
Erstellen Sie Clients, die unbekannte Felder ignorieren und einen unbekannten Fehlercode wie den generischen Code seines HTTP-Status behandeln. RTC entfernt oder benennt kein Feld um, ändert weder dessen Typ noch dessen Bedeutung, macht keine optionale Eingabe zur Pflicht und verwendet keinen Fehlercode unter /v1.
Eine kompatibilitätsbrechende Änderung wird als neuer Hauptzweig veröffentlicht, /v2. Beide Versionen laufen dann nebeneinander für mindestens 12 Monate vor /v1 wird eingestellt, worüber auf dieser Website informiert wird.
Antwortformate mit RTC-Version
Abschnitt betitelt „Antwortformate mit RTC-Version“Einige Verbesserungen verändern die Form einer Antwort, ohne deren Bedeutung zu ändern, wie beispielsweise die Strukturierter Fehler-Envelope. Sie werden pro Anfrage mit einem datierten Versionsheader aktiviert:
RTC-Version: 2026-11-01| Version | Änderungen |
|---|---|
| keine | Ursprüngliche Formen. Fehler sind { "error": "<message>", "code"? }. |
2026-11-01 | Fehler werden über den „Envelope“ übermittelt { "error": { code, message, details?, requestId, retryable, docUrl } }. |
RTC wendet die neueste Version an, die nicht später als das Datum Ihrer Übermittlung liegt, und gibt diese in der RTC-Version Antwort-Header. Ein Datum, das vor der ersten Version liegt, behält die ursprünglichen Schemata bei. Fixieren Sie die Version, für die Ihr Code geschrieben wurde, und ändern Sie diese bewusst, wenn Sie ein Upgrade durchführen.
Webhook-Nutzdaten mit apiVersion
Abschnitt betitelt „Webhook-Nutzdaten mit apiVersion“Jede Webhook-Endpunkt verfügt über eine apiVersion die den empfangenen Envelope unabhängig von den Anfrage-Headern korrigiert:
apiVersion | Envelope |
|---|---|
legacy | { id, type, createdAt, projectId, data }, der frühere einzelne Webhook wurde auf einen Endpunkt migriert |
2026-11-01 | { id, type, apiVersion, createdAt, tenantId, projectId, roomId?, data }, die Standardeinstellung für neue Endpunkte |
Ereignis data wächst additiv wie die API. Um einen Empfänger auf eine neuere Payload-Version umzustellen, fügen Sie einen zweiten Endpunkt mit der neuen Version hinzu, passen Sie Ihre Verarbeitung entsprechend an und entfernen Sie anschließend den alten Endpunkt.
Vertragsversion für SDKs
Abschnitt betitelt „Vertragsversion für SDKs“GET /v1/capabilities Berichte contractVersion, die sich jedes Mal ändert, wenn der Kundenvertrag um etwas erweitert wird. SDKs kann damit neuere Funktionen aktivieren, jedoch nur dort, wo die diese APIbereits unterstützt.
OpenAPI-Beschreibung
Abschnitt betitelt „OpenAPI-Beschreibung“Die Kundenrouten von RTC werden in OpenAPI 3.1 beschrieben, generiert aus den Schemas, mit denen die API Anfragen APIvalidiert, und bei jeder Änderung anhand des Codes überprüft. Die Datei befindet sich docs/openapi/v1.yaml im RTC- Plattform-Repository. Kontakt CHAMPREP an um die aktuelle Datei für die Client-Generierung zu erhalten; diese Referenz und die
API Referenz bleiben in der öffentlichen Dokumentation erhalten.