renderSwml | SignalWire

Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. This is called automatically by the Hono route handler on each incoming request, but can also be called manually for testing or debugging.

Parameters

callId

string

Optional call ID to use for session tokens. Auto-generated if omitted.

modifications

Record<string, unknown>

Optional object (typically returned from onSwmlRequest()) merged into the AI verb config before rendering. global_data is deep-merged; all other keys override AI config fields directly.

Returns

string — The rendered SWML document as a JSON string.

Example

1 import { AgentBase } from '@signalwire/sdk';
2 
3 const agent = new AgentBase({ name: 'support', route: '/support' });
4 agent.setPromptText('You are a helpful assistant.');
5 agent.addHints(['SignalWire', 'SWML']);
6 
7 const swml = agent.renderSwml();
8 console.log(JSON.parse(swml));