1. Tasks
  2. Voice Commentary

Tasks

Voice Commentary

Gives the assistant on a live voice call something to say aloud. Useful for answering the caller with information from the stub, such as the result of a lookup or a booking.

The assistant says the content aloud, close to word for word, in its own voice. Commentary is the usual way to answer a request the assistant handed to the stub.

The same command is available as a commentary voice notification. The call is started with Start Voice Chat.

Basic usage

loading...

Parameters

content
required
string

What the assistant should say.

Long content is split into several parts automatically.


delegation_id
optional
string

Ties the content to a request the assistant handed to the stub. Use the delegation_id from the _update_from_voice that asked for it, eg {{stub.data._incoming_voice_data.delegation_id}}.

Without it, or when the id is empty or unknown, the content is context for the whole call.


voice_session_uuid
optional
string

The voice call to send the command to. It must belong to this stub.

Default: the stub's live voice call

Result

The task returns as soon as the content is sent. It doesn't wait for the assistant to use it.

loading...

Properties

payload.voice_session_uuid
string

The voice call the content was sent to.


payload.event_ids
string[]

One id per part the content was sent in.

Errors

message Meaning
content is required content is missing or empty
no_active_voice_session The stub has no live voice call, or voice_session_uuid doesn't belong to this stub
voice_session_not_active The call is already ending

Examples

Answer a delegation

The assistant handed a question to the stub, and a GPT Chat Task answered it. Send the answer back with the delegation_id:

loading...