transfer

View as MarkdownOpen in Claude
1transfer(options): Promise<void>

Blind-transfers the remote party to another destination. The local side drops out of the call once the transfer is accepted by the server; the remote party continues at the new destination.

Use a directory URI for fabric-internal targets (e.g. /public/support), a SIP URI for SIP-routed transfers, or any other dialable string the server understands. The request is rejected if the local participant lacks the transfer capability — inspect call.capabilities$ first.

Parameters

options
TransferOptionsRequired

Transfer configuration. The required destination field is the dialable target — a fabric URI, SIP URI, or any string the server’s dial plan understands. See TransferOptions.

Returns

Promise<void> — resolves when the server has accepted the transfer request. The local call will subsequently transition to disconnected.

Examples

Transfer to a queue

1await call.transfer({ destination: '/public/support-queue' });

Transfer to a SIP URI

1await call.transfer({ destination: 'sip:agent@example.com' });

Transfer with error handling

1try {
2 await call.transfer({ destination: '/public/support-queue' });
3} catch (err) {
4 console.error('transfer rejected:', err);
5}

See

  • status$ to observe the local call’s progression after transfer.
  • capabilities$ to check whether transfer is currently permitted.