Interface: PlayAudioActionParams

Defined in: packages/sdk/src/types/event-types.ts:326

Parameters for the audio:play event-rule action.

Plays a pre-recorded workspace audio file on the current voice call. Composes with task:execute rules + CEL conditions on call.answered_by to deliver guaranteed-delivery disclosure recordings without the LLM in the loop. See the backend handler at lib/rules/actions/builtin/play_audio.py.

Properties

allowInterrupt?

optional allowInterrupt: boolean

Defined in: packages/sdk/src/types/event-types.ts:334

When false, the clip plays end-to-end ignoring barge-in. Pair with hangUpOnAudioEnd: true for compliance recordings that must not be interrupted by speech. Defaults to true.

---

clipFileUuid

clipFileUuid: string

Defined in: packages/sdk/src/types/event-types.ts:328

UUID of the workspace File row to play. Required.

---

hangUpOnAudioEnd?

optional hangUpOnAudioEnd: boolean

Defined in: packages/sdk/src/types/event-types.ts:339

When true, the call hangs up immediately after the clip finishes streaming — no further LLM turns. Defaults to false.

---

volume?

optional volume: number

Defined in: packages/sdk/src/types/event-types.ts:347

Playback volume as a percent in [0, 100]. 80 is the unity baseline — no gain adjustment is applied. Higher values boost, lower values attenuate. Clipped at the int16 ceiling so a 100% setting on already-hot source material won't introduce distortion beyond the source's own. Defaults to 80.