Control de versionesAPI de RTC
El /v1 promesa
Sección titulada «El /v1 promesa»Todo lo que se incluye en /v1 Cambios solo de forma aditiva. RTC podría añadir:
- nuevas rutas, campos de solicitud opcionales y parámetros de consulta;
- nuevos campos de respuesta, códigos de error, tipos de eventos de webhook y valores de enumeración;
- nuevos encabezados de respuesta.
Desarrolle clientes que ignoren los campos desconocidos y traten un código de error desconocido como el código genérico de su estado HTTP. RTC no elimina ni renombra ningún campo, ni cambia su tipo o significado, ni convierte una entrada opcional en obligatoria, ni reutiliza un código de error bajo /v1.
Un cambio incompatible se implementa como una nueva rama principal, /v2. A continuación, ambas versiones se ejecutan en paralelo durante al menos 12 meses antes /v1 ha quedado obsoleta, tal y como se indica en este sitio web.
Fije las formas de respuesta con RTC-Version
Sección titulada «Fije las formas de respuesta con RTC-Version»Algunas mejoras modifican la estructura de una respuesta sin alterar su significado, como por ejemplo la sobre de error estructurado. Se activan de forma opcional por solicitud con un encabezado de versión fechado:
RTC-Version: 2026-11-01| Versión | Cambios |
|---|---|
| ninguna | Formas originales. Los errores son { "error": "<message>", "code"? }. |
2026-11-01 | Los errores utilizan el sobre { "error": { code, message, details?, requestId, retryable, docUrl } }. |
RTC aplica la versión más reciente que no sea posterior a la fecha de su envío y la refleja en el RTC-Version Encabezado de respuesta. Una fecha anterior a la de la primera versión conserva las estructuras originales. Fije la versión con la que se escribió su código y cámbiela deliberadamente cuando realice una actualización.
Fije las cargas útiles de los webhooks con apiVersion
Sección titulada «Fije las cargas útiles de los webhooks con apiVersion»Cada Punto final de webhook tiene un apiVersion que corrige la envoltura que recibe, independientemente de los encabezados de la solicitud:
apiVersion | Sobre |
|---|---|
legacy | { id, type, createdAt, projectId, data }, el antiguo webhook único se ha migrado a un punto final |
2026-11-01 | { id, type, apiVersion, createdAt, tenantId, projectId, roomId?, data }, el valor predeterminado para los nuevos puntos de conexión |
Evento data crece de forma aditiva, al igual que el API. Para migrar un receptor a una versión más reciente de la carga útil, añada un segundo punto final con la nueva versión, modifique su procesamiento y, a continuación, elimine el punto final antiguo.
Versión del contrato para SDKs
Sección titulada «Versión del contrato para SDKs»GET /v1/capabilities informes contractVersion, que cambia cada vez que el contrato de cliente incorpora alguna novedad. SDKs puede utilizarlo para habilitar nuevas funciones solo en los casos en que la API ya las admita.
Descripción de OpenAPI
Sección titulada «Descripción de OpenAPI»Las rutas de los clientes de RTC se describen en OpenAPI 3.1, generado a partir de los esquemas con los que la API APIvalida las solicitudes y que se comparan con el código cada vez que se produce un cambio. El archivo se encuentra docs/openapi/v1.yaml en el repositorio de la plataforma RTC . Contacto CHAMPREP a recibir el archivo actual para la generación del cliente; esta referencia y el
API referencia sigue siendo la documentación pública.