> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# hold

> Put the call on hold with an optional timeout.

[functionresult]: /docs/server-sdks/reference/typescript/agents/function-result

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

## **Parameters**

**`timeout`** `number` — default: 300

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

---

## **Returns**

[`FunctionResult`][functionresult] -- `this`, for chaining.

## **Example**

```typescript {5}
import { FunctionResult } from '@signalwire/sdk';

// Default 300-second hold
const result = new FunctionResult('Please hold.')
  .hold();
```

> Put the call on hold with an optional timeout.