> ## Documentation Index
> Fetch the complete documentation index at: https://docs-classic.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cognigy Click To Call SDK

> Cognigy Click To Call SDK for WebRTC SIP voice calling in web apps and AI integration.

*Cognigy Click To Call SDK* is a JavaScript/TypeScript SDK for adding SIP-based voice calling to web applications using WebRTC. Built on [JsSIP](https://jssip.net/), the SDK provides APIs to manage voice sessions, SIP signaling, audio streams, and transcription.

The SDK is for developers who build custom voice interfaces on top of the Cognigy platform and Cognigy Voice Gateway.

<video muted width="500" height="800" controls autoPlay title="Cognigy Click To Call SDK demo showing call initiation and handling" aria-label="Cognigy Click To Call SDK demo showing call initiation and handling">
  <source src="https://2761836.fs1.hubspotusercontent-na1.net/hubfs/2761836/WebRTC%20Demo%202.mp4" />
</video>

## What's in This SDK?

### SDK Purpose

The Click To Call SDK helps developers:

* Set up real-time voice calls between a user's browser and Cognigy Voice Gateway with SIP signaling and the WebRTC API.
* Manage the full call lifecycle through a promise-based API.
* Handle remote audio playback automatically.
* Receive real-time transcription events during calls, with automatic separation from regular info messages.

### Requirements

| Requirement | Details |
| - | - |
| Language | JavaScript or TypeScript. The SDK works with any framework, including React, Angular, Vue, or vanilla JS. |
| Node.js | 16 or later to install and build your application. The SDK itself runs only in browsers. |
| Package manager | npm |
| Browsers | Modern web and mobile browsers. For more information, refer to [Supported Browsers](https://docs-classic.cognigy.com/click-to-call/sdk/supported-browsers.md). |
| Network | HTTPS or `localhost`. WebSocket and UDP traffic must be allowed. |
| Backend | A Cognigy Flow with a configured Voice Gateway Endpoint. |

### Use Cases

* Build multimodal browser-based voice interfaces that connect to Cognigy AI Agents.
* Embed click-to-call functionality into web applications or customer portals.
* Display real-time transcription of voice conversations in your UI.
* Integrate voice calling into existing React, Angular, Vue, or vanilla JS applications without framework lock-in.

## Key Features

| Feature | Description |
| - | - |
| Custom Audio Handling | The automatic audio playback uses an internal `Audio` element. For advanced use cases, enable `captureAudio: true` in the client config to receive the raw `MediaStream`. The `audioEnded` event signals when playback stops. See [Custom Audio](https://docs-classic.cognigy.com/click-to-call/sdk/custom-audio.md). |
| Full Call Control | The complete call management includes start, end, mute, unmute, DTMF, and info messages as async methods. See [API Reference](https://docs-classic.cognigy.com/click-to-call/sdk/api-reference/overview). |
| Multimodality | The multimodal interactions combine voice, text, and structured data in real time. Use the `sendInfo` method to send text and optional structured data during calls. See [API Reference: sendInfo](https://docs-classic.cognigy.com/click-to-call/sdk/api-reference/send-info.md). |
| Event-Driven Architecture | The event system provides 18 events covering connection state, call state, audio, transcription, and errors. See [Event Reference](https://docs-classic.cognigy.com/click-to-call/sdk/event-reference/overview). |
| Real-Time Transcription | The SDK receives transcription events during calls and filters them from regular info messages automatically. See [Event Reference: transcription](https://docs-classic.cognigy.com/click-to-call/sdk/event-reference/transcription.md). |

## Changelog Reference

The latest SDK version is available on npm as `@cognigy/click-to-call-sdk`. For updates and fixes, refer to the [Cognigy Click To Call SDK GitHub repository](https://github.com/Cognigy/click-to-call-sdk).

## License

The Cognigy Click To Call SDK is licensed under the MIT License.

## What's Next?

* [Install the SDK, create a client, and make your first voice call](https://docs-classic.cognigy.com/click-to-call/sdk/getting-started.md)
* [Learn how the SDK authenticates](https://docs-classic.cognigy.com/click-to-call/sdk/initialization.md)
* [Explore all methods, configuration options, and types](https://docs-classic.cognigy.com/click-to-call/sdk/api-reference/overview)
* [Discover events with callback signatures and examples](https://docs-classic.cognigy.com/click-to-call/sdk/event-reference/overview)
* [Transport encryption, credential handling, and best practices](https://docs-classic.cognigy.com/click-to-call/sdk/security.md)
* [Find solutions for common connection, call, and browser issues](https://docs-classic.cognigy.com/click-to-call/sdk/troubleshooting.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.