API reference

The complete scenario vocabulary, generated from the engine (so it never drifts from the code) — organized by the thing you’re working with:

• Scenario structure — defining and isolating tests: scenario, setup, teardown, skip.
• Flow and timing — await_until, wait, parallel, default_timeout.
• Agents — create SIP endpoints and drive calls: register, dial, accept, transfer, DTMF, audio.
  • Peer — the remote party of the active call.
  • Call state — the State::* phases for agent.state.
  • AudioSpec — audio sources for send_audio (tone, file, silent).
• CallQuality
• Assertions and matchers — the fluent assert(x).<matcher>(…), used inside await_until.
• HTTP — http(…) requests and the response.
• HTTP mock server — mock_server(…), routes and responders for webhook-driven flows.
  • Mock request — the recorded request a responder/assertion sees.
• Environment — env, load_env — credentials stay out of scripts.
• Utilities — log, uuid.

New to it? Start with Your first scenario, then Writing scenarios.

For editors and agents, the whole API is also available as Rhai type definitions (.d.rhai) — point the Rhai language server at it for completion and hover.