API Reference

Ringnity OpenAPI and Scalar Reference

Ringnity REST APIs are defined in one OpenAPI contract and rendered with Scalar. SDK guides explain product flows, while this reference is the source of truth for endpoint shapes, request fields, response fields, auth schemes, and generated clients.

Scalar API Reference

Interactive REST API reference generated from the Ringnity OpenAPI contract.

Open

OpenAPI JSON

Machine-readable contract for generators, testing tools, and customer platform automation.

Open

OpenAPI YAML

Human-friendly contract file for review, versioning, and SDK generation pipelines.

Open

REST belongs in OpenAPI

Use Scalar when you need exact request and response details. Use SDK guides when you want an implementation walkthrough for CRM web apps, public websites, mobile apps, or customer backends.

REST area	What it covers
Login with Ringnity	OAuth2/OIDC identity login for WordPress, CMS, CRM, mobile apps, and partner portals.
Visitor bootstrap	Load public tenant settings, allowed services, launcher configuration, and runtime session data.
Server token exchange	Let a customer backend create short-lived tokens without exposing secret keys to web or mobile apps.
Contacts and context	Attach customer identity, CRM ids, tickets, order ids, non-secret metadata, and delete stale tenant contacts through Server API.
Agent workspace operations	Read conversations, reply, mark read, close, assign or transfer conversations, and remove attachment messages from CRM workspaces.
Admin readiness and AI knowledge	Check tenant readiness and manage AI knowledge ingestion, reindex, and deletion through scoped Admin SDK operations.
Reports foundation	Expose analytics, timeseries, and JSON or CSV report exports through stable REST resources.
Webhooks	Receive Ringnity events on the customer backend and verify signatures server-side.

Streaming belongs in SDKs

OpenAPI documents HTTP endpoints. Ringnity SDKs also need realtime callbacks for chat, AI, internet calls, presence, and live reports. Those events are documented as an SDK contract, then wrapped behind simple SDK object methods.

AI chat streaming: Token-by-token response updates, final answer events, and human handoff callbacks.
Chat activity: New message, typing, delivery state, conversation state, assignment, and close events.
Internet call lifecycle: Incoming request, ringing, answered, muted, held, ended, failed, and recording status callbacks.
Agent presence: Available, busy, offline, queue state, and routing updates for CRM workspaces.
Live reports: Dashboard-friendly updates for active conversations, queues, agents, and service health.

Open realtime contract

Common customer backend flow

The customer backend stores the Ringnity Server API key, calls Ringnity from a trusted server, and returns only short-lived runtime tokens to browser or mobile clients.

Customer app -> Customer backend -> Ringnity Server API
Customer backend -> short-lived runtime token -> Customer app
Customer app -> Ringnity SDK -> chat, AI, internet call, and reports

SDK overview

See which SDK belongs to website, CRM web, Android, iOS, Flutter, React Native, and customer backend integrations.

Open guide

Mobile SDK guides

Use mobile guides for Managed UI, Headless SDK, permissions, ringtone, push tokens, video views, and app lifecycle.

Open mobile docs

Downloads and packages

Check available SDK packages, planned SDK downloads, and OpenAPI contract links.

Open downloads

Login with Ringnity

Use OAuth2/OIDC when WordPress, CMS, CRM, or a partner app needs Ringnity identity login.

Open identity docs

Turn Your Website Into a Real-Time Call Center

Let customers call your team directly from your website, no phone numbers and no apps required. Just add one <script>.

Talk to Sales Register Now