renderSwml | SignalWire

Render the current SWML document as a plain object. Delegates to the underlying SwmlBuilder’s getDocument() method.

Parameters

None.

Returns

Record<string, unknown> — The SWML document with version and sections.

Example

1 import { SWMLService } from '@signalwire/sdk';
2 
3 const service = new SWMLService({ name: 'my-ivr' });
4 service.addVerb('answer', {});
5 service.addVerb('play', { url: 'https://example.com/greeting.mp3' });
6 service.addVerb('hangup', {});
7 
8 const doc = service.renderSwml();
9 console.log(JSON.stringify(doc, null, 2));
10 // {
11 //   "version": "1.0.0",
12 //   "sections": {
13 //     "main": [
14 //       { "answer": {} },
15 //       { "play": { "url": "https://example.com/greeting.mp3" } },
16 //       { "hangup": {} }
17 //     ]
18 //   }
19 // }