asterisk-rs

Async Rust clients for Asterisk AMI, AGI, and ARI.

Overview

asterisk-rs is a Rust workspace providing typed, async clients for the three Asterisk integration interfaces. Each protocol lives in its own crate with shared types and error handling in asterisk-rs-core.

Crates

Quick Start

cargo add asterisk-rs

use asterisk_rs::ami::AmiClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = AmiClient::builder()
        .host("127.0.0.1")
        .port(5038)
        .credentials("admin", "secret")
        .build()
        .await?;

    let response = client.ping().await?;
    println!("{response:?}");

    client.disconnect().await?;
    Ok(())
}

Features

• Async/await with tokio
• Typed actions, commands, and events for all three protocols
• Automatic reconnection with exponential backoff and jitter
• MD5 challenge-response authentication (AMI)
• Handle pattern for ARI resources (ChannelHandle, BridgeHandle, etc.)
• Event bus with typed pub/sub
• Structured logging via tracing
• Feature flags for granular dependency control

Protocols

MSRV

1.75

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributing

See CONTRIBUTING.md for guidelines.