API Reference - Cognigy Documentation

Cognigy Click To Call SDK

This section provides a detailed reference for all functions, methods, configuration options, and types available in the Cognigy Click To Call SDK.

Factory Functions

Function	Description
createWebRTCClient	Creates and returns a new `WebRTCClient` instance.
checkWebRTCSupport	Checks whether the current browser supports Click To Call.

Connection Methods

Method	Description
connect	Connects to the SIP server and registers the client.
disconnect	Disconnects from the SIP server.
connectAndCall	Connects and starts a call in one operation.

Call Control Methods

Method	Description
startCall	Starts a new voice call.
endCall	Ends the current active call.
mute	Mutes the local microphone.
unmute	Unmutes the local microphone.
sendInfo	Sends an info message during a call.

State Methods

Method	Description
isConnected	Checks if the client is connected and registered.
getCurrentSession	Returns the current active call session.

Event Methods

Method	Description
on	Adds an event listener.
off	Removes an event listener.

Cleanup Methods

Method	Description
destroy	Disconnects, ends calls, and releases all resources.

Types

Type	Description
Types	`WebRTCClientConfig`, `CallSession`, `SessionStatus`, `CallEndInfo`, `WebRTCClientEvents`.

Last modified on April 21, 2026.