hold

View as MarkdownOpen in Claude

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

Parameters

timeout
numberDefaults to 300

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

Returns

FunctionResultthis, for chaining.

Example

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