sipRefer

View as MarkdownOpen in Claude

Send a SIP REFER message to transfer the call in a SIP environment. This is used for attended or blind transfers within SIP-based phone systems and PBX deployments.

For standard phone-number or SIP-address transfers, use connect() instead. Use sipRefer() when the transfer must be performed via the SIP REFER mechanism (e.g., transferring to a PBX extension).

Parameters

toUri
stringRequired

SIP URI to send the REFER to (e.g., "sip:1001@pbx.example.com").

Returns

FunctionResultthis, for chaining.

Example

1import { FunctionResult } from '@signalwire/sdk';
2
3const result = new FunctionResult()
4 .sipRefer('sip:support@example.com');