Class VerbBuilder

Base class for building jambonz verb arrays. Extended by WebhookResponse and WsSession. Provides typed verb methods and optional runtime schema validation.

Hierarchy (View Summary)

VerbBuilder
- WebhookResponse

Index

Constructors

Properties

verbs validator

Accessors

Constructors

constructor

new VerbBuilder(opts?: VerbBuilderOptions): VerbBuilder
Parameters
- Optionalopts: VerbBuilderOptions
  Options for validation and schema directory.
Returns VerbBuilder
- Defined in src/verb-builder.ts:58

Properties

`Protected`verbs

verbs: Verb[] = []

`Protected`validator

validator: JambonzValidator | null

Accessors

length

get length(): number
Get the current verb count.

Returns number
- Defined in src/verb-builder.ts:274

Methods

say

say(opts: Omit<SayVerb, "verb">): this
Speak text using TTS. Supports SSML, multiple voices, and streaming.
Parameters
- opts: Omit<SayVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:69

play

play(opts: Omit<PlayVerb, "verb">): this
Play an audio file from a URL.
Parameters
- opts: Omit<PlayVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:74

gather

gather(opts: Omit<GatherVerb, "verb">): this
Collect speech (STT) and/or DTMF input from the caller.
Parameters
- opts: Omit<GatherVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:79

llm

llm(opts: Omit<LlmVerb, "verb">): this
Connect the caller to an LLM for real-time voice conversation.
Parameters
- opts: Omit<LlmVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:86

s2s

s2s(opts: Omit<S2sVerb, "verb">): this
Synonym for llm. Requires vendor to be specified.
Parameters
- opts: Omit<S2sVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:91

openai_s2s

openai_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='openai'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
- Defined in src/verb-builder.ts:96

google_s2s

google_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='google'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
- Defined in src/verb-builder.ts:101

elevenlabs_s2s

elevenlabs_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='elevenlabs'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
- Defined in src/verb-builder.ts:106

deepgram_s2s

deepgram_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='deepgram'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
- Defined in src/verb-builder.ts:111

ultravox_s2s

ultravox_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='ultravox'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
- Defined in src/verb-builder.ts:116

dialogflow

dialogflow(opts: Omit<DialogflowVerb, "verb">): this
Connect the caller to a Google Dialogflow agent (ES, CX, or CES).
Parameters
- opts: Omit<DialogflowVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:121

agent

agent(opts: Omit<AgentVerb, "verb">): this
Voice AI agent with integrated turn detection.
Parameters
- opts: Omit<AgentVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:126

listen

listen(opts: Omit<ListenVerb, "verb">): this
Stream real-time call audio to a WebSocket endpoint. Supports bidirectional audio.
Parameters
- opts: Omit<ListenVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:131

stream

stream(opts: Omit<StreamVerb, "verb">): this
Stream real-time call audio to a WebSocket endpoint. Synonym for listen.
Parameters
- opts: Omit<StreamVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:136

transcribe

transcribe(opts: Omit<TranscribeVerb, "verb">): this
Real-time call transcription sent to a webhook.
Parameters
- opts: Omit<TranscribeVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:141

dial

dial(opts: Omit<DialVerb, "verb">): this
Place an outbound call and bridge it to the current caller.
Parameters
- opts: Omit<DialVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:148

conference

conference(opts: Omit<ConferenceVerb, "verb">): this
Join or create a multi-party conference room.
Parameters
- opts: Omit<ConferenceVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:153

enqueue

enqueue(opts: Omit<EnqueueVerb, "verb">): this
Place the caller into a named queue.
Parameters
- opts: Omit<EnqueueVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:158

dequeue

dequeue(opts: Omit<DequeueVerb, "verb">): this
Remove a caller from a queue and bridge them.
Parameters
- opts: Omit<DequeueVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:163

hangup

hangup(opts?: Omit<HangupVerb, "verb">): this
End the call.
Parameters
- Optionalopts: Omit<HangupVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:168

redirect

redirect(opts: Omit<RedirectVerb, "verb">): this
Transfer control to a different webhook URL.
Parameters
- opts: Omit<RedirectVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:173

pause

pause(opts: Omit<PauseVerb, "verb">): this
Wait for a specified duration before continuing.
Parameters
- opts: Omit<PauseVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:178

leave

leave(opts?: Omit<LeaveVerb, "verb">): this
Leave a conference or queue.
Parameters
- Optionalopts: Omit<LeaveVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:183

sipDecline

sipDecline(opts: Omit<SipDeclineVerb, "verb">): this
Reject an incoming call with a SIP error response.
Parameters
- opts: Omit<SipDeclineVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:190

sipRequest

sipRequest(opts: Omit<SipRequestVerb, "verb">): this
Send a SIP INFO or other request within the dialog.
Parameters
- opts: Omit<SipRequestVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:195

sipRefer

sipRefer(opts: Omit<SipReferVerb, "verb">): this
Transfer the call via SIP REFER.
Parameters
- opts: Omit<SipReferVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:200

config

config(opts: Omit<ConfigVerb, "verb">): this
Set session-level defaults (TTS vendor/voice, STT vendor, VAD, etc.).
Parameters
- opts: Omit<ConfigVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:207

answer

answer(opts?: Omit<AnswerVerb, "verb">): this
Explicitly answer the call (sends a 200 OK).
Parameters
- Optionalopts: Omit<AnswerVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:212

alert

alert(opts: Omit<AlertVerb, "verb">): this
Send a SIP 180 Ringing with optional Alert-Info header.
Parameters
- opts: Omit<AlertVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:217

tag

tag(opts: Omit<TagVerb, "verb">): this
Attach metadata to the call for tracking or routing.
Parameters
- opts: Omit<TagVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:222

dtmf

dtmf(opts: Omit<DtmfVerb, "verb">): this
Send DTMF tones into the call.
Parameters
- opts: Omit<DtmfVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:227

dub

dub(opts: Omit<DubVerb, "verb">): this
Mix an auxiliary audio track into the call.
Parameters
- opts: Omit<DubVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:232

message

message(opts: Omit<MessageVerb, "verb">): this
Send an SMS or MMS message.
Parameters
- opts: Omit<MessageVerb, "verb">
Returns this
- Defined in src/verb-builder.ts:237

addVerbs

addVerbs(verbs: Verb[]): this
Add one or more verbs from raw JSON. Validates against the JSON schemas at runtime if validation is enabled.
Parameters
- verbs: Verb[]
Returns this
- Defined in src/verb-builder.ts:247

`Protected`addVerb

addVerb(verb: Verb): this
Parameters
- verb: Verb
Returns this
- Defined in src/verb-builder.ts:261

clear

clear(): this
Clear all queued verbs.

Returns this
- Defined in src/verb-builder.ts:279

toJSON

toJSON(): Verb[]
Returns a copy of the current verb array.

Returns Verb[]
- Defined in src/verb-builder.ts:285