SignalWire DocsFunctionResult is the return type for all SWAIG tool functions. It wraps a response
message (text for the AI to speak) and an ordered list of actions (transfers, SMS,
data updates, context switches, and more). Every method returns this, so you can
chain calls into a single fluent expression.
Returned from functions defined with defineTool() on
AgentBase.
FunctionResult builds the response payload for a SWAIG function. See the SWML SWAIG functions reference for the full response format specification.
Text the AI speaks back to the caller after the function executes.
Ordered list of action objects to execute. Actions run sequentially in the order they were added.
When true, the AI speaks the response and takes one more conversational turn
with the user before executing actions. When false (default), actions execute
immediately after the response.
Every method on FunctionResult returns this, so you build complex responses
in a single expression. Actions execute in the order they are added.
Terminal actions like connect(destination, true) and hangup() end the call flow.
Place them last in the chain so that preceding actions (data updates, SMS, etc.)
have a chance to execute.
Set or replace the response text on a FunctionResult.
Enable or disable post-processing on a FunctionResult.
Append a raw action to the FunctionResult action list.
Append multiple raw actions to the FunctionResult action list.
Serialize a FunctionResult to the SWAIG response format.
Transfer or connect the call to another destination.
End the call immediately.
Put the call on hold with an optional timeout.
Transfer the call to a SWML endpoint with a return message.
Make the AI agent speak specific text immediately.
Control how the agent pauses and waits for user input.
Stop the agent execution immediately.
Play an audio or video file in the background during a call.
Stop the currently playing background audio file.
Start recording the call in the background.
Stop an active background call recording.
Stream call audio to an external endpoint via WebSocket or RTP.
Stop an active media tap stream.
Set or update key-value pairs in the global session data.
Remove one or more keys from the global session data.
Set function-scoped metadata key-value pairs.
Remove one or more keys from the current function’s metadata store.
Transition to a different step within the current conversation context.
Switch to a different conversation context.
Perform an advanced context switch with prompt replacement and history control.
Send a custom user event through SWML for real-time UI updates.
Inject text as simulated user speech input.
Enable or disable specific SWAIG functions at runtime.
Allow SWAIG function calls when a speaker timeout occurs.
Add speech recognition hints dynamically during a call.
Remove all dynamically added speech recognition hints.
Adjust the end-of-speech silence timeout for speech recognition.
Adjust the speech event timeout for noisy environments.
Update AI runtime settings dynamically during a call.
Send full data to the LLM for the current turn only.
Control how this function call appears in the AI’s conversation history.
Collect and process a credit card payment during a call.
Build a payment prompt object for use with pay().
Build a single action entry for a payment prompt.
Build a parameter entry for the pay() method.
Join a SignalWire room for multi-party communication.
Join an ad-hoc audio conference with extensive configuration options.