#hyper #twilio #async #api-bindings #api-wrapper #api #twiml

twilio-async

An async and ergonomic wrapper around Twilio API & TwiML

7 releases (4 breaking)

0.5.0 Sep 16, 2021
0.4.1 Mar 22, 2020
0.3.0 Mar 22, 2020
0.2.0 Feb 2, 2019
0.1.1-beta Jun 30, 2018

#1764 in Web programming

Download history 922/week @ 2024-07-21 851/week @ 2024-07-28 614/week @ 2024-08-04 899/week @ 2024-08-11 625/week @ 2024-08-18 665/week @ 2024-08-25 919/week @ 2024-09-01 1294/week @ 2024-09-08 638/week @ 2024-09-15 771/week @ 2024-09-22 1162/week @ 2024-09-29 959/week @ 2024-10-06 999/week @ 2024-10-13 947/week @ 2024-10-20 1020/week @ 2024-10-27 890/week @ 2024-11-03

3,858 downloads per month

MIT license

55KB
1.5K SLoC

twilio-async

Example Usage

An async and ergonomic wrapper around Twilio API & TwiML.

All types can run run() or a similar function. They return a value that implements Deserialize.

The examples/ dir has up to date working example code.

Messages:


#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let twilio = Twilio::new(account_sid, token)?;
    // sending a message
    twilio.send_msg("from", "to", "Hello World").run().await?;
    // sending a body-less message with media
    twilio
        .send_msg("from", "to", "body")
        .media("http://i0.kym-cdn.com/photos/images/newsfeed/000/377/946/0b9.jpg")
        .run().await?;
    // get details about a message
    twilio.msg("messagesid").run().await?;
    // redact a message
    twilio.msg("messagesid").redact().await?;
    // get a msg media url
    twilio.msg("messagesid").media().await?;
    // delete a msg
    twilio.msg("messagesid").delete().await?;
    // get all messages
    twilio.msgs().run().await?;
    // get all messages between some time
    twilio.msgs().between("start date", "end date").run().await?;
    // get all messages on a specific date
    twilio.msgs().on("date").run().await?;
}

Calls:

let twilio = Twilio::new(env::var("TWILIO_SID")?, env::var("TWILIO_TOKEN")?)?;
let (status, resp) = twilio
    .call("from", "to", "http://demo.twilio.com/docs/voice.xml")
    .run().await?;

Twiml:

use twilio_async::twiml::Response;

let resp = Response::new()
    .say("Hello World") // builder pattern also supports say(Say::new("Hello World").lang("de")...)
    .play("https://api.twilio.com/Cowbell.mp3")
    .build();
let s = "<Response><Say voice=\"man\" language=\"en\" loop=\"1\">Hello World</Say><Play loop=\"1\">https://api.twilio.com/Cowbell.mp3</Play></Response>";
assert_eq!(resp.unwrap(), s.to_string());

Contributing

There is untested code for conferences/recordings.

The TwiML work is complete and has some test coverage.

PRs and suggestions are welcome.

Dependencies

~9–20MB
~290K SLoC