95 docs tagged with "SWML"

Inject a message into the conversation.

Start a live transcription session.

Start a live translation session.

Stop a live transcription session.

Stop a live translation session.

Summarize the live transcription.

Summarize the live translation.

Create an AI agent to interact with users.

Learn how to create an AI agent with background audio.

Configure the spoken language of your AI Agent, as well as the TTS engine, voice, and fillers.

Parameters for AI that can customize the AI agent's behavior.

The final set of instructions and configuration settings to send to the agent.

The URL that the user defines to which to send status callbacks and reports.

Establish the set of rules and instructions for the AI agent through a prompt.

Use this object to clarify AI's pronunciation of certain words or expressions.

The SignalWire AI Gateway Interface. Allows you to create user-defined functions that can be executed during the dialogue.

Guides for using ai.SWAIG with SignalWire.

Answer incoming call and set an optional maximum duration.

A guide that shows you how to perform a Call Whisper using SWML.

Execute a sequence of instructions depending on the value of a JavaScript condition.

Dial a SIP URI or phone number.

Custom SIP headers to add to INVITE. Has no effect on calls to phone numbers.

An array of objects that define the steps in the context.

Learn how to create an IVR with SWML.

Learn how to create a voicemail bot using SWML.

An array of objects that define plain string or regex patterns to match against the user's input.

The output object for the SWAIG function.

An array of objects that define external API calls.

The default URL that the user defines to which to send status callbacks and reports.

Start noise reduction.

Execute a specified section or URL as a subroutine, and upon completion, return to the current document.

Learn how to execute SWML from a SWAIG function.

Defines how a SWAIG function should process and respond to the user's input data.

The fillers object for the SWAIG function.

The parameters object for the SWAIG function.

The URL that the user defines to which to send status callbacks and reports.

Fillers that will be played while the AI Agent is running the `get_visual_input` function.

Jumps to a defined label in the current SWML section.

Learn how to handle incomming calls from a remote server using SWML.

Ends the call.

Prerequisites

Learn how to use the goto, execute, and transfer methods in SWML.

Fillers that help break silence between responses and are played asynchronously during the function call.

Get started with SWML (SignalWire Markup Language), a markup and scripting language for quickly writing powerful Relay applications in YAML or JSON documents.

Join a Relay Room Session.

Mark any point of the SWML section with a label.

Transcribe a voice interaction in real-time.

The action to be performed during a live transcription session.

Translate a voice interaction in real-time.

The action to be performed during a live translation session.

Guides for using methods with SWML.

Overview of SWML methods.

Guides for using SWML.

A prompt for AI that reinforces the AI agent's behavior and guardrails throughout the conversation.

A URL for the hold music to play, accepting WAV, Mp3, and FreeSWITCH tone_stream.

A prompt for AI that can be passed for when the AI agent is interrupted by the user.

Enable secure payment processing during voice calls.

Pass custom parameters to your payment processor.

The payment_connector_url is the URL to make payment requests to upon completion of all required payment details.

Play file(s), ringtones, speech or silence.

Play a prompt and wait for input.

An object that defines the context steps for the AI. The contexts are used to define the flow of the conversation.

The prompt object model (POM) is a structured data format for organizing, and rendering prompt instructions for AI agents.

Customize the audio prompts played during different stages of the payment process.

Customize the audio prompts played during different stages of the payment process.

Receive a fax being delivered to this call.

Record the call audio in the foreground pausing further SWML execution until recording ends.

Record call in the background.

Send a HTTP request to a remote URL.

Learn how to use the request method in SWML to send HTTP requests to a web server.

Return from a `execute` method or exit script.

Send digit presses as DTMF tones.

Send a fax.

Send an outbound message to a PSTN phone number.

Set script variables to the specified values.

Send a SIP REFER to a SIP call.

Set the amount of time for the current application to sleep for in milliseconds before continuing to the next action.

Stop noise reduction.

Stop an active background recording.

Stop an active tap stream.

Remote function signatures to include in SWAIG functions.

The default settings for all SWAIG functions.

Guides for using SWAIG.functions with SignalWire.

Functions that can be executed during the interaction with the AI.

The list of prebuilt functions that the AI agent is able to call.

Execute different instructions based on a variable's value.

Guides for using AI with SWML.

Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI.

Transfer the execution of the script to a different `SWML section`, `URL`, or `Relay application`.

Learn how to use `data_map` in SWML SWAIG functions to process, transform, and utilize incoming data effectively.

Unset specified variables.

Learn how to use `set_meta_data` to store metadata to reference later.

Learn how to use `context_switch` to shift the focus of the conversation.

Learn how to use `toggle_functions` to toggle functions on and off.

Iterates over an array of objects and processes an output based on each element in the array.