Calling overview

The UniApp SDK provides signaling APIs to initiate, accept, reject, cancel, and hang up audio and video calls. It also enables querying active group rooms, retrieving room access credentials, and restoring pending call invitations.

The SDK manages signaling metadata and room authentication credentials; it does not capture camera frames, process microphone audio, or render call UI components. Pass the returned roomID, token, and liveURL to your chosen real-time audio/video (RTC) engine, and manage hardware permissions, media tracks, network adaptation, and UI rendering within your application layer.

Calling lifecycle

1. Initiate a one-on-one call using Start a single call, or launch a conference call using Start a group call.
2. When invited clients receive incoming signaling events, invoke Restore pending call invitations to reconstruct pending invitation state, then accept or reject.
3. The callee joins by calling Accept a call and passing the returned room credentials to their RTC engine.
4. Update UI displays based on signaling events; RTC media tracks are maintained directly by the media engine.
5. The caller can abort an unanswered invitation using Cancel a call invitation, while any active participant can terminate their session using Hang up a call.

Core data structures

Promise resolution, event delivery, and state re-queries represent three distinct phases:

• A resolved Promise confirms that the signaling request reached OpenIMServer.
• Real-time signaling events inform other devices of the transition.
• Re-query APIs allow the app to synchronize state after returning to the foreground or reconnecting.

Calling events deliver raw payload strings without exposed internal schemas. Use events as invalidation signals to re-query strongly typed call data through the retrieval APIs. Identify call sessions using roomID, and track individual participants by combining roomID with user IDs. For event handling, see Handle call events.

Quick reference