An open API service indexing awesome lists of open source software.

https://github.com/leshow/twilio-async

Async Hyper wrapper for Twilio API
https://github.com/leshow/twilio-async

Last synced: about 1 year ago
JSON representation

Async Hyper wrapper for Twilio API

Awesome Lists containing this project

README

          

# 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:

```rust

#[tokio::main]
async fn main() -> Result<(), Box> {
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:

```rust
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:

```rust
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 = "Hello Worldhttps://api.twilio.com/Cowbell.mp3";
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.