Mobile SDK Docs

Build Ringnity into mobile apps

Mobile SDK docs use human guides for implementation and Scalar for exact REST contracts. Choose Easy / Managed UI when Ringnity should draw the support screen, or Headless SDK when your app owns the full experience.

Easy / Managed UI

Ringnity draws the mobile support screen. Use this for the fastest customer install, pilots, and teams that do not want to design chat and call screens.

// Android: RingnityAndroidManagedView
// iOS: RingnityView
// Flutter: RingnityWidget
// React Native: <RingnityWidget />

Headless SDK

Your app draws the UI. Ringnity provides product objects for token runtime, chat, AI, audio/video calls, push tokens, ringtone, reports, and diagnostics.

ringnity.chat.createConversation(...)
ringnity.ai.streamChat(...)
ringnity.calls.startVideo(...)
ringnity.devices.registerPushToken(...)

Choose a mobile SDK

What the mobile guides cover

Chat

Create conversations, send messages, subscribe to updates, and embed support threads into mobile screens.

AI chat

Send AI prompts and render streaming answers with platform-friendly callbacks, streams, flows, or async sequences.

Audio calls

Start internet audio calls, manage mute/end state, and keep native audio setup behind SDK adapters.

Video calls

Use default Managed UI video surfaces or inject custom local and remote video views in Headless screens.

Push and ringtone

Register FCM/APNs tokens and configure foreground ringtone behavior without exposing secret Server API keys.

Secure runtime

Mobile apps receive short-lived runtime tokens from the customer backend. Server API keys stay server-side.

SDK guides

Use these pages for install steps, permissions, Managed UI, Headless SDK, ringtone, push tokens, video renderers, and copy-paste examples.

Open implementation guide

Scalar API reference

Use Scalar when you need exact REST request fields, response shapes, auth schemes, status codes, and generated client details.

Open Scalar reference

Realtime contract

Use realtime docs for chat message events, AI streaming events, call state, presence, and live reporting behavior.

Read event model

Recommended customer rollout

  1. Create the customer backend token endpoint first.
  2. Start with Easy / Managed UI for the first live pilot.
  3. Move to Headless SDK only when the customer wants custom product screens.
  4. Use Scalar for endpoint detail and the mobile guide for app implementation.
  5. Run device QA for microphone, camera, ringtone, push token, foreground/background behavior, and video rendering.

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>.