Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ARI API reference

The public Rust API is documented in asterisk_rs_ari. Rustdoc is the canonical inventory of resources, handles, events, transports, media types, and server APIs.

Find the right API

  • AriClient combines REST or unified WebSocket requests with the event stream.
  • resources groups operations by Asterisk resource. Handles bind an ID to a client for follow-up operations.
  • pending contains subscribe-before-create flows for channels, bridges, and playbacks.
  • AriEvent contains modeled Stasis events plus forward-compatible unknown-event retention.
  • media owns chan_websocket control and audio exchange.
  • server owns Asterisk 22 outbound WebSocket sessions.

Use resources for the handle pattern and Stasis applications for event delivery. Exact operations and signatures belong only in rustdoc so source-module splits cannot silently stale this guide.