1 stable release

1.0.0	Jul 9, 2021

#8 in #twilio

MIT license

26KB
671 lines

twilio-agnostic

twilio-agnostic as a twilio-rs fork that uses isahc to be async runtime agnostic. It is a Rust library for integrating with Twilio that tries to present an idiomatic Rust interface for making requests to the Twilio API, and validating, parsing, and replying to webhooks that Twilio makes to your server.

First, you'll need to create a Twilio client:

let client = twilio::Client::new(ACCOUNT_ID, AUTH_TOKEN);

Now, you can use that client to make or receive Twilio requests. For example, to send a message:

client.send_message(OutboundMessage::new(from, to, "Hello, World!")).await;

Or to make a call:

client.make_call(OutboundCall::new(from, to, callback_url)).await;

Of course, much of our interaction with Twilio is by defining resources that respond to Twilio webhooks. To respond to every SMS with a customized reply, in your server's handler method:

use hyper::{Body, Request, Response, Error};

async fn handle_request(req: Request<Body>) -> Result<Response<Body>, Error> {
    let client = ...;

	// Convert hyper body to bytes
    let (parts, body) = req.into_parts();
    let body_bytes = hyper::body::to_bytes(body).await?;
    let req = Request::from_parts(parts, body_bytes.as_ref());

    let response = client.respond_to_webhook(req, |msg: Message| {
        let mut t = Twiml::new();
        t.add(&twiml::Message {
            txt: format!("You told me: '{}'",
            msg.body.unwrap()),
        });
        t
    })
    .await;

	// Convert string body back to hyper
    Ok(response.map(|b| b.into()))
}

Alternatively, to respond to a voice callback with a message:

use hyper::{Body, Request, Response, Error};

async fn handle_request(req: Request<Body>) -> Result<Response<Body>, Error> {
    let client = ...;

	// Convert hyper body to bytes
    let (parts, body) = req.into_parts();
    let body_bytes = hyper::body::to_bytes(body).await?;
    let req = Request::from_parts(parts, body_bytes.as_ref());

    let response = client.respond_to_webhook(req, |msg: Call| {
        let mut t = Twiml::new();
        t.add(&twitml::Say {
            txt: "Thanks for using twilio-rs. Bye!".to_string(),
            voice: Voice::Woman,
            language: "en".to_string(),
        });
        t
    })
    .await;

	// Convert string body back to hyper
    Ok(response.map(|b| b.into()))
}

Using the respond_to_webhook method will first authenticate that the request came from Twilio, using your AuthToken. If that fails, an error will be sent to the client. Next, the call or message will be parsed from the parameters passed in. If a required field is missing, an error will be sent to the client. Finally, the parsed object will be passed to your handler method, which must return a Twiml that will be used to respond to the webhook.

Dependencies

~15–25MB
~383K SLoC