createWebRTCClient - Cognigy Documentation

Creates and returns a new WebRTCClient instance. This is the main entry point of the SDK.

Signature

import { createWebRTCClient } from '@cognigy/click-to-call-sdk';

const client = await createWebRTCClient(config: WebRTCClientConfig);

Parameters

Parameter	Type	Description	Required
`config`	`WebRTCClientConfig`	Configuration object for the client.	Yes

Returns

Promise<WebRTCClient> — a configured client instance ready to connect and make calls.

Example

import { createWebRTCClient } from '@cognigy/click-to-call-sdk';

const client = await createWebRTCClient({
  endpointUrl: 'https://your-api.com/voice-connect-config',
  userId: 'user-123',
});

Errors

The function rejects with one of the following errors:

Error	Cause
`endpointUrl is required`	The configuration doesn’t contain an `endpointUrl`.
`WebRTC is not supported in this environment`	The environment isn’t a browser, or the browser doesn’t support the required WebRTC APIs.

The function doesn’t connect to the SIP server and doesn’t send any network request. The SDK fetches the configuration when you call connect().

More Information

Last modified on October 23, 2026