Standalone Calling - CometChat Docs

Quick Reference for AI Agents & Developers

Auth token: Obtain via CometChat REST API (no Chat SDK required)
Generate call token: CometChatCalls.generateToken(authToken:sessionID:onSuccess:onError:)
Start session: CometChatCalls.startSession(callToken:callSettings:onSuccess:onError:)
Use case: Apps needing calling without full chat infrastructure
Related: Calling Setup · Call Session · Calling Overview

Overview

This section demonstrates how to implement calling functionality using only the CometChat Calls SDK, without requiring the Chat SDK. This is ideal for applications that need video/audio calling capabilities without the full chat infrastructure.

Before you begin, ensure you have completed the Calls SDK setup.

User Authentication

To start a call session, you need a user auth token. Since this implementation doesn’t use the Chat SDK, you’ll need to obtain the auth token via the CometChat REST API.

To understand user authentication in CometChat, see the User Auth documentation.

Option 1: Create Auth Token (REST API)

Creates a new auth token for a user. Endpoint:

POST https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/auth_tokens

Request Headers:

Property	Type	Value
apiKey	String	YOUR_API_KEY
Content-Type	String	application/json

Success Response:

Property	Type	Description
data.uid	String	User’s unique identifier
data.authToken	String	The auth token for API calls
data.createdAt	Double	Unix timestamp when created

Option 2: Get Auth Token (REST API)

Retrieves an existing auth token for a user. Endpoint:

GET https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/auth_tokens

Request Headers:

Property	Type	Value
apiKey	String	YOUR_API_KEY

Option 3: Dashboard (Testing/POC)

For testing or POC purposes:

Go to CometChat Dashboard
Navigate to Users & Groups → Users
Select a user
Click + Create Auth Token
Copy the generated token

Store the auth token securely in your application for use when generating call tokens.

Generate Call Token

A call token is required for secure access to a call session. Each token is unique to a specific session and user combination, ensuring that only authorized users can join the call. Use the generateToken() method to create a call token:

Swift

var callToken: GenerateToken?

let sessionId = "UNIQUE_SESSION_ID" // Generate a unique session ID
let userAuthToken = "USER_AUTH_TOKEN" // Obtained from REST API

CometChatCalls.generateToken(authToken: userAuthToken as NSString, sessionID: sessionId) { token in
    self.callToken = token
} onError: { error in
    print("Token generation failed: \(String(describing: error?.errorDescription))")
}

Request Parameters:

Property	Type	Value
authToken	NSString	”user_auth_token_from_rest_api”
sessionID	NSString	”unique_session_id_123”

Success Response:

Property	Type	Value
token	String	”eyJhbGciOiJIUzI1NiIsInR5cCI6…”

Error Response (CometChatCallException):

Property	Type	Description
errorCode	String	Error code identifier
errorDescription	String	Error description message

Start Call Session

Use the startSession() method to join a call session. This method requires a call token and a CallSettings object.

Swift

guard let callToken = self.callToken else { return }

let callSettings = CometChatCalls.CallSettingsBuilder
    .setDefaultLayout(true)
    .setIsAudioOnly(false)
    .setDelegate(self)
    .build()

CometChatCalls.startSession(callToken: callToken, callSetting: callSettings, view: callView) { success in
    print("Call session started successfully")
} onError: { error in
    print("Start session failed: \(String(describing: error?.errorDescription))")
}

Request Parameters:

Property	Type	Value
callToken	String	”eyJhbGciOiJIUzI1NiIsInR5cCI6…“
callSetting	CallSettings	Configured settings object
view	UIView	View to render call UI

Success Response:

Property	Type	Value
success	String/Bool	Success confirmation

Error Response (CometChatCallException):

Property	Type	Description
errorCode	String	Error code identifier
errorDescription	String	Error description message

Call Settings Builder

Configure the call experience using the following CallSettingsBuilder methods:

Property	Type	Default	Description
defaultLayout	Bool	true	Enable default call UI
isAudioOnly	Bool	false	Audio-only or audio+video
isSingleMode	Bool	false	Single participant mode
showSwitchToVideo	Bool	false	Show switch to video button
enableVideoTileClick	Bool	true	Enable video tile clicks
enableDraggableTile	Bool	true	Enable draggable tiles
endCallButtonDisable	Bool	false	Hide end call button
showRecordingButton	Bool	false	Show recording button
switchCameraDisable	Bool	false	Hide switch camera button
muteAudioDisable	Bool	false	Hide mute audio button
pauseVideoDisable	Bool	false	Hide pause video button
audioModeDisable	Bool	false	Hide audio mode button
startAudioMuted	Bool	false	Start with mic muted
startVideoMuted	Bool	false	Start with camera off
mode	DisplayModes	.default	.default/.single/.spotlight
avatarMode	AvatarMode	.circle	.circle/.square/.fullscreen
defaultAudioMode	AudioMode	SPEAKER	SPEAKER/EARPIECE/BLUETOOTH
idleTimeoutPeriod	Int	180	Idle timeout in seconds
delegate	CallsEventsDelegate	nil	Event delegate

Call Listeners

The CallsEventsDelegate protocol provides real-time callbacks for call session events.

Swift

extension ViewController: CallsEventsDelegate {
    
    func onCallEnded() {
        // Call ended, close the calling screen
    }
    
    func onSessionTimeout() {
        // Session timed out due to inactivity
    }
    
    func onCallEndButtonPressed() {
        // User pressed end call button
        CometChatCalls.endSession()
        // Close the calling screen
    }
    
    func onUserJoined(rtcUser: RTCUser) {
        // A participant joined the call
    }
    
    func onUserLeft(rtcUser: RTCUser) {
        // A participant left the call
    }
    
    func onUserListChanged(rtcUsers: [RTCUser]) {
        // Participant list updated
    }
    
    func onAudioModeChanged(mode: [AudioMode]) {
        // Available audio devices changed
    }
    
    func onCallSwitchedToVideo(callSwitchedInfo: CallSwitchRequestInfo) {
        // Call upgraded from audio to video
    }
    
    func onUserMuted(rtcMutedUser: RTCMutedUser) {
        // A participant's mute state changed
    }
    
    func onRecordingToggled(recordingInfo: RTCRecordingInfo) {
        // Recording started or stopped
    }
}

onCallEnded

Invoked when the call session terminates for a 1:1 call. Both participants receive this callback. Payload: None Action: Close the calling screen

onSessionTimeout

Invoked when the call is auto-terminated due to inactivity (default: 180 seconds). v4.1.1+ Payload: None

onCallEndButtonPressed

Invoked when the local user taps the end call button. Payload: None Action: Call CometChatCalls.endSession() and close screen

onUserJoined

Invoked when a remote participant joins the call. Payload (RTCUser):

Property	Type	Description
rtcUser	RTCUser	User object containing participant details

onUserLeft

Invoked when a remote participant leaves the call. Payload (RTCUser):

Property	Type	Description
rtcUser	RTCUser	User object containing participant details

onUserListChanged

Invoked whenever the participant list changes. Payload:

Property	Type	Description
rtcUsers	[RTCUser]	Array of RTCUser objects

onAudioModeChanged

Invoked when available audio devices change. Payload:

Property	Type	Description
mode	[AudioMode]	Array of available modes: SPEAKER, EARPIECE, BLUETOOTH, HEADPHONES

onCallSwitchedToVideo

Invoked when an audio call is upgraded to video. Payload (CallSwitchRequestInfo):

Property	Type	Description
callSwitchedInfo	CallSwitchRequestInfo	Call switch request information

onUserMuted

Invoked when a participant’s mute state changes. Payload (RTCMutedUser):

Property	Type	Description
rtcMutedUser	RTCMutedUser	Muted user information

onRecordingToggled

Invoked when call recording starts or stops. Payload (RTCRecordingInfo):

Property	Type	Description
recordingInfo	RTCRecordingInfo	Recording state information

End Call Session

To end the call session and release all media resources, call CometChatCalls.endSession() in the onCallEndButtonPressed() callback.

Swift

func onCallEndButtonPressed() {
    CometChatCalls.endSession()
    // Close the calling screen
}

When to Call endSession():

Scenario	Action
User taps end call button	Call in `onCallEndButtonPressed()`
Call ended by remote user	Called automatically (`onCallEnded`)
Session timeout	Called automatically (`onSessionTimeout`)

Resources Released:

Resource	Description
Camera	Video capture stopped
Microphone	Audio capture stopped
Network	WebRTC connection closed
UI	Call view can be dismissed

Methods

These methods are available for performing custom actions during an active call session. Use them to build custom UI controls or implement specific behaviors based on your use case.

These methods can only be called when a call session is active.

Switch Camera

Toggles between the front and rear camera during a video call.

Swift
Objective-C

CometChatCalls.switchCamera()

[CometChatCalls switchCamera];

Mute Audio

Controls the local audio stream transmission.

Swift
Objective-C

// Mute audio
CometChatCalls.audioMuted(true)

// Unmute audio
CometChatCalls.audioMuted(false)

// Mute audio
[CometChatCalls audioMuted:YES];

// Unmute audio
[CometChatCalls audioMuted:NO];

Pause Video

Controls the local video stream transmission.

Swift
Objective-C

// Pause video
CometChatCalls.videoPaused(true)

// Resume video
CometChatCalls.videoPaused(false)

// Pause video
[CometChatCalls videoPaused:YES];

// Resume video
[CometChatCalls videoPaused:NO];

Set Audio Mode

Routes the audio output to a specific device.

Swift
Objective-C

CometChatCalls.setAudioMode(AudioMode(mode: "SPEAKER"))

[CometChatCalls setAudioModeWithMode:@"SPEAKER"];

Available Modes:

Mode	Description
SPEAKER	Phone speaker
EARPIECE	Phone earpiece
BLUETOOTH	Bluetooth device
HEADPHONES	Wired headphones

Enter PIP Mode

Enters Picture-in-Picture mode.

Swift
Objective-C

CometChatCalls.enterPIPMode()

[CometChatCalls enterPIPMode];

Exit PIP Mode

Exits Picture-in-Picture mode.

Swift
Objective-C

CometChatCalls.exitPIPMode()

[CometChatCalls exitPIPMode];

Switch To Video Call

Upgrades an ongoing audio call to a video call.

Swift
Objective-C

CometChatCalls.switchToVideoCall()

[CometChatCalls switchToVideoCall];

Start Recording

Starts recording the call session.

Swift
Objective-C

CometChatCalls.startRecording()

[CometChatCalls startRecording];

Stop Recording

Stops an ongoing call recording.

Swift
Objective-C

CometChatCalls.stopRecording()

[CometChatCalls stopRecording];

End Session

Terminates the current call session and releases all media resources.

Swift
Objective-C

CometChatCalls.endSession()

[CometChatCalls endSession];

​Overview

​User Authentication

​Option 1: Create Auth Token (REST API)

​Option 2: Get Auth Token (REST API)

​Option 3: Dashboard (Testing/POC)

​Generate Call Token

​Start Call Session

​Call Settings Builder

​Call Listeners

​onCallEnded

​onSessionTimeout

​onCallEndButtonPressed

​onUserJoined

​onUserLeft

​onUserListChanged

​onAudioModeChanged

​onCallSwitchedToVideo

​onUserMuted

​onRecordingToggled

​End Call Session

​Methods

​Switch Camera

​Mute Audio

​Pause Video

​Set Audio Mode

​Enter PIP Mode

​Exit PIP Mode

​Switch To Video Call

​Start Recording

​Stop Recording

​End Session

Overview

User Authentication

Option 1: Create Auth Token (REST API)

Option 2: Get Auth Token (REST API)

Option 3: Dashboard (Testing/POC)

Generate Call Token

Start Call Session

Call Settings Builder

Call Listeners

onCallEnded

onSessionTimeout

onCallEndButtonPressed

onUserJoined

onUserLeft

onUserListChanged

onAudioModeChanged

onCallSwitchedToVideo

onUserMuted

onRecordingToggled

End Call Session

Methods

Switch Camera

Mute Audio

Pause Video

Set Audio Mode

Enter PIP Mode

Exit PIP Mode

Switch To Video Call

Start Recording

Stop Recording

End Session