connect | SignalWire

Transfer or connect the call to another destination. Generates a SWML connect verb under the hood.

When final is true (the default), the call permanently leaves the agent. When final is false, the call returns to the agent if the far end hangs up first.

Parameters

destination

stringRequired

Where to connect the call. Accepts a phone number in E.164 format (e.g., "+15551234567") or a SIP address (e.g., "support@company.com").

final

booleanDefaults to true

Whether this is a permanent transfer.

true — call exits the agent completely (terminal action)
false — call returns to the agent when the far end hangs up

fromAddr

string | undefinedDefaults to undefined

Caller ID override. Phone number or SIP address to show as the caller. When undefined, the current call’s originating address is used.

Returns

FunctionResult — this, for chaining.

Examples

Permanent Transfer

1 import { FunctionResult } from '@signalwire/sdk';
2 
3 const result = new FunctionResult('Transferring you to sales.')
4   .connect('+15551234567');

Temporary Transfer

1 import { FunctionResult } from '@signalwire/sdk';
2 
3 const result = new FunctionResult('Connecting you to a specialist.')
4   .connect('+15551234567', false);

Custom Caller ID

1 import { FunctionResult } from '@signalwire/sdk';
2 
3 const result = new FunctionResult('Transferring now.')
4   .connect('support@company.com', true, '+15559876543');