hold

Put the call on hold. The caller hears hold music until the hold is released or the timeout expires.

Parameters

numberDefaults to 300

Maximum hold duration in seconds. Clamped to the range 0—900 (15 minutes max).

FunctionResult — this, for chaining.

import { FunctionResult } from '@signalwire/sdk';
// Default 300-second hold
const result = new FunctionResult('Please hold.')
  .hold();