sipgate AI Flow icon

sipgate AI Flow

Control sipgate AI Flow calls with various actions

Actions8

Play Audio

AI-generated

Summary

Play pre-recorded audio in a sipgate AI Flow call session using either a base64 encoded WAV string or binary data from a previous node, with optional barge-in controls.

Inputs

  • Session ID (required) — The unique identifier for the AI Flow call session to play the audio in.
  • Audio Source (required) — Select the source format of the audio data to be played: either 'Base64 String' or 'Binary Data'.
  • Audio (Base64) (required) — Provide the audio as a base64 encoded WAV string (16kHz, mono, 16-bit PCM) when 'Base64 String' is selected as Audio Source.
  • Binary Property (required) — Specify the name of the binary property containing the audio file when 'Binary Data' is selected as Audio Source.
  • Barge-In Options — Configure how and when the playback can be interrupted by speech input or manual API commands, including detection strategy, minimum characters, and delay in milliseconds.

Output shape

a single JSON object representing the audio playback action details, paired with the input item index

The node returns an action JSON object describing the playback command to the AI Flow session, including session ID, audio data, and optional barge-in settings. No audio content or binary output is emitted by the node directly.

Examples

Example 1: Play audio from a base64 encoded WAV string with default barge-in settings.

Set 'Session ID' to the current call's session, choose 'Base64 String' for Audio Source, and input the base64 string into 'Audio (Base64)'. Optionally adjust barge-in options.

Example 2: Play audio from binary data produced by a previous node with manual barge-in disabled.

Set 'Session ID', select 'Binary Data' as Audio Source, specify the binary property name containing the WAV audio, and configure barge-in with strategy set to 'none'.

Links

Discussion