addVerb | SignalWire

Append a verb to the main section of the SWML document. Validates the verb config against the bundled schema when validation is enabled.

Parameters

verbName

stringRequired

The SWML verb name (e.g., "answer", "ai", "play", "hangup").

config

unknownRequired

The verb’s configuration payload. Most verbs accept an object of parameters. The sleep verb accepts a number (duration in milliseconds).

Returns

void — Throws an Error if the verb fails schema validation (when validation is enabled and the verb is defined in the schema).

Example

1 import { SwmlBuilder } from '@signalwire/sdk';
2 
3 const builder = new SwmlBuilder();
4 builder.addVerb('answer', {});
5 builder.addVerb('play', { url: 'https://example.com/greeting.mp3' });
6 builder.addVerb('hangup', {});
7 
8 console.log(builder.renderDocument());