Changelog
Documentation center version, interface versions, changes and compatibility windows for breaking changes.
This page records version changes of the documentation center and the public interfaces, including the impact and migration window of each change.
Documentation center
| Version | Date | Change |
|---|---|---|
| 1.2.0 | 2026-10-26 | Added per-caller rate limiting (429 rate_limited + Retry-After); the SDK reports packetLossRate, shown in the quality overview and call investigation; recording object storage verifies uploaded files and supports read-back; API error sdkCode unified to Agora's negative convention |
| 1.1.0 | 2026-10-26 | /v1/tokens/verify is now a diagnostic response (200 + valid:false/rejection/sdkCode); time:0 only kicks the connection; maxIdleTime now means idle timeout; unknown collaborators return 404 collaborator_not_found; error codes unified on Agora's negative sdkCode with code/key/retryable; Analytics gained alarmSemantics |
| 1.0.0 | 2026-10-26 | First release: quickstart, core concepts, channel management, tokens, cloud recording, bypass streaming, Analytics, callbacks, REST API reference, SDK guides, error codes, FAQ and changelog; Chinese and English; static site with built-in search and navigation |
Public interface versions
| Interface | Version | Notes |
|---|---|---|
| IM RTC Provider | 1.0.0 | The only IM ↔ RTC boundary: getRTCTokenInfo / getUserIdsWithRTCUids, each configurable and falling back independently |
| REST API (OpenAPI 3.1) | 1.0.0 | Control-plane REST interface; the single source of the REST API reference |
| Error codes | 1.0.0 | code / HTTP / sdkCode / retryable; the single source of the error-code page |
| Callbacks | 1.0.0 | Event envelope, event codes 101–203, signature header and retry schedule |
| Analytics metrics | 1.0.0 | Metric definitions, thresholds, alarm tiers, real-time window and refresh cadence |
| Domain model | 1.0.0 | Resource model, enums and invariants |
The token format (nrt1.<payload>.<hmac>) is ni-meet's own implementation. It is semantically aligned with Agora AccessToken2 but does not claim byte compatibility, so a token format change is not a breaking change to the public interface, though every media plane must upgrade in step.
Compatibility policy
- IM RTC Provider: a breaking change ships a new version, dual-published for 90 days; within 1.x only optional fields are added, and they are recorded on this page.
- REST API / SDK: adding an optional field is compatible; removing a field, changing semantics or adding a required field is breaking and is announced ahead of time while the old behaviour is kept.
- Documentation center: page URLs stay stable once published; when a page is split, the old path keeps a redirect.
- SDK: method, event and error names are public API, so renaming one counts as a breaking change.
How versions are recorded
Every public interface change appends an entry to this page with the change, its impact and how to migrate. For detailed compatibility windows see Versions and compatibility.