connect | SignalWire

Establish a WebSocket connection to SignalWire RELAY and authenticate. This method connects to wss://<host>, sends a signalwire.connect authentication request, subscribes to the configured contexts, and starts the internal ping loop.

For most use cases, prefer run() which calls connect() internally and adds automatic reconnection. Use connect() directly only when you need manual control over the connection lifecycle.

Parameters

None.

Returns

Promise<void>

Example

1 import { RelayClient } from '@signalwire/sdk';
2 
3 const client = new RelayClient({
4   project: process.env.SIGNALWIRE_PROJECT_ID!,
5   token: process.env.SIGNALWIRE_API_TOKEN!,
6   contexts: ['default']
7 });
8 
9 await client.connect();
10 // Connected and authenticated -- do work here
11 const call = await client.dial(
12   [[{ type: 'phone', params: { to_number: '+15559876543', from_number: '+15551234567' } }]],
13 );
14 await call.hangup();
15 await client.disconnect();

1	import { RelayClient } from '@signalwire/sdk';
2
3	const client = new RelayClient({
4	project: process.env.SIGNALWIRE_PROJECT_ID!,
5	token: process.env.SIGNALWIRE_API_TOKEN!,
6	contexts: ['default']
7	});
8
9	await client.connect();
10	// Connected and authenticated -- do work here
11	const call = await client.dial(
12	[[{ type: 'phone', params: { to_number: '+15559876543', from_number: '+15551234567' } }]],
13	);
14	await call.hangup();
15	await client.disconnect();